Package com.hybris.backoffice.excel.validators

Class ExcelMediaImportValidator

java.lang.Object

com.hybris.backoffice.excel.validators.ExcelMediaImportValidator

All Implemented Interfaces:

ExcelSingleMediaValidator, ExcelValidator

Direct Known Subclasses:

ExcelMediaCollectionImportValidator, ExcelMediaFilenameExtensionValidator

public class ExcelMediaImportValidator
extends java.lang.Object
implements ExcelSingleMediaValidator

Validator which checks if media import data is correct. Checks:

• if at least one AbstractExcelMediaImportTranslator.PARAM_FILE_PATH or AbstractExcelMediaImportTranslator.PARAM_CODE is defined
• if given AbstractExcelMediaImportTranslator.PARAM_FILE_PATH exists in uploaded content
• if there is only one reference defined

Field Summary

Fields

Modifier and Type	Field	Description
protected TypeService	typeService
static java.lang.String	VALIDATION_DECLARED_MULTIPLE_REFERENCES
static java.lang.String	VALIDATION_MISSING_FILE_IN_ZIP
static java.lang.String	VALIDATION_MISSING_ZIP
static java.lang.String	VALIDATION_PATH_AND_CODE_EMPTY

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

CTX_MEDIA_CONTENT_ENTRIES

Constructor Summary

Constructors

Constructor	Description
ExcelMediaImportValidator()

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.
ExcelImportService	getImportService()	Deprecated, for removal: This API element is subject to removal in a future version. since 1808, not used anymore
TypeService	getTypeService()
protected boolean	hasImportData(ImportParameters importParameters)
void	setImportService(ExcelImportService importService)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808, not used anymore
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.
java.util.List<ValidationMessage>	validateSingleValue(java.util.Map<java.lang.String,java.lang.Object> context, java.util.Map<java.lang.String,java.lang.String> parameters)	Allows to validate single media.

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATION_DECLARED_MULTIPLE_REFERENCES

public static final java.lang.String VALIDATION_DECLARED_MULTIPLE_REFERENCES

See Also:

Constant Field Values

VALIDATION_PATH_AND_CODE_EMPTY

public static final java.lang.String VALIDATION_PATH_AND_CODE_EMPTY

See Also:

Constant Field Values

VALIDATION_MISSING_FILE_IN_ZIP

public static final java.lang.String VALIDATION_MISSING_FILE_IN_ZIP

See Also:

Constant Field Values

VALIDATION_MISSING_ZIP

public static final java.lang.String VALIDATION_MISSING_ZIP

See Also:

Constant Field Values

typeService

protected TypeService typeService

Constructor Detail

ExcelMediaImportValidator

public ExcelMediaImportValidator()

Method Detail

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.

hasImportData

protected boolean hasImportData(ImportParameters importParameters)

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

validateSingleValue

public java.util.List<ValidationMessage> validateSingleValue(java.util.Map<java.lang.String,java.lang.Object> context,
                                                             java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: ExcelSingleMediaValidator

Allows to validate single media.

Specified by:

validateSingleValue in interface ExcelSingleMediaValidator

Parameters:

context - which allows to hold information about the file.

parameters - values of excel's cell.

Returns:

the collection of errors. If media has no errors, then the empty collection should be returned.

getTypeService

public TypeService getTypeService()

setTypeService

public void setTypeService(TypeService typeService)

getImportService

@Deprecated(since="1808",
            forRemoval=true)
public ExcelImportService getImportService()

Deprecated, for removal: This API element is subject to removal in a future version.

since 1808, not used anymore

setImportService

@Deprecated(since="1808",
            forRemoval=true)
public void setImportService(ExcelImportService importService)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1808, not used anymore