Interface HeaderGeneratorOperation

    • Method Detail

      • generateImpexHeaderLibrary

        java.util.List<java.util.Map<java.lang.Integer,​java.lang.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

        java.util.Map<java.lang.Integer,​java.lang.String> generateImpexMainHeader​(MappingModel mapping,
                                                                                        java.util.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

        java.util.List<java.util.Map<java.lang.Integer,​java.lang.String>> generateImpexSubHeaders​(java.util.Set<MappingLineModel> mappingLinesToCreate)
        Generates impex sub-headers.
        Parameters:
        mappingLinesToCreate -
        Returns:
        List of mapping lines (represented as map instances).
      • generateImpexSubHeader

        java.util.Map<java.lang.Integer,​java.lang.String> generateImpexSubHeader​(MappingLineModel mappingLineModel,
                                                                                       java.util.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

        java.util.Map<java.lang.Integer,​java.lang.String> generateImpexHeaderBeanShellStatement​(java.lang.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

        java.lang.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

        java.lang.String generateImpexHeaderComposedField​(MappingLineModel line,
                                                          java.util.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

        java.lang.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

        java.lang.String generateImpexHeaderAttributeReference​(MappingLineModel line,
                                                               java.util.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

        java.lang.String generateImpexHeaderCatalogVersionMacro​(CatalogVersionModel catalogVersion,
                                                                java.lang.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

        java.lang.String generateCatSysVersionMacro​(MappingModel mappingModel,
                                                    java.lang.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

        java.lang.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