Package com.hybris.backoffice.excel.validators

Class ExcelGenericReferenceValidator

java.lang.Object

com.hybris.backoffice.excel.validators.ExcelGenericReferenceValidator

All Implemented Interfaces:

ExcelValidator

Direct Known Subclasses:

CatalogVersionPermissionValidator

public class ExcelGenericReferenceValidator
extends java.lang.Object
implements ExcelValidator

Validator for ExcelGenericReferenceTranslator The validator tries to load all references and checks whether the references exist

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	VALIDATION_MESSAGE_KEY

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

CTX_MEDIA_CONTENT_ENTRIES

Constructor Summary

Constructors

Constructor	Description
ExcelGenericReferenceValidator()

Method Summary

Modifier and Type	Method	Description
protected java.util.Optional<FlexibleSearchQuery>	buildFlexibleSearchQuery(RequiredAttribute rootUniqueAttribute, java.util.Map<java.lang.String,java.lang.String> importParameters, java.util.Map context)
boolean	canHandle(ImportParameters importParameters, AttributeDescriptorModel attributeDescriptor)	Validator can handle request only if call value is not empty
FlexibleSearchService	getFlexibleSearchService()
RequiredAttributesFactory	getRequiredAttributesFactory()
protected TypeService	getTypeService()
protected boolean	isBlacklisted(AttributeDescriptorModel attribute)
protected ValidationMessage	prepareValidationMessage(RequiredAttribute rootUniqueAttribute, java.util.Map<java.lang.String,java.lang.String> importParameters)
protected java.util.List<ValidationMessage>	recursivelyValidateAllLevels(RequiredAttribute rootUniqueAttribute, ImportParameters importParameters, java.util.Map<java.lang.String,java.lang.Object> context)	Recursively checks whether reference exist.
void	setBlacklistedTypes(java.util.Collection<java.lang.String> blacklistedTypes)
void	setExcelWorkbookEntriesService(ExcelWorkbookEntriesService excelWorkbookEntriesService)
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setRequiredAttributesFactory(RequiredAttributesFactory requiredAttributesFactory)
void	setTypeService(TypeService typeService)
ExcelValidationResult	validate(ImportParameters importParameters, AttributeDescriptorModel attributeDescriptor, java.util.Map<java.lang.String,java.lang.Object> context)	Validates given cell and returns validation result.
ExcelValidationResult	validateRequiredAttribute(RequiredAttribute requiredAttribute, ImportParameters importParameters, java.util.Map<java.lang.String,java.lang.Object> context)	Validates given cell and returns validation result.
protected java.util.List<ValidationMessage>	validateSingleLevel(RequiredAttribute rootUniqueAttribute, ImportParameters importParameters, java.util.Map<java.lang.String,java.lang.Object> context)	Validates just single level without checking children.
protected java.util.Optional<ValidationMessage>	validateSingleValue(RequiredAttribute rootUniqueAttribute, java.util.Map<java.lang.String,java.lang.String> importParameters, java.util.Map<java.lang.String,java.lang.Object> context)	This method validates just single value from single level.

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATION_MESSAGE_KEY

protected static final java.lang.String VALIDATION_MESSAGE_KEY

See Also:

Constant Field Values

Constructor Detail

ExcelGenericReferenceValidator

public ExcelGenericReferenceValidator()

Method Detail

canHandle

public boolean canHandle(ImportParameters importParameters,
                         AttributeDescriptorModel attributeDescriptor)

Validator can handle request only if call value is not empty

Specified by:

canHandle in interface ExcelValidator

Parameters:

importParameters -

attributeDescriptor -

Returns:

boolean whether validator can handle the cell.

isBlacklisted

protected boolean isBlacklisted(AttributeDescriptorModel attribute)

validate

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

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

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

Returns:

ExcelValidationResult

validateRequiredAttribute

public ExcelValidationResult validateRequiredAttribute(RequiredAttribute requiredAttribute,
                                                       ImportParameters importParameters,
                                                       java.util.Map<java.lang.String,java.lang.Object> context)

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

Parameters:

requiredAttribute - hierarchical structure of required attributes

importParameters - parsed parameters for given cell

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

Returns:

ExcelValidationResult

recursivelyValidateAllLevels

protected java.util.List<ValidationMessage> recursivelyValidateAllLevels(RequiredAttribute rootUniqueAttribute,
                                                                         ImportParameters importParameters,
                                                                         java.util.Map<java.lang.String,java.lang.Object> context)

Recursively checks whether reference exist. The method starts checking references from the lowest descendant. If reference from lower level doesn't exist then process is stopped. For example, if given Catalog.id doesn't exist then reference for catalog version is not checked.

Parameters:

rootUniqueAttribute -

importParameters -

context -

Returns:

validateSingleLevel

protected java.util.List<ValidationMessage> validateSingleLevel(RequiredAttribute rootUniqueAttribute,
                                                                ImportParameters importParameters,
                                                                java.util.Map<java.lang.String,java.lang.Object> context)

Validates just single level without checking children. This method is taking into account multi-values.

Parameters:

rootUniqueAttribute -

importParameters -

context -

Returns:

validateSingleValue

protected java.util.Optional<ValidationMessage> validateSingleValue(RequiredAttribute rootUniqueAttribute,
                                                                    java.util.Map<java.lang.String,java.lang.String> importParameters,
                                                                    java.util.Map<java.lang.String,java.lang.Object> context)

This method validates just single value from single level. For example, it checks whether given catalog version exist. To check catalog version, the method assumes that all children's references are checked and stored in context.

Parameters:

rootUniqueAttribute -

importParameters -

context -

Returns:

prepareValidationMessage

protected ValidationMessage prepareValidationMessage(RequiredAttribute rootUniqueAttribute,
                                                     java.util.Map<java.lang.String,java.lang.String> importParameters)

buildFlexibleSearchQuery

protected java.util.Optional<FlexibleSearchQuery> buildFlexibleSearchQuery(RequiredAttribute rootUniqueAttribute,
                                                                           java.util.Map<java.lang.String,java.lang.String> importParameters,
                                                                           java.util.Map context)

getRequiredAttributesFactory

public RequiredAttributesFactory getRequiredAttributesFactory()

setRequiredAttributesFactory

public void setRequiredAttributesFactory(RequiredAttributesFactory requiredAttributesFactory)

getFlexibleSearchService

public FlexibleSearchService getFlexibleSearchService()

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

setExcelWorkbookEntriesService

public void setExcelWorkbookEntriesService(ExcelWorkbookEntriesService excelWorkbookEntriesService)

setTypeService

public void setTypeService(TypeService typeService)

getTypeService

protected TypeService getTypeService()

setBlacklistedTypes

public void setBlacklistedTypes(java.util.Collection<java.lang.String> blacklistedTypes)