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

Interface HeaderGeneratorOperation

All Superinterfaces:

ImpexGeneratorOperation

All Known Implementing Classes:

DefaultHeaderGeneratorOperation

public interface HeaderGeneratorOperation
extends ImpexGeneratorOperation

ImpEx header generation operation API.

Method Summary

Modifier and Type	Method and Description
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)
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.
String	generateMacro4ProductAttributes(AttributeCollectionMappingLine attributeLine) Generates catalog version macro for product attribute.

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

getCatalogVersionsForMapping, getGeneratedDocIDReference, getVersionForMappingLine, hasMappedSources, isCatalogItem

Method Detail

generateImpexHeaderLibrary

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

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.

Parameters:

cronJobModel -

mapping -

Returns:

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

generateImpexMainHeader

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).

Parameters:

mapping -

Returns:

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

generateImpexSubHeaders

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

Generates impex sub-headers.

Parameters:

mappingLinesToCreate -

Returns:

List of mapping lines (represented as map instances).

generateImpexSubHeader

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

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.

Parameters:

mappingLineModel - MappingLineModel

Returns:

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

generateImpexHeaderBeanShellStatement

Map<Integer,String> generateImpexHeaderBeanShellStatement(String fileName)

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

Parameters:

fileName - name of file to be referenced from the BeanShell

Returns:

map representation of the impex line

generateImpexHeaderForAtomicField

String generateImpexHeaderForAtomicField(MappingLineModel line)

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

Parameters:

line - the line to be imported

Returns:

string representation of the atomic field import script

generateImpexHeaderComposedField

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

Parameters:

line -

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

String generateImpexHeaderLocalizedSubField(MappingLineModel mappingLine)

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

Parameters:

mappingLine - a non-null MappingLineModel object.

Returns:

the resultant localized header script from all localized attributes found.

generateImpexHeaderAttributeReference

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

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

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. For example: catalogVersion(catalog(id[default='importcockpit']),version[default='default'])

Parameters:

catalogVersion -

cvAttributeQualifier -

Returns:

the macro reference as a string

generateCatSysVersionMacro

String generateCatSysVersionMacro(MappingModel mappingModel,
                                  String catalog)

Generates catalog version macro for the given mapping and catalog.

Parameters:

mappingModel -

catalog - catalog version for which the macro should be generated

Returns:

catalog version macro

generateMacro4ProductAttributes

String generateMacro4ProductAttributes(AttributeCollectionMappingLine attributeLine)

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

Parameters:

attributeLine -

Returns:

catalog version macro