Package com.hybris.backoffice.excel.validators

Class WorkbookMandatoryColumnsValidator

java.lang.Object

com.hybris.backoffice.excel.validators.WorkbookMandatoryColumnsValidator

All Implemented Interfaces:

WorkbookValidator

public class WorkbookMandatoryColumnsValidator
extends java.lang.Object
implements WorkbookValidator

Default excel validator which checks whether all mandatory columns are selected for each excel sheet. If mandatory column is localized then column for current language is required.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	VALIDATION_MESSAGE_DESCRIPTION
static java.lang.String	VALIDATION_MESSAGE_HEADER

Constructor Summary

Constructors

Constructor	Description
WorkbookMandatoryColumnsValidator()

Method Summary

Modifier and Type	Method	Description
java.util.Set<AttributeDescriptorModel>	findAllMandatoryFields(java.lang.String typeCode)
protected java.lang.String	getAttributeDisplayedName(AttributeDescriptorModel attributeDescriptor)
CommonI18NService	getCommonI18NService()
DisplayNameAttributeNameFormatter	getDisplayNameAttributeNameFormatter()
ExcelSheetService	getExcelSheetService()
ExcelTemplateService	getExcelTemplateService()	Deprecated, for removal: This API element is subject to removal in a future version. since 1808.
ExcelWorkbookService	getExcelWorkbookService()
ExcelMapper<java.lang.String,AttributeDescriptorModel>	getMapper()
TypeService	getTypeService()	Deprecated, for removal: This API element is subject to removal in a future version. since 1808.
protected boolean	hasNotDefaultValue(AttributeDescriptorModel attributeDescriptorModel)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808.
protected ExcelAttributeDescriptorAttribute	prepareExcelAttribute(AttributeDescriptorModel attributeDescriptor, java.lang.String isoCode)
protected SelectedAttribute	prepareSelectedAttribute(AttributeDescriptorModel attributeDescriptor)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setDisplayNameAttributeNameFormatter(DisplayNameAttributeNameFormatter displayNameAttributeNameFormatter)
void	setExcelSheetService(ExcelSheetService excelSheetService)
void	setExcelTemplateService(ExcelTemplateService excelTemplateService)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808.
void	setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)
void	setMapper(ExcelMapper<java.lang.String,AttributeDescriptorModel> mapper)
void	setTypeService(TypeService typeService)	Deprecated, for removal: This API element is subject to removal in a future version. since 1808.
java.util.List<ExcelValidationResult>	validate(org.apache.poi.ss.usermodel.Workbook workbook)	Validates workbook.
protected java.util.Optional<ExcelValidationResult>	validateSheet(org.apache.poi.ss.usermodel.Sheet typeSystemSheet, org.apache.poi.ss.usermodel.Sheet sheet)

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATION_MESSAGE_HEADER

public static final java.lang.String VALIDATION_MESSAGE_HEADER

See Also:

Constant Field Values

VALIDATION_MESSAGE_DESCRIPTION

public static final java.lang.String VALIDATION_MESSAGE_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

WorkbookMandatoryColumnsValidator

public WorkbookMandatoryColumnsValidator()

Method Detail

validate

public java.util.List<ExcelValidationResult> validate(org.apache.poi.ss.usermodel.Workbook workbook)

Description copied from interface: WorkbookValidator

Validates workbook. If workbook doesn't have validation issues then empty list should be returned.

Specified by:

validate in interface WorkbookValidator

Returns:

list of validation results. If workbook doesn't have validation issues then empty list should be returned.

validateSheet

protected java.util.Optional<ExcelValidationResult> validateSheet(org.apache.poi.ss.usermodel.Sheet typeSystemSheet,
                                                                  org.apache.poi.ss.usermodel.Sheet sheet)

prepareExcelAttribute

protected ExcelAttributeDescriptorAttribute prepareExcelAttribute(AttributeDescriptorModel attributeDescriptor,
                                                                  java.lang.String isoCode)

prepareSelectedAttribute

protected SelectedAttribute prepareSelectedAttribute(AttributeDescriptorModel attributeDescriptor)

getAttributeDisplayedName

protected java.lang.String getAttributeDisplayedName(AttributeDescriptorModel attributeDescriptor)

findAllMandatoryFields

public java.util.Set<AttributeDescriptorModel> findAllMandatoryFields(java.lang.String typeCode)

hasNotDefaultValue

@Deprecated(since="1808",
            forRemoval=true)
protected boolean hasNotDefaultValue(AttributeDescriptorModel attributeDescriptorModel)

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

since 1808. Use DefaultValueCheckingFilter instead

getTypeService

@Deprecated(since="1808",
            forRemoval=true)
public TypeService getTypeService()

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

since 1808.

setTypeService

@Deprecated(since="1808",
            forRemoval=true)
public void setTypeService(TypeService typeService)

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

since 1808.

getCommonI18NService

public CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getExcelTemplateService

@Deprecated(since="1808",
            forRemoval=true)
public ExcelTemplateService getExcelTemplateService()

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

since 1808.

setExcelTemplateService

@Deprecated(since="1808",
            forRemoval=true)
public void setExcelTemplateService(ExcelTemplateService excelTemplateService)

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

since 1808.

getExcelWorkbookService

public ExcelWorkbookService getExcelWorkbookService()

setExcelWorkbookService

public void setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)

getExcelSheetService

public ExcelSheetService getExcelSheetService()

setExcelSheetService

public void setExcelSheetService(ExcelSheetService excelSheetService)

getDisplayNameAttributeNameFormatter

public DisplayNameAttributeNameFormatter getDisplayNameAttributeNameFormatter()

setDisplayNameAttributeNameFormatter

public void setDisplayNameAttributeNameFormatter(DisplayNameAttributeNameFormatter displayNameAttributeNameFormatter)

getMapper

public ExcelMapper<java.lang.String,AttributeDescriptorModel> getMapper()

setMapper

public void setMapper(ExcelMapper<java.lang.String,AttributeDescriptorModel> mapper)