com.hybris.backoffice.excel.importing

Class DefaultExcelImportService

java.lang.Object

com.hybris.backoffice.excel.importing.DefaultExcelImportService

All Implemented Interfaces:

ExcelImportService

public class DefaultExcelImportService
extends java.lang.Object
implements ExcelImportService

Service responsible for generating Impex based on excel file represented by Workbook object. In order to generating impex script, we can pass the cellValidation of {#importData} to ImpexConverter.convert(Impex).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultExcelImportService.CellValidationMetaData POJO which contains cell validation meta data

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIRST_DATA_ROW_INDEX
static java.lang.String	MULTIVALUE_SEPARATOR Deprecated. since 1808 - Use ImportParameters.MULTIVALUE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
DefaultExcelImportService()

Method Summary

Modifier and Type	Method and Description
Impex	convertToImpex(Workbook workbook) Transforms excel workbook into Impex object.
protected boolean	findFirstNotBlankCell(Row row)
protected ImportParameters	findImportParameters(SelectedAttribute selectedAttribute, java.lang.String cellValue, java.lang.String typeCode, java.lang.String entryRef) Parses cell's value taking into account reference pattern and default values (which are located in the second and third row).
protected java.util.List<java.lang.String>	generateDocumentRefs(java.lang.Integer rowsCount) In order to simplify cross-reference imports, impex allows to use document reference.
protected Impex	generateImpexForSheet(Sheet typeSystemSheet, Sheet typeSheet) Generates impex for given sheet
protected java.lang.String	getAttributeDisplayName(SelectedAttribute attribute)
DisplayNameAttributeNameFormatter	getDisplayNameAttributeNameFormatter()
ExcelCellService	getExcelCellService()
ExcelHeaderService	getExcelHeaderService()
ExcelSheetService	getExcelSheetService()
ExcelTemplateService	getExcelTemplateService() Deprecated. since 1808
ExcelTranslatorRegistry	getExcelTranslatorRegistry()
ExcelValidationEngineAwareValidator	getExcelValidationEngineAwareValidator()
ExcelWorkbookService	getExcelWorkbookService()
ParserRegistry	getParserRegistry()
java.util.List<WorkbookValidator>	getWorkbookValidators()
protected boolean	hasRowCorrectData(Row row)
protected void	insertDocumentReferences(Impex mainImpex, java.lang.String typeCode, java.util.List<java.lang.String> entriesRef) In order to simplify cross-reference imports, impex allows to use document reference.
protected void	mergeWithRowValidation(java.util.Map<java.lang.Integer,ExcelValidationResult> rowsValidation, java.lang.Integer rowIndex, ExcelValidationResult cellValidation)
protected ExcelWorksheet	populate(Sheet typeSystemSheet, Sheet typeSheet)
protected ExcelWorkbook	populate(Workbook workbook)
protected void	populateHeaderMetadata(ValidationMessage header, DefaultExcelImportService.CellValidationMetaData metaData)
protected void	populateRows(Sheet typeSheet, ExcelWorksheet excelWorksheet, java.util.List<java.lang.String> entriesRef, SelectedAttribute selectedAttribute, int columnIndex)
protected ValidationMessage	prepareValidationHeader(DefaultExcelImportService.CellValidationMetaData metaData)
void	setDisplayNameAttributeNameFormatter(DisplayNameAttributeNameFormatter displayNameAttributeNameFormatter)
void	setExcelCellService(ExcelCellService excelCellService)
void	setExcelHeaderService(ExcelHeaderService excelHeaderService)
void	setExcelSheetService(ExcelSheetService excelSheetService)
void	setExcelTemplateService(ExcelTemplateService excelTemplateService) Deprecated. since 1808
void	setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)
void	setExcelValidationEngineAwareValidator(ExcelValidationEngineAwareValidator excelValidationEngineAwareValidator)
void	setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)
void	setParserRegistry(ParserRegistry parserRegistry)
void	setWorkbookValidators(java.util.List<WorkbookValidator> workbookValidators)
protected java.util.List<ExcelValidationResult>	validate(ExcelWorksheet excelWorksheet, java.util.Map<java.lang.String,java.lang.Object> context)
java.util.List<ExcelValidationResult>	validate(Workbook workbook) Validates a workbook.
java.util.List<ExcelValidationResult>	validate(Workbook workbook, java.util.Set<java.lang.String> mediaContentEntries) Validates a workbook.
protected java.util.Optional<ExcelValidationResult>	validateCell(ExcelValueTranslator translator, DefaultExcelImportService.CellValidationMetaData metaData)
protected java.util.Optional<ExcelValidationResult>	validateExcelFileOrigin(Workbook workbook)
protected java.util.List<ExcelValidationResult>	validateWorkbook(Workbook workbook)

Methods inherited from class java.lang.Object

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

Field Detail

MULTIVALUE_SEPARATOR

@Deprecated
public static final java.lang.String MULTIVALUE_SEPARATOR

Deprecated. since 1808 - Use ImportParameters.MULTIVALUE_SEPARATOR

See Also:

Constant Field Values

FIRST_DATA_ROW_INDEX

public static final int FIRST_DATA_ROW_INDEX

See Also:

Constant Field Values

Constructor Detail

DefaultExcelImportService

public DefaultExcelImportService()

Method Detail

convertToImpex

public Impex convertToImpex(Workbook workbook)

Transforms excel workbook into Impex object. It takes into account all sheets included in excel file.

Specified by:

convertToImpex in interface ExcelImportService

Parameters:

workbook - Workbook object which represents excel file

Returns:

generated Impex object which represents data from the workbook

validate

public java.util.List<ExcelValidationResult> validate(Workbook workbook,
                                                      java.util.Set<java.lang.String> mediaContentEntries)

Description copied from interface: ExcelImportService

Validates a workbook.

Specified by:

validate in interface ExcelImportService

Parameters:

workbook - workbook to validate.

mediaContentEntries - set of entries names inside media content attached to the excel file. Null if media is not attached.

Returns:

list of validation results.

validate

public java.util.List<ExcelValidationResult> validate(Workbook workbook)

Description copied from interface: ExcelImportService

Validates a workbook.

Specified by:

validate in interface ExcelImportService

Parameters:

workbook - workbook to validate.

Returns:

list of validation results.

validateExcelFileOrigin

protected java.util.Optional<ExcelValidationResult> validateExcelFileOrigin(Workbook workbook)

validateWorkbook

protected java.util.List<ExcelValidationResult> validateWorkbook(Workbook workbook)

populate

protected ExcelWorkbook populate(Workbook workbook)

populate

protected ExcelWorksheet populate(Sheet typeSystemSheet,
                                  Sheet typeSheet)

populateRows

protected void populateRows(Sheet typeSheet,
                            ExcelWorksheet excelWorksheet,
                            java.util.List<java.lang.String> entriesRef,
                            SelectedAttribute selectedAttribute,
                            int columnIndex)

hasRowCorrectData

protected boolean hasRowCorrectData(Row row)

findFirstNotBlankCell

protected boolean findFirstNotBlankCell(Row row)

validate

protected java.util.List<ExcelValidationResult> validate(ExcelWorksheet excelWorksheet,
                                                         java.util.Map<java.lang.String,java.lang.Object> context)

mergeWithRowValidation

protected void mergeWithRowValidation(java.util.Map<java.lang.Integer,ExcelValidationResult> rowsValidation,
                                      java.lang.Integer rowIndex,
                                      ExcelValidationResult cellValidation)

getAttributeDisplayName

protected java.lang.String getAttributeDisplayName(SelectedAttribute attribute)

validateCell

protected java.util.Optional<ExcelValidationResult> validateCell(ExcelValueTranslator translator,
                                                                 DefaultExcelImportService.CellValidationMetaData metaData)

prepareValidationHeader

protected ValidationMessage prepareValidationHeader(DefaultExcelImportService.CellValidationMetaData metaData)

populateHeaderMetadata

protected void populateHeaderMetadata(ValidationMessage header,
                                      DefaultExcelImportService.CellValidationMetaData metaData)

generateImpexForSheet

protected Impex generateImpexForSheet(Sheet typeSystemSheet,
                                      Sheet typeSheet)

Generates impex for given sheet

Parameters:

typeSystemSheet - - sheet contains metainformation about type codes

typeSheet - - sheet contains data for given type code

Returns:

Impex generated impex object

insertDocumentReferences

protected void insertDocumentReferences(Impex mainImpex,
                                        java.lang.String typeCode,
                                        java.util.List<java.lang.String> entriesRef)

In order to simplify cross-reference imports, impex allows to use document reference. This method inserts references for each row.

Parameters:

mainImpex - Impex - represents impex for currently processing workbook

typeCode - - type code of currently processing sheet

entriesRef - - list of generated document references

generateDocumentRefs

protected java.util.List<java.lang.String> generateDocumentRefs(java.lang.Integer rowsCount)

In order to simplify cross-reference imports, impex allows to use document reference. The method generates list of random UUIDs for each row of imported excel.

Parameters:

rowsCount - - indicates how many document references should be generated.

Returns:

list of UUIDs

findImportParameters

protected ImportParameters findImportParameters(SelectedAttribute selectedAttribute,
                                                java.lang.String cellValue,
                                                java.lang.String typeCode,
                                                java.lang.String entryRef)

Parses cell's value taking into account reference pattern and default values (which are located in the second and third row). Merges default values if needed.

Parameters:

selectedAttribute - SelectedAttribute - Information about selected attribute: its isoCode (for localized values), referencePattern for references and attributeDescriptor

cellValue - - Original cell's value represented as String

typeCode - - Type code of current sheet

Returns:

ImportParameters Converted import parameters, merged with default values

getExcelTemplateService

@Deprecated
public ExcelTemplateService getExcelTemplateService()

Deprecated. since 1808

setExcelTemplateService

@Deprecated
public void setExcelTemplateService(ExcelTemplateService excelTemplateService)

Deprecated. since 1808

getExcelTranslatorRegistry

public ExcelTranslatorRegistry getExcelTranslatorRegistry()

setExcelTranslatorRegistry

public void setExcelTranslatorRegistry(ExcelTranslatorRegistry excelTranslatorRegistry)

getWorkbookValidators

public java.util.List<WorkbookValidator> getWorkbookValidators()

setWorkbookValidators

public void setWorkbookValidators(java.util.List<WorkbookValidator> workbookValidators)

getExcelValidationEngineAwareValidator

public ExcelValidationEngineAwareValidator getExcelValidationEngineAwareValidator()

setExcelValidationEngineAwareValidator

public void setExcelValidationEngineAwareValidator(ExcelValidationEngineAwareValidator excelValidationEngineAwareValidator)

getParserRegistry

public ParserRegistry getParserRegistry()

setParserRegistry

public void setParserRegistry(ParserRegistry parserRegistry)

getExcelWorkbookService

public ExcelWorkbookService getExcelWorkbookService()

setExcelWorkbookService

public void setExcelWorkbookService(ExcelWorkbookService excelWorkbookService)

getExcelSheetService

public ExcelSheetService getExcelSheetService()

setExcelSheetService

public void setExcelSheetService(ExcelSheetService excelSheetService)

getExcelCellService

public ExcelCellService getExcelCellService()

setExcelCellService

public void setExcelCellService(ExcelCellService excelCellService)

getExcelHeaderService

public ExcelHeaderService getExcelHeaderService()

setExcelHeaderService

public void setExcelHeaderService(ExcelHeaderService excelHeaderService)

getDisplayNameAttributeNameFormatter

public DisplayNameAttributeNameFormatter getDisplayNameAttributeNameFormatter()

setDisplayNameAttributeNameFormatter

public void setDisplayNameAttributeNameFormatter(DisplayNameAttributeNameFormatter displayNameAttributeNameFormatter)