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 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 final String	EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_DESCRIPTION
static final String	EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_HEADER
static final String	EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_DESCRIPTION
static final String	EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_HEADER
static final String	EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_DESCRIPTION
static final String	EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_HEADER

Constructor Summary

Constructors

Constructor	Description
WorkbookTypeCodeAndSelectedAttributeValidator()

Method Summary

Modifier and Type	Method	Description
protected Optional<ExcelValidationResult>	createValidationResult(String sheetName, List<String> duplicateColumnNames)
protected Set<SelectedAttributeQualifier>	findDuplicatedColumns(List<SelectedAttributeQualifier> selectedColumns)
protected <T> Set<T>	findDuplicates(Collection<T> collection)
ExcelHeaderService	getExcelHeaderService()
ExcelSheetService	getExcelSheetService()
ExcelTemplateService	getExcelTemplateService()	Deprecated, for removal: This API element is subject to removal in a future version. since 1808.
ExcelWorkbookService	getExcelWorkbookService()
PermissionCRUDService	getPermissionCRUDService()
protected boolean	hasPermissionsToAttribute(String typeCode, SelectedAttributeQualifier qualifier)
protected boolean	hasPermissionsToAttribute(String typeCode, String qualifier)
protected boolean	hasPermissionsToTypeCode(String typeCode)
protected ExcelValidationResult	prepareValidationResultForUnknownType(String sheetName)
void	setExcelHeaderService(ExcelHeaderService excelHeaderService)
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	setPermissionCRUDService(PermissionCRUDService permissionCRUDService)
List<ExcelValidationResult>	validate(org.apache.poi.ss.usermodel.Workbook workbook)	Validates workbook.
protected Optional<ExcelValidationResult>	validateColumnUniqueness(String sheetName, List<SelectedAttributeQualifier> selectedColumns)
protected List<ExcelValidationResult>	validateSelectedColumns(org.apache.poi.ss.usermodel.Sheet typeSystemSheet, org.apache.poi.ss.usermodel.Sheet sheet)
protected List<ExcelValidationResult>	validateSheet(org.apache.poi.ss.usermodel.Sheet typeSystemSheet, org.apache.poi.ss.usermodel.Sheet sheet)
protected Optional<ValidationMessage>	validateSingleAttribute(String typeCode, String columnName, String qualifier)
protected Optional<ExcelValidationResult>	validateTypeCode(String typeCode)
protected Optional<ExcelValidationResult>	validateWhetherColumnExistAndUserHasPermission(String typeCode, List<SelectedAttributeQualifier> qualifiers)

Methods inherited from class java.lang.Object

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

Field Details

EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_DESCRIPTION

public static final String EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_DESCRIPTION

See Also:

• Constant Field Values

EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_HEADER

public static final String EXCEL_IMPORT_VALIDATION_METADATA_UNKNOWN_TYPE_HEADER

See Also:

• Constant Field Values

EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_DESCRIPTION

public static final String EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_DESCRIPTION

See Also:

• Constant Field Values

EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_HEADER

public static final String EXCEL_IMPORT_VALIDATION_WORKBOOK_UNKNOWN_ATTRIBUTE_HEADER

See Also:

• Constant Field Values

EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_HEADER

public static final String EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_HEADER

See Also:

• Constant Field Values

EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_DESCRIPTION

public static final String EXCEL_IMPORT_VALIDATION_WORKBOOK_DUPLICATED_COLUMNS_DESCRIPTION

See Also:

• Constant Field Values

Constructor Details

WorkbookTypeCodeAndSelectedAttributeValidator

public WorkbookTypeCodeAndSelectedAttributeValidator()

Method Details

validate

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

validateTypeCode

protected Optional<ExcelValidationResult> validateTypeCode(String typeCode)

validateSelectedColumns

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

validateWhetherColumnExistAndUserHasPermission

protected Optional<ExcelValidationResult> validateWhetherColumnExistAndUserHasPermission(String typeCode,
 List<SelectedAttributeQualifier> qualifiers)

validateSingleAttribute

protected Optional<ValidationMessage> validateSingleAttribute(String typeCode,
 String columnName,
 String qualifier)

validateColumnUniqueness

protected Optional<ExcelValidationResult> validateColumnUniqueness(String sheetName,
 List<SelectedAttributeQualifier> selectedColumns)

createValidationResult

protected Optional<ExcelValidationResult> createValidationResult(String sheetName,
 List<String> duplicateColumnNames)

findDuplicatedColumns

protected Set<SelectedAttributeQualifier> findDuplicatedColumns(List<SelectedAttributeQualifier> selectedColumns)

findDuplicates

protected <T> Set<T> findDuplicates(Collection<T> collection)

hasPermissionsToTypeCode

protected boolean hasPermissionsToTypeCode(String typeCode)

hasPermissionsToAttribute

protected boolean hasPermissionsToAttribute(String typeCode,
 SelectedAttributeQualifier qualifier)

hasPermissionsToAttribute

protected boolean hasPermissionsToAttribute(String typeCode,
 String qualifier)

prepareValidationResultForUnknownType

protected ExcelValidationResult prepareValidationResultForUnknownType(String sheetName)

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)

getExcelHeaderService

public ExcelHeaderService getExcelHeaderService()

setExcelHeaderService

public void setExcelHeaderService(ExcelHeaderService excelHeaderService)

getPermissionCRUDService

public PermissionCRUDService getPermissionCRUDService()

setPermissionCRUDService

public void setPermissionCRUDService(PermissionCRUDService permissionCRUDService)