Package de.hybris.platform.impex.constants

Class ImpExConstants.Syntax.Modifier

  • Enclosing class:
    ImpExConstants.Syntax
    public static final class ImpExConstants.Syntax.Modifier
extends java.lang.Object
    Declares the allowed set of modifiers. They are separated in cell and line modifiers. Line modifier means, that they have to be declared after type declaration. A cell modifier has to be declared after attribute declaration.
    INSERT Language[line_modifier=value];isocode[cell_modifier=value]; active[cell_modifier=value]

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ALIAS
      With that modifier you can specify an alias name for an attribute which will be used in export case as attribute text in destination file.
      static java.lang.String ALLOWNULL
      If set, an mandatory attribute will not be checked for null value.
      static java.lang.String ATTRIBUTE_PATH_DELIMITER
      With that modifier you can specify a custom separator for item expressions.
      static java.lang.String BATCHMODE
      If it is update or remove mode than the batch mode allows to resolve more than one existing item for a value line.
      static java.lang.String CACHE_UNIQUE_KEYS
      If this option is enabled the CachingExistingItemResolver will be used for existing item resolving (in case of update or remove mode) which caches already resolved items related to the unique keys used for searching.
      Type: line modifier
      Possible values: 'true' or 'false'
      Default value: 'false'.
      static java.lang.String COLLECTION_VALUE_DELIMITER
      With that you can specify a custom collection value delimiter.
      static java.lang.String COLLECTION_VALUE_MODE
      Specifies the collection modifying mode.
      static java.lang.String CSV_DECORATOR
      Specifies a decorator class for modifying the cell value before interpreting.
      Type: cell modifier
      Attribute Type: All
      Possible values: A cell decorator class like 'de.hybris.platform.catalog.jalo.classification.eclass.EClassSuperCategoryDecorator'
      Default value: No decorator will be applied
      static java.lang.String DATEFORMAT
      Using this modifier you can specify a custom pattern for your Date and StandardDateRange values.
      Type: cell modifier
      Attribute Type: Date, StandardDateRange
      Possible values: a date format like 'MM.dd.yy'
      Default value: DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.MEDIUM, impexReader.getLocale() )
      static java.lang.String DEFAULT
      With this modifier you can specify a default value for an attribute which is used if the cell is empty at a value line.
      Type: cell modifier
      Attribute Type: All
      Possible values: a value fitting the desired attribute type
      Default value: empty.
      static java.lang.String FORCE_WRITE
      If set, read-only columns will be tried to processed.
      static java.lang.String IGNORE_KEY_CASE
      If set, the case of text which specifies attributes of items for resolving is ignored.
      Type: cell modifier
      Attribute Type: Item
      Possible values: 'true' or 'false'
      Default value: 'false'
      static java.lang.String IGNORE_NULL
      If the attribute is of type collection, you can specify to ignore null values.
      static java.lang.String IMPEX_LEGACY_MODE
      If set, impex will switch to legacy handling.
      static java.lang.String KEY2VALUE_DELIMITER
      Specifies the delimiter for separating a key - value pair for attributes of type map.
      static java.lang.String LANGUAGE
      For localized attributes (are a map from language to string) you have to specify the language to use.
      Type: cell modifier
      Attribute Type: Locale Map
      Possible values: a language isocode like 'de'
      Default value:
      static java.lang.String MAP_VALUE_DELIMITER
      Specifies the delimiter which separates the key - value pairs for an attribute of type map.
      Type: cell modifier
      Attribute Type: Map
      Possible values: a char like 'q'
      Default value: ImpExConstants.Syntax.DEFAULT_MAP_VALUE_DELIMITER
      static java.lang.String NUMBERFORMAT
      Using this modifier you can specify a custom pattern for your Number values.
      Type: cell modifier
      Attribute Type: Number
      Possible values: number format
      Default value: NumberFormat.getNumberInstance( impexReader.getLocale() )
      static java.lang.String PARALLEL
      With that modifier you can specify whether to process lines of this header by parallel processed or not.
      Type: line modifier
      Possible values: true, false
      static java.lang.String PK_FROM_EXTERNAL_IMPORT_KEY
      Hint to ItemPKTranslator to look for PK in ExternalImportKey item.
      static java.lang.String POSITION
      Specifies the column position where the values of this attribute can be found.
      static java.lang.String PROCESSOR
      With that modifier you can specify an custom ImportProcessor for the processing of value lines associated with the header.
      Type: line modifier
      Possible values: an ImportProcessor like 'de.hybris.platform.impex.jalo.imp.DefaultImportProcessor'
      Default value: The processor set when instantiating the ImpExImportReader.
      static java.lang.String QUERY_CHUNK_SIZE
      Specifies the query chunk size.
      static java.lang.String SLD_ENABLED
      If set, impex will use direct persistence (service layer direct) for import data.
      static java.lang.String SOURCE_SYSTEM_ID
      SourceSystemID to perform lookup in.
      static java.lang.String TRANSLATOR
      With that modifier you can specify an custom translator to use for translating the cell value of a value line.
      Type: cell modifier
      Attribute Type: All
      Possible values: a class name like 'de.hybris.platform.impex.jalo.translators.UserPasswordTranslator'
      Default value: a translator dependent on attribute type.
      static java.lang.String UNIQUE
      Declares an attribute as unique.
      static java.lang.String VIRTUAL
      If set, no cell value is expected.

    • Constructor Summary

      Constructors 
      Constructor Description
      Modifier()  

    • Method Summary

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • BATCHMODE

        public static final java.lang.String BATCHMODE
        If it is update or remove mode than the batch mode allows to resolve more than one existing item for a value line. If the batch mode is not enabled, it will cause an error if more than one existing item is found.
        Type: line modifier
        Possible values: 'true' or 'false'
        Default value: 'false'.
        See Also:
        Constant Field Values

      • CACHE_UNIQUE_KEYS

        public static final java.lang.String CACHE_UNIQUE_KEYS
        If this option is enabled the CachingExistingItemResolver will be used for existing item resolving (in case of update or remove mode) which caches already resolved items related to the unique keys used for searching.
        Type: line modifier
        Possible values: 'true' or 'false'
        Default value: 'false'.
        See Also:
        Constant Field Values

      • PROCESSOR

        public static final java.lang.String PROCESSOR
        With that modifier you can specify an custom ImportProcessor for the processing of value lines associated with the header.
        Type: line modifier
        Possible values: an ImportProcessor like 'de.hybris.platform.impex.jalo.imp.DefaultImportProcessor'
        Default value: The processor set when instantiating the ImpExImportReader. In default case it is DefaultImportProcessor
        See Also:
        Constant Field Values

      • PARALLEL

        public static final java.lang.String PARALLEL
        With that modifier you can specify whether to process lines of this header by parallel processed or not.
        Type: line modifier
        Possible values: true, false
        See Also:
        Constant Field Values

      • TRANSLATOR

        public static final java.lang.String TRANSLATOR
        With that modifier you can specify an custom translator to use for translating the cell value of a value line.
        Type: cell modifier
        Attribute Type: All
        Possible values: a class name like 'de.hybris.platform.impex.jalo.translators.UserPasswordTranslator'
        Default value: a translator dependent on attribute type.
        See Also:
        Constant Field Values

      • DEFAULT

        public static final java.lang.String DEFAULT
        With this modifier you can specify a default value for an attribute which is used if the cell is empty at a value line.
        Type: cell modifier
        Attribute Type: All
        Possible values: a value fitting the desired attribute type
        Default value: empty.
        See Also:
        Constant Field Values

      • LANGUAGE

        public static final java.lang.String LANGUAGE
        For localized attributes (are a map from language to string) you have to specify the language to use.
        Type: cell modifier
        Attribute Type: Locale Map
        Possible values: a language isocode like 'de'
        Default value:
        See Also:
        Constant Field Values

      • UNIQUE

        public static final java.lang.String UNIQUE
        Declares an attribute as unique. All unique attributes are used for existing item resolving. Furthermore the item can only be created if all unique attributes can be resolved.
        Type: cell modifier
        Attribute Type: All
        Possible values: 'true' or 'false'
        Default value: 'false'
        See Also:
        Constant Field Values

      • ALLOWNULL

        public static final java.lang.String ALLOWNULL
        If set, an mandatory attribute will not be checked for null value. So ImpEx will not throw an exception, but maybe the business logic for item creation.
        Type: cell modifier
        Attribute Type: All
        Possible values: 'true' or 'false'
        Default value: 'false'
        See Also:
        Constant Field Values

      • IGNORE_NULL

        public static final java.lang.String IGNORE_NULL
        If the attribute is of type collection, you can specify to ignore null values. So if an attribute is given in collection syntax and contains a value is translated to null, the value will be ignored.
        Type: cell modifier
        Attribute Type: Collection
        Possible values: 'true' or 'false'
        Default value: 'false'
        See Also:
        Constant Field Values

      • DATEFORMAT

        public static final java.lang.String DATEFORMAT
        Using this modifier you can specify a custom pattern for your Date and StandardDateRange values.
        Type: cell modifier
        Attribute Type: Date, StandardDateRange
        Possible values: a date format like 'MM.dd.yy'
        Default value: DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.MEDIUM, impexReader.getLocale() )
        See Also:
        Constant Field Values

      • NUMBERFORMAT

        public static final java.lang.String NUMBERFORMAT
        Using this modifier you can specify a custom pattern for your Number values.
        Type: cell modifier
        Attribute Type: Number
        Possible values: number format
        Default value: NumberFormat.getNumberInstance( impexReader.getLocale() )
        See Also:
        Constant Field Values

      • COLLECTION_VALUE_DELIMITER

        public static final java.lang.String COLLECTION_VALUE_DELIMITER
        With that you can specify a custom collection value delimiter. Means you can change the separator between two elements of a collection.
        Type: cell modifier
        Attribute Type: Collection Possible values: a char like 'q'
        Default value: ImpExConstants.Syntax.DEFAULT_COLLECTION_VALUE_DELIMITER
        See CORE-3378.
        See Also:
        Constant Field Values

      • ATTRIBUTE_PATH_DELIMITER

        public static final java.lang.String ATTRIBUTE_PATH_DELIMITER
        With that modifier you can specify a custom separator for item expressions. This are such values which are composed of many values describing one item together.
        Type: cell modifier
        Attribute Type: Item
        Possible values: a char like 'q'
        Default value: ImpExConstants.Syntax.DEFAULT_ATTRIBUTE_PATH_SEPARATOR
        See CORE-3540.
        See Also:
        Constant Field Values

      • COLLECTION_VALUE_MODE

        public static final java.lang.String COLLECTION_VALUE_MODE
        Specifies the collection modifying mode. You can specify mode 'append' or 'remove' for attributes of type collection. In 'append' mode, the elements of the collection value will be added to the existing resolved collection and in 'remove' mode they will be removed.
        Type: cell modifier
        Attribute Type: Collection
        Possible values: ImpExConstants.Syntax.COLLECTION_VALUE_MODE_APPEND or ImpExConstants.Syntax.COLLECTION_VALUE_MODE_REMOVE
        Default value: None mode selected - a new collection will be created containing given values.
        See Also:
        Constant Field Values

      • QUERY_CHUNK_SIZE

        public static final java.lang.String QUERY_CHUNK_SIZE
        Specifies the query chunk size. This is header equivalent of global impex.query.chunk.size property and overwrites impex.query.chunk.size value if set.
        See Also:
        Constant Field Values

      • CSV_DECORATOR

        public static final java.lang.String CSV_DECORATOR
        Specifies a decorator class for modifying the cell value before interpreting.
        Type: cell modifier
        Attribute Type: All
        Possible values: A cell decorator class like 'de.hybris.platform.catalog.jalo.classification.eclass.EClassSuperCategoryDecorator'
        Default value: No decorator will be applied
        See Also:
        Constant Field Values

      • VIRTUAL

        public static final java.lang.String VIRTUAL
        If set, no cell value is expected. Has to be used in conjunction with 'default' modifier (ImpExConstants.Syntax.ModifierDEFAULT.
        Type: cell modifier
        Attribute Type: All
        Possible values: 'true' or 'false'
        Default value: 'false'
        See Also:
        Constant Field Values

      • IGNORE_KEY_CASE

        public static final java.lang.String IGNORE_KEY_CASE
        If set, the case of text which specifies attributes of items for resolving is ignored.
        Type: cell modifier
        Attribute Type: Item
        Possible values: 'true' or 'false'
        Default value: 'false'
        See Also:
        Constant Field Values

      • ALIAS

        public static final java.lang.String ALIAS
        With that modifier you can specify an alias name for an attribute which will be used in export case as attribute text in destination file. Is only used if not hybris export style is activated.
        Type: cell modifier
        Attribute Type: All
        Possible values: a text like 'myAttribute'
        Default value: No alias
        See Also:
        Constant Field Values

      • POSITION

        public static final java.lang.String POSITION
        Specifies the column position where the values of this attribute can be found. Attention: if this modifier is uesed for a attribute in a header description, then it has to be used for all attributes in that header for avoiding of conflicts.
        Type: cell modifier
        Attribute Type: All
        Possible values: a positive integer like '3'
        Default value: column number as positioned in header description
        See CORE-3557.
        See Also:
        Constant Field Values

      • FORCE_WRITE

        public static final java.lang.String FORCE_WRITE
        If set, read-only columns will be tried to processed. Success depends of business logic of attribute setter. If not set, an processing of read-only attributes will not be tried.
        Type: cell modifier
        Attribute Type: All
        Possible values: 'true' or 'false'
        Default value: 'false'
        See CORE-4054.
        See Also:
        Constant Field Values

      • IMPEX_LEGACY_MODE

        public static final java.lang.String IMPEX_LEGACY_MODE
        If set, impex will switch to legacy handling. Default value: false: means impex is relying on the configured handler (might be also legacy (jalo) or non legacy (Service layer))
        See Also:
        Constant Field Values

      • SLD_ENABLED

        public static final java.lang.String SLD_ENABLED
        If set, impex will use direct persistence (service layer direct) for import data. Used only in distributed impex mode.
        See Also:
        Constant Field Values

      • SOURCE_SYSTEM_ID

        public static final java.lang.String SOURCE_SYSTEM_ID
        SourceSystemID to perform lookup in.
        See Also:
        Constant Field Values

      • PK_FROM_EXTERNAL_IMPORT_KEY

        public static final java.lang.String PK_FROM_EXTERNAL_IMPORT_KEY
        Hint to ItemPKTranslator to look for PK in ExternalImportKey item.
        See Also:
        Constant Field Values

    • Constructor Detail

      • Modifier

        public Modifier()