Package com.hybris.backoffice.excel.validators

Class ExcelCatalogVersionValidator

java.lang.Object

com.hybris.backoffice.excel.validators.ExcelCatalogVersionValidator

All Implemented Interfaces:

ExcelValidator

Direct Known Subclasses:

ExcelMediaCatalogVersionValidator

public class ExcelCatalogVersionValidator
extends java.lang.Object
implements ExcelValidator

Default excel validator for catalog version. The validator checks whether import parameters has "catalog" and "version" key. Based on that, the validator checks whether catalog and version are not empty and exist.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	CATALOG_VERSIONS_FORMAT_KEY
protected static java.lang.String	CATALOG_VERSIONS_KEY
protected static java.lang.String	CATALOGS_KEY
protected static java.lang.String	VALIDATION_CATALOG_DOESNT_EXIST
protected static java.lang.String	VALIDATION_CATALOG_EMPTY
protected static java.lang.String	VALIDATION_CATALOG_VERSION_DOESNT_EXIST
protected static java.lang.String	VALIDATION_CATALOG_VERSION_DOESNT_MATCH
protected static java.lang.String	VALIDATION_CATALOG_VERSION_EMPTY
protected static java.lang.String	VERSIONS_KEY

Fields inherited from interface com.hybris.backoffice.excel.validators.ExcelValidator

CTX_MEDIA_CONTENT_ENTRIES

Constructor Summary

Constructors

Constructor	Description
ExcelCatalogVersionValidator()

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(ImportParameters importParameters, AttributeDescriptorModel attributeDescriptor)	Indicates whether given validator can handle a cell based on attribute descriptor and import parameters.
protected boolean	catalogExists(java.util.Map<java.lang.String,java.lang.Object> ctx, java.util.Map<java.lang.String,java.lang.String> parameters)
protected boolean	catalogVersionExists(java.util.Map<java.lang.String,java.lang.Object> ctx, java.util.Map<java.lang.String,java.lang.String> parameters)
protected boolean	catalogVersionMatch(java.util.Map<java.lang.String,java.lang.Object> ctx, java.util.Map<java.lang.String,java.lang.String> parameters)
CatalogVersionService	getCatalogVersionService()
TypeService	getTypeService()
UserService	getUserService()
protected void	populateContext(java.util.Map<java.lang.String,java.lang.Object> ctx)
protected void	populateContextIfNeeded(java.util.Map<java.lang.String,java.lang.Object> ctx)
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setTypeService(TypeService typeService)
void	setUserService(UserService userService)
ExcelValidationResult	validate(ImportParameters importParameters, AttributeDescriptorModel attributeDescriptor, java.util.Map<java.lang.String,java.lang.Object> ctx)	Validates given cell and returns validation result.
protected void	validateCatalog(java.util.Map<java.lang.String,java.lang.Object> ctx, java.util.List<ValidationMessage> validationMessages, java.util.Map<java.lang.String,java.lang.String> parameters)
protected void	validateCatalogVersion(java.util.Map<java.lang.String,java.lang.Object> ctx, java.util.List<ValidationMessage> validationMessages, java.util.Map<java.lang.String,java.lang.String> parameters)
protected void	validateSingleReference(java.util.Map<java.lang.String,java.lang.Object> ctx, java.util.List<ValidationMessage> validationMessages, java.util.Map<java.lang.String,java.lang.String> parameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CATALOGS_KEY

protected static final java.lang.String CATALOGS_KEY

See Also:

Constant Field Values

VERSIONS_KEY

protected static final java.lang.String VERSIONS_KEY

See Also:

Constant Field Values

CATALOG_VERSIONS_KEY

protected static final java.lang.String CATALOG_VERSIONS_KEY

See Also:

Constant Field Values

CATALOG_VERSIONS_FORMAT_KEY

protected static final java.lang.String CATALOG_VERSIONS_FORMAT_KEY

See Also:

Constant Field Values

VALIDATION_CATALOG_EMPTY

protected static final java.lang.String VALIDATION_CATALOG_EMPTY

See Also:

Constant Field Values

VALIDATION_CATALOG_VERSION_EMPTY

protected static final java.lang.String VALIDATION_CATALOG_VERSION_EMPTY

See Also:

Constant Field Values

VALIDATION_CATALOG_DOESNT_EXIST

protected static final java.lang.String VALIDATION_CATALOG_DOESNT_EXIST

See Also:

Constant Field Values

VALIDATION_CATALOG_VERSION_DOESNT_EXIST

protected static final java.lang.String VALIDATION_CATALOG_VERSION_DOESNT_EXIST

See Also:

Constant Field Values

VALIDATION_CATALOG_VERSION_DOESNT_MATCH

protected static final java.lang.String VALIDATION_CATALOG_VERSION_DOESNT_MATCH

See Also:

Constant Field Values

Constructor Detail

ExcelCatalogVersionValidator

public ExcelCatalogVersionValidator()

Method Detail

validate

public ExcelValidationResult validate(ImportParameters importParameters,
                                      AttributeDescriptorModel attributeDescriptor,
                                      java.util.Map<java.lang.String,java.lang.Object> ctx)

Description copied from interface: ExcelValidator

Validates given cell and returns validation result. If cell doesn't have validation issues then ExcelValidationResult.SUCCESS should be returned.

Specified by:

validate in interface ExcelValidator

ctx - - map which can be used as a cache. The map is shared between all request for given excel sheet.

Returns:

ExcelValidationResult

populateContextIfNeeded

protected void populateContextIfNeeded(java.util.Map<java.lang.String,java.lang.Object> ctx)

validateSingleReference

protected void validateSingleReference(java.util.Map<java.lang.String,java.lang.Object> ctx,
                                       java.util.List<ValidationMessage> validationMessages,
                                       java.util.Map<java.lang.String,java.lang.String> parameters)

validateCatalogVersion

protected void validateCatalogVersion(java.util.Map<java.lang.String,java.lang.Object> ctx,
                                      java.util.List<ValidationMessage> validationMessages,
                                      java.util.Map<java.lang.String,java.lang.String> parameters)

validateCatalog

protected void validateCatalog(java.util.Map<java.lang.String,java.lang.Object> ctx,
                               java.util.List<ValidationMessage> validationMessages,
                               java.util.Map<java.lang.String,java.lang.String> parameters)

catalogExists

protected boolean catalogExists(java.util.Map<java.lang.String,java.lang.Object> ctx,
                                java.util.Map<java.lang.String,java.lang.String> parameters)

catalogVersionExists

protected boolean catalogVersionExists(java.util.Map<java.lang.String,java.lang.Object> ctx,
                                       java.util.Map<java.lang.String,java.lang.String> parameters)

catalogVersionMatch

protected boolean catalogVersionMatch(java.util.Map<java.lang.String,java.lang.Object> ctx,
                                      java.util.Map<java.lang.String,java.lang.String> parameters)

populateContext

protected void populateContext(java.util.Map<java.lang.String,java.lang.Object> ctx)

canHandle

public boolean canHandle(ImportParameters importParameters,
                         AttributeDescriptorModel attributeDescriptor)

Description copied from interface: ExcelValidator

Indicates whether given validator can handle a cell based on attribute descriptor and import parameters.

Specified by:

canHandle in interface ExcelValidator

Returns:

boolean whether validator can handle the cell.

getCatalogVersionService

public CatalogVersionService getCatalogVersionService()

setCatalogVersionService

public void setCatalogVersionService(CatalogVersionService catalogVersionService)

getUserService

public UserService getUserService()

setUserService

public void setUserService(UserService userService)

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)