Package com.hybris.backoffice.excel.validators

Class WorkbookTypeCodeAndSelectedAttributeValidator

java.lang.Object

com.hybris.backoffice.excel.validators.WorkbookTypeCodeAndSelectedAttributeValidator

All Implemented Interfaces:

WorkbookValidator

Direct Known Subclasses:

WorkbookTypeCodeAndAttributesValidator

public class WorkbookTypeCodeAndSelectedAttributeValidator
extends java.lang.Object
implements WorkbookValidator

Default excel validator for types and attributes. The validator checks whether given sheet name and selected column (selected attribute) exist and user has permission to them.
Note: Please use WorkbookTypeCodeAndAttributesValidator if you want support for classification system, as this validator does not support it.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_DESCRIPTION
static java.lang.String	EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_HEADER
static java.lang.String	EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_DESCRIPTION
static java.lang.String	EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_HEADER
static java.lang.String	EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_DESCRIPTION
static java.lang.String	EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_HEADER

Constructor Summary

Constructors

Constructor	Description
WorkbookTypeCodeAndSelectedAttributeValidator()

Method Summary

Modifier and Type	Method	Description
protected java.util.Optional<ExcelValidationResult>	createValidationResult(java.lang.String sheetName, java.util.List<java.lang.String> duplicateColumnNames)
protected java.util.Set<SelectedAttributeQualifier>	findDuplicatedColumns(java.util.List<SelectedAttributeQualifier> selectedColumns)
protected <T> java.util.Set<T>	findDuplicates(java.util.Collection<T> collection)
ExcelHeaderService	getExcelHeaderService()
ExcelSheetService	getExcelSheetService()
ExcelTemplateService	getExcelTemplateService()	Deprecated. since 1808.
ExcelWorkbookService	getExcelWorkbookService()
PermissionCRUDService	getPermissionCRUDService()
protected boolean	hasPermissionsToAttribute(java.lang.String typeCode, SelectedAttributeQualifier qualifier)
protected boolean	hasPermissionsToAttribute(java.lang.String typeCode, java.lang.String qualifier)
protected boolean	hasPermissionsToTypeCode(java.lang.String typeCode)
protected ExcelValidationResult	prepareValidationResultForUnknownType(java.lang.String sheetName)
void	setExcelHeaderService(ExcelHeaderService excelHeaderService)
void	setExcelSheetService(ExcelSheetService excelSheetService)
void	setExcelTemplateService(ExcelTemplateService excelTemplateService)	Deprecated. since 1808.
void	setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)
void	setPermissionCRUDService(PermissionCRUDService permissionCRUDService)
java.util.List<ExcelValidationResult>	validate(org.apache.poi.ss.usermodel.Workbook workbook)	Validates workbook.
protected java.util.Optional<ExcelValidationResult>	validateColumnUniqueness(java.lang.String sheetName, java.util.List<SelectedAttributeQualifier> selectedColumns)
protected java.util.List<ExcelValidationResult>	validateSelectedColumns(org.apache.poi.ss.usermodel.Sheet typeSystemSheet, org.apache.poi.ss.usermodel.Sheet sheet)
protected java.util.List<ExcelValidationResult>	validateSheet(org.apache.poi.ss.usermodel.Sheet typeSystemSheet, org.apache.poi.ss.usermodel.Sheet sheet)
protected java.util.Optional<ValidationMessage>	validateSingleAttribute(java.lang.String typeCode, java.lang.String columnName, java.lang.String qualifier)
protected java.util.Optional<ExcelValidationResult>	validateTypeCode(java.lang.String typeCode)
protected java.util.Optional<ExcelValidationResult>	validateWhetherColumnExistAndUserHasPermission(java.lang.String typeCode, java.util.List<SelectedAttributeQualifier> qualifiers)

Methods inherited from class java.lang.Object

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

Field Detail

EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_DESCRIPTION

public static final java.lang.String EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_DESCRIPTION

See Also:

Constant Field Values

EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_HEADER

public static final java.lang.String EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_HEADER

See Also:

Constant Field Values

EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_DESCRIPTION

public static final java.lang.String EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_DESCRIPTION

See Also:

Constant Field Values

EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_HEADER

public static final java.lang.String EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_HEADER

See Also:

Constant Field Values

EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_HEADER

public static final java.lang.String EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_HEADER

See Also:

Constant Field Values

EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_DESCRIPTION

public static final java.lang.String EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

WorkbookTypeCodeAndSelectedAttributeValidator

public WorkbookTypeCodeAndSelectedAttributeValidator()

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.List<ExcelValidationResult> validateSheet(org.apache.poi.ss.usermodel.Sheet typeSystemSheet,
                                                              org.apache.poi.ss.usermodel.Sheet sheet)

validateTypeCode

protected java.util.Optional<ExcelValidationResult> validateTypeCode(java.lang.String typeCode)

validateSelectedColumns

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

validateWhetherColumnExistAndUserHasPermission

protected java.util.Optional<ExcelValidationResult> validateWhetherColumnExistAndUserHasPermission(java.lang.String typeCode,
                                                                                                   java.util.List<SelectedAttributeQualifier> qualifiers)

validateSingleAttribute

protected java.util.Optional<ValidationMessage> validateSingleAttribute(java.lang.String typeCode,
                                                                        java.lang.String columnName,
                                                                        java.lang.String qualifier)

validateColumnUniqueness

protected java.util.Optional<ExcelValidationResult> validateColumnUniqueness(java.lang.String sheetName,
                                                                             java.util.List<SelectedAttributeQualifier> selectedColumns)

createValidationResult

protected java.util.Optional<ExcelValidationResult> createValidationResult(java.lang.String sheetName,
                                                                           java.util.List<java.lang.String> duplicateColumnNames)

findDuplicatedColumns

protected java.util.Set<SelectedAttributeQualifier> findDuplicatedColumns(java.util.List<SelectedAttributeQualifier> selectedColumns)

findDuplicates

protected <T> java.util.Set<T> findDuplicates(java.util.Collection<T> collection)

hasPermissionsToTypeCode

protected boolean hasPermissionsToTypeCode(java.lang.String typeCode)

hasPermissionsToAttribute

protected boolean hasPermissionsToAttribute(java.lang.String typeCode,
                                            SelectedAttributeQualifier qualifier)

hasPermissionsToAttribute

protected boolean hasPermissionsToAttribute(java.lang.String typeCode,
                                            java.lang.String qualifier)

prepareValidationResultForUnknownType

protected ExcelValidationResult prepareValidationResultForUnknownType(java.lang.String sheetName)

getExcelTemplateService

@Deprecated
public ExcelTemplateService getExcelTemplateService()

Deprecated.

since 1808.

setExcelTemplateService

@Deprecated
public void setExcelTemplateService(ExcelTemplateService excelTemplateService)

Deprecated.

since 1808.

getExcelWorkbookService

public ExcelWorkbookService getExcelWorkbookService()

setExcelWorkbookService

public void setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)

getExcelSheetService

public ExcelSheetService getExcelSheetService()

setExcelSheetService

public void setExcelSheetService(ExcelSheetService excelSheetService)

getExcelHeaderService

public ExcelHeaderService getExcelHeaderService()

setExcelHeaderService

public void setExcelHeaderService(ExcelHeaderService excelHeaderService)

getPermissionCRUDService

public PermissionCRUDService getPermissionCRUDService()

setPermissionCRUDService

public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)