de.hybris.platform.importcockpit.services.impex.generator.operations.impl

Class DefaultHeaderGeneratorOperation

java.lang.Object

de.hybris.platform.importcockpit.services.impex.generator.operations.impl.AbstractImpexGeneratorOperation

de.hybris.platform.importcockpit.services.impex.generator.operations.impl.DefaultHeaderGeneratorOperation

All Implemented Interfaces:

HeaderGeneratorOperation, ImpexGeneratorOperation

public class DefaultHeaderGeneratorOperation
extends AbstractImpexGeneratorOperation
implements HeaderGeneratorOperation

Constructor Summary

Constructors

Constructor and Description
DefaultHeaderGeneratorOperation()

Method Summary

Modifier and Type	Method and Description
protected void	appendClassModifierToSubHeader(TranslatorMappingLine translatorMappingLine, StringBuilder out)
protected void	appendDefaultUnitToSubHeader(TranslatorMappingLine translatorMappingLine, StringBuilder out)
protected Collection<String>	generateAttributes4ProductHeader(MappingLineModel mappingLineModel)
protected void	generateAttributes4ProductHeader(MappingLineModel mappingLineModel, Map<Integer,String> headerLine) Deprecated. since 4.7
String	generateCatSysVersionMacro(MappingModel mappingModel, String catalog) Generates catalog version macro for the given mapping and catalog.
String	generateImpexHeaderAttributeReference(MappingLineModel line, Set<MappingLineModel> mappingLinesToCreate)
Map<Integer,String>	generateImpexHeaderBeanShellStatement(String fileName) Generates impex header for bean shell import of an external file.
String	generateImpexHeaderCatalogVersionMacro(CatalogVersionModel catalogVersion, String cvAttributeQualifier) Creates the macro reference for the catalog or system version for the main impex header including the default setup.
String	generateImpexHeaderComposedField(MappingLineModel line, Set<MappingLineModel> mappingLinesToCreate)
protected String	generateImpexHeaderField(MappingLineModel mappingLine, Set<MappingLineModel> mappingLinesToCreate) Calls the relevant generateImpexHeader..
String	generateImpexHeaderForAtomicField(MappingLineModel line) Generates part of the impex that is responsible for importing an atomic type.
List<Map<Integer,String>>	generateImpexHeaderLibrary(ImportCockpitCronJobModel cronJobModel, MappingModel mapping) Creates the impex header library for the import package using the mapping.
String	generateImpexHeaderLocalizedSubField(MappingLineModel mappingLine) Generates localized header scripts for localized attributes for the given MappingLineModel object.
Map<Integer,String>	generateImpexMainHeader(MappingModel mapping, Set<MappingLineModel> mappingLinesToCreate) Generates the main impex header mappingLineModel for the import of items of the main target/base type (the type set as base type in the mapping).
Map<Integer,String>	generateImpexSubHeader(MappingLineModel mappingLineModel, Set<MappingLineModel> mappingLinesToCreate) Generates sub headers for the on-the-fly import (impexImportMode INSERT) of sub data.
List<Map<Integer,String>>	generateImpexSubHeaders(Set<MappingLineModel> mappingLinesToCreate) Generates impex sub-headers.
protected String	generateImportBeanShellStatement(String fileName)
String	generateMacro4ProductAttributes(AttributeCollectionMappingLine attributeLine) Generates catalog version macro for product attribute.
protected void	getMappingLinesForAttribsCreateImportMode(MappingLineModel mappingLine, Set<MappingLineModel> mappingLinesToCreate) Builds a List of {link@MappingLineModel} objects whose composed attribute import mode is set to ComposedAttribImportMode.CREATE when generating the impex header for composed fields.

Methods inherited from class de.hybris.platform.importcockpit.services.impex.generator.operations.impl.AbstractImpexGeneratorOperation

appendCatalogVersionDetailsForAttributeReference, appendOwner, apppendTranslatorForProductAttrib, getCatalogTypeService, getCatalogVersionsForMapping, getGeneratedDocIDReference, getHaveUniqueAttributes, getMappingLineService, getMappingService, getVersionForMappingLine, hasMappedSource, hasMappedSources, isCatalogItem, setCatalogTypeService, setMappingLineService, setMappingService

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.importcockpit.services.impex.generator.operations.ImpexGeneratorOperation

getCatalogVersionsForMapping, getGeneratedDocIDReference, getVersionForMappingLine, hasMappedSources, isCatalogItem

Constructor Detail

DefaultHeaderGeneratorOperation

public DefaultHeaderGeneratorOperation()

Method Detail

generateImpexHeaderLibrary

public List<Map<Integer,String>> generateImpexHeaderLibrary(ImportCockpitCronJobModel cronJobModel,
                                                            MappingModel mapping)

Description copied from interface: HeaderGeneratorOperation

Creates the impex header library for the import package using the mapping. The header library consists of header lines and bean shell statements for the import of data files. The header lines and bean shell statements are maps of string fields on different positions.

Specified by:

generateImpexHeaderLibrary in interface HeaderGeneratorOperation

Returns:

a list of header lines and bean shell statements referring to the data files

generateImpexMainHeader

public Map<Integer,String> generateImpexMainHeader(MappingModel mapping,
                                                   Set<MappingLineModel> mappingLinesToCreate)

Description copied from interface: HeaderGeneratorOperation

Generates the main impex header mappingLineModel for the import of items of the main target/base type (the type set as base type in the mapping).

Specified by:

generateImpexMainHeader in interface HeaderGeneratorOperation

Returns:

impex import header mappingLineModel as a map of strings on specified positions

generateImpexSubHeader

public Map<Integer,String> generateImpexSubHeader(MappingLineModel mappingLineModel,
                                                  Set<MappingLineModel> mappingLinesToCreate)

Description copied from interface: HeaderGeneratorOperation

Generates sub headers for the on-the-fly import (impexImportMode INSERT) of sub data. This is necessary when the user has specified the import impexImportMode CREATE for one or more mapping lines.

Specified by:

generateImpexSubHeader in interface HeaderGeneratorOperation

Parameters:

mappingLineModel - MappingLineModel

Returns:

impex sub header mappingLineModel for the on-the-fly INSERT import

generateImpexSubHeaders

public List<Map<Integer,String>> generateImpexSubHeaders(Set<MappingLineModel> mappingLinesToCreate)

Description copied from interface: HeaderGeneratorOperation

Generates impex sub-headers.

Specified by:

generateImpexSubHeaders in interface HeaderGeneratorOperation

Returns:

List of mapping lines (represented as map instances).

generateImpexHeaderBeanShellStatement

public Map<Integer,String> generateImpexHeaderBeanShellStatement(String fileName)

Description copied from interface: HeaderGeneratorOperation

Generates impex header for bean shell import of an external file.

Specified by:

generateImpexHeaderBeanShellStatement in interface HeaderGeneratorOperation

Parameters:

fileName - name of file to be referenced from the BeanShell

Returns:

map representation of the impex line

generateImpexHeaderForAtomicField

public String generateImpexHeaderForAtomicField(MappingLineModel line)

Description copied from interface: HeaderGeneratorOperation

Generates part of the impex that is responsible for importing an atomic type.

Specified by:

generateImpexHeaderForAtomicField in interface HeaderGeneratorOperation

Parameters:

line - the line to be imported

Returns:

string representation of the atomic field import script

generateImpexHeaderComposedField

public String generateImpexHeaderComposedField(MappingLineModel line,
                                               Set<MappingLineModel> mappingLinesToCreate)

Specified by:

generateImpexHeaderComposedField in interface HeaderGeneratorOperation

mappingLinesToCreate - - a Set of MappingLineModel objects from which the composed fields will be generated.

Returns:

a String representing the header fields for composed types for the given MappingLineModel object.

generateImpexHeaderLocalizedSubField

public String generateImpexHeaderLocalizedSubField(MappingLineModel mappingLine)

Description copied from interface: HeaderGeneratorOperation

Generates localized header scripts for localized attributes for the given MappingLineModel object.

Specified by:

generateImpexHeaderLocalizedSubField in interface HeaderGeneratorOperation

Parameters:

mappingLine - a non-null MappingLineModel object.

Returns:

the resultant localized header script from all localized attributes found.

generateImpexHeaderAttributeReference

public String generateImpexHeaderAttributeReference(MappingLineModel line,
                                                    Set<MappingLineModel> mappingLinesToCreate)

Specified by:

generateImpexHeaderAttributeReference in interface HeaderGeneratorOperation

Parameters:

line - - a non-null MappingLineModel object from which the attribute references will be derived and used to build their related header script.

mappingLinesToCreate - - a Set of MappingLineModel objects from which the composed fields will be generated.

Returns:

a String represenataion of all Attribute References found for the specified MappingLineModel

generateImpexHeaderCatalogVersionMacro

public String generateImpexHeaderCatalogVersionMacro(CatalogVersionModel catalogVersion,
                                                     String cvAttributeQualifier)

Description copied from interface: HeaderGeneratorOperation

Creates the macro reference for the catalog or system version for the main impex header including the default setup. For example: catalogVersion(catalog(id[default='importcockpit']),version[default='default'])

Specified by:

generateImpexHeaderCatalogVersionMacro in interface HeaderGeneratorOperation

Returns:

the macro reference as a string

generateCatSysVersionMacro

public String generateCatSysVersionMacro(MappingModel mappingModel,
                                         String catalog)

Description copied from interface: HeaderGeneratorOperation

Generates catalog version macro for the given mapping and catalog.

Specified by:

generateCatSysVersionMacro in interface HeaderGeneratorOperation

catalog - catalog version for which the macro should be generated

Returns:

catalog version macro

generateMacro4ProductAttributes

public String generateMacro4ProductAttributes(AttributeCollectionMappingLine attributeLine)

Description copied from interface: HeaderGeneratorOperation

Generates catalog version macro for product attribute. In case of classification attributes appends appropriate translator definition.

Specified by:

generateMacro4ProductAttributes in interface HeaderGeneratorOperation

Returns:

catalog version macro

generateImpexHeaderField

protected String generateImpexHeaderField(MappingLineModel mappingLine,
                                          Set<MappingLineModel> mappingLinesToCreate)

Calls the relevant generateImpexHeader.. method based on whether the given MappingLineModel represents an atomic type or not.

Parameters:

mappingLine -

mappingLinesToCreate -

Returns:

a String object containing the header data for the current MappingLineModel.

generateImportBeanShellStatement

protected String generateImportBeanShellStatement(String fileName)

Parameters:

fileName -

Returns:

resultStmt

getMappingLinesForAttribsCreateImportMode

protected void getMappingLinesForAttribsCreateImportMode(MappingLineModel mappingLine,
                                                         Set<MappingLineModel> mappingLinesToCreate)

Builds a List of {link@MappingLineModel} objects whose composed attribute import mode is set to ComposedAttribImportMode.CREATE when generating the impex header for composed fields.

Parameters:

mappingLine - - a {link@MappingLineModel} object from which the composed attribute import mode will be checked.

mappingLinesToCreate -

generateAttributes4ProductHeader

@Deprecated
protected void generateAttributes4ProductHeader(MappingLineModel mappingLineModel,
                                                            Map<Integer,String> headerLine)

Deprecated. since 4.7

Parameters:

mappingLineModel -

headerLine -

See Also:

generateAttributes4ProductHeader(MappingLineModel)

generateAttributes4ProductHeader

protected Collection<String> generateAttributes4ProductHeader(MappingLineModel mappingLineModel)

Parameters:

mappingLineModel -

appendDefaultUnitToSubHeader

protected void appendDefaultUnitToSubHeader(TranslatorMappingLine translatorMappingLine,
                                            StringBuilder out)

appendClassModifierToSubHeader

protected void appendClassModifierToSubHeader(TranslatorMappingLine translatorMappingLine,
                                              StringBuilder out)