ImpExConstants.Syntax (hybris Commerce Suite 18.11)

java.lang.Object
- de.hybris.platform.impex.constants.ImpExConstants.Syntax

Enclosing class:

ImpExConstants
```
public static final class ImpExConstants.Syntax
extends java.lang.Object
```
Contains all constants which are used for ImpEx syntax.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImpExConstants.Syntax.CodeMarkers` Defines the constant strings for all code markers allowed in script and used by ImpEx.
`static class`	`ImpExConstants.Syntax.Mode` Contains all supported header modes.
`static class`	`ImpExConstants.Syntax.Modifier` Declares the allowed set of modifiers.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ABSOLUTE_FILE_PATH_PREFIX` This prefix indicates absolute file path. Example: `zip:c:\demo.zip&demo1.jpg`
`static char`	`ALTERNATIVE_PATTERN_SEPARATOR` Separates alternative expressions.
`static char`	`ATTRIBUTE_SEPARATOR` Separates attributes in item expression patterns.
`static java.lang.String`	`BEANSHELL_PREFIX` Indicates a bean shell line (contains java statements).
`static char`	`CLOSE` Indicates the end of an item pattern expression.
`static java.lang.String`	`COLLECTION_APPEND_PREFIX` This prefix of a element in a collection value indicates, that the element will be added to the existing resolved collection.
`static java.lang.String`	`COLLECTION_REMOVE_PREFIX` This prefix of a element in a collection value indicates, that the element will be removed from the existing resolved collection.
`static java.lang.String`	`COLLECTION_VALUE_MODE_APPEND` If this mode is set at modifier `ImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE`, the elements of the given collection value will be added to the existing resolved collection.
`static java.lang.String`	`COLLECTION_VALUE_MODE_REMOVE` If this mode is set at modifier `ImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE`, the elements of the given collection value will be removed from the existing resolved collection.
`static char`	`DATERANGE_DELIMITER` Seaparates the part of a standard date range value.
`static char`	`DEFAULT_ATTRIBUTE_PATH_SEPARATOR` Default separator for giving item expressions in value lines like 'bath:Online:Default' for item expression '(code,catalog(id)catalogVersion(code))'.
`static char`	`DEFAULT_COLLECTION_VALUE_DELIMITER` See CORE-3347, CORE-3348 --> CORE-3378 !
`static java.lang.String`	`DEFAULT_KEY_2_VALUE_DELIMITER` Specifies the default delimiter for separating a key - value pair at map values.
`static char`	`DEFAULT_MAP_VALUE_DELIMITER` Specifies the default delimiter for separating key - value pairs at map values.
`static java.lang.String`	`DEFINITION_PREFIX` Indicates a definition line or definition usage.
`static java.lang.String`	`DOCUMENT_ID_PREFIX` Indicates a whole document ID column or an item expression using the document id for referencing.
`static java.lang.String`	`END_USERRIGHTS` Indicates the end of a UserRight import block.
`static java.lang.String`	`IGNORE_PREFIX` Marks a value as to ignore.
`static java.lang.String`	`JAR_BASED_FILE_PATH_PREFIX` This prefix indicates an jar based path. Example: `jar:ystorefoundationpackage.jalo.YStoreFoundationManager&/media/jeans/demo2.jpg`
`static java.lang.String`	`KEY_PATTERN` Indicates the type of the key when specifying a map.
`static char`	`MODIFIER_END` Marks the end of modifier definitions. CAUTION: '[' and ']' will be interpreted as a regular expression when calling stuff like `String.replaceAll(String, String)`
`static char`	`MODIFIER_EQUAL` Separates key and value of a modifier definition.
`static char`	`MODIFIER_QUOTE_CHAR` Character used for quotation within a modifier value.
`static char`	`MODIFIER_SEPARATOR` Separates modifiers defined in same modifier definition block (enclosed by `MODIFIER_START` and `MODIFIER_END`.
`static char`	`MODIFIER_START` Marks the start of modifier definitions. CAUTION: '[' and ']' will be interpreted as a regular expression when calling stuff like `String.replaceAll(String, String)`
`static java.lang.String`	`NULL_REF` Special item reference value for using NULL value for looking up items.
`static char`	`OPEN` Indicates the start of an item pattern expression.
`static java.lang.String`	`SPECIAL_COLUMN_PREFIX` Indicates a special column.
`static java.lang.String`	`START_USERRIGHTS` Indicates the start of a UserRight import block.
`static java.lang.String`	`URL_BASED_FILE_PATH_PREFIX` This prefix indicates an url based path. Example: `http:http://www.company.com/pictures/logo.gif`
`static java.lang.String`	`VALUE_PATTERN` Indicates the type of the value when specifying a map.
`static java.lang.String`	`ZIP_BASED_FILE_PATH_PREFIX` This prefix indicates an zip based path. Example: `file:c:\demo4.jpg`

Constructor Summary

Constructors
Constructor and Description

Syntax()

Constructors
Constructor and Description
`Syntax()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MODIFIER_START
```
public static final char MODIFIER_START
```
    Marks the start of modifier definitions.
    CAUTION: '[' and ']' will be interpreted as a regular expression when calling stuff like String.replaceAll(String, String)
    
    See Also:
    
    Constant Field Values
  - MODIFIER_END
```
public static final char MODIFIER_END
```
    Marks the end of modifier definitions.
    CAUTION: '[' and ']' will be interpreted as a regular expression when calling stuff like String.replaceAll(String, String)
    
    See Also:
    
    Constant Field Values
  - MODIFIER_SEPARATOR
```
public static final char MODIFIER_SEPARATOR
```
    Separates modifiers defined in same modifier definition block (enclosed by MODIFIER_START and MODIFIER_END.
    
    See Also:
    
    Constant Field Values
  - MODIFIER_EQUAL
```
public static final char MODIFIER_EQUAL
```
    Separates key and value of a modifier definition.
    
    See Also:
    
    Constant Field Values
  - MODIFIER_QUOTE_CHAR
```
public static final char MODIFIER_QUOTE_CHAR
```
    Character used for quotation within a modifier value.
    
    See Also:
    
    Constant Field Values
  - OPEN
```
public static final char OPEN
```
    Indicates the start of an item pattern expression.
    
    See Also:
    
    Constant Field Values
  - CLOSE
```
public static final char CLOSE
```
    Indicates the end of an item pattern expression.
    
    See Also:
    
    Constant Field Values
  - ALTERNATIVE_PATTERN_SEPARATOR
```
public static final char ALTERNATIVE_PATTERN_SEPARATOR
```
    Separates alternative expressions.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_SEPARATOR
```
public static final char ATTRIBUTE_SEPARATOR
```
    Separates attributes in item expression patterns.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ATTRIBUTE_PATH_SEPARATOR
```
public static final char DEFAULT_ATTRIBUTE_PATH_SEPARATOR
```
    Default separator for giving item expressions in value lines like 'bath:Online:Default' for item expression '(code,catalog(id)catalogVersion(code))'.
    
    See Also:
    
    Constant Field Values
  - KEY_PATTERN
```
public static final java.lang.String KEY_PATTERN
```
    Indicates the type of the key when specifying a map.
    
    See Also:
    
    Constant Field Values
  - VALUE_PATTERN
```
public static final java.lang.String VALUE_PATTERN
```
    Indicates the type of the value when specifying a map.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAP_VALUE_DELIMITER
```
public static final char DEFAULT_MAP_VALUE_DELIMITER
```
    Specifies the default delimiter for separating key - value pairs at map values.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_KEY_2_VALUE_DELIMITER
```
public static final java.lang.String DEFAULT_KEY_2_VALUE_DELIMITER
```
    Specifies the default delimiter for separating a key - value pair at map values.
    
    See Also:
    
    Constant Field Values
  - COLLECTION_VALUE_MODE_APPEND
```
public static final java.lang.String COLLECTION_VALUE_MODE_APPEND
```
    If this mode is set at modifier ImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE, the elements of the given collection value will be added to the existing resolved collection.
    
    See Also:
    
    Constant Field Values
  - COLLECTION_VALUE_MODE_REMOVE
```
public static final java.lang.String COLLECTION_VALUE_MODE_REMOVE
```
    If this mode is set at modifier ImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE, the elements of the given collection value will be removed from the existing resolved collection.
    
    See Also:
    
    Constant Field Values
  - COLLECTION_APPEND_PREFIX
```
public static final java.lang.String COLLECTION_APPEND_PREFIX
```
    This prefix of a element in a collection value indicates, that the element will be added to the existing resolved collection.
    
    See Also:
    
    Constant Field Values
  - COLLECTION_REMOVE_PREFIX
```
public static final java.lang.String COLLECTION_REMOVE_PREFIX
```
    This prefix of a element in a collection value indicates, that the element will be removed from the existing resolved collection.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COLLECTION_VALUE_DELIMITER
```
public static final char DEFAULT_COLLECTION_VALUE_DELIMITER
```
    See CORE-3347, CORE-3348 --> CORE-3378 !
    
    See Also:
    
    Constant Field Values
  - START_USERRIGHTS
```
public static final java.lang.String START_USERRIGHTS
```
    Indicates the start of a UserRight import block. This constant has to be a single line followed by the UserRight imports and closed with a single line containing END_USERRIGHTS.
    
    See Also:
    
    Constant Field Values
  - END_USERRIGHTS
```
public static final java.lang.String END_USERRIGHTS
```
    Indicates the end of a UserRight import block. This constant has to be a single line.
    
    See Also:
    
    Constant Field Values
  - DATERANGE_DELIMITER
```
public static final char DATERANGE_DELIMITER
```
    Seaparates the part of a standard date range value.
    
    See Also:
    
    Constant Field Values
  - BEANSHELL_PREFIX
```
public static final java.lang.String BEANSHELL_PREFIX
```
    Indicates a bean shell line (contains java statements). A bean shell line has to start with the used comment char followed by this bean shell prefix.
    
    See Also:
    
    Constant Field Values
  - DEFINITION_PREFIX
```
public static final java.lang.String DEFINITION_PREFIX
```
    Indicates a definition line or definition usage. A definition line starts with this definition prefix and declares a definition. A definition is like a macro where a script block can be named and later be pasted by using the name also with this prefix.
    For example:
    $myDefinition=This is my definition This is my script text where use my definition with $myDefinition
    This script will be translated to:
    This is my script text where use my definition with This is my definition
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_ID_PREFIX
```
public static final java.lang.String DOCUMENT_ID_PREFIX
```
    Indicates a whole document ID column or an item expression using the document id for referencing. See CORE-3870.
    
    See Also:
    
    Constant Field Values
  - SPECIAL_COLUMN_PREFIX
```
public static final java.lang.String SPECIAL_COLUMN_PREFIX
```
    Indicates a special column.
    Caution: MS Excel doesn't like '@', see CORE-3350.
    
    See Also:
    
    Constant Field Values
  - IGNORE_PREFIX
```
public static final java.lang.String IGNORE_PREFIX
```
    Marks a value as to ignore. Simply write this string at the start of the value and it will be skipped at processing.
    
    See Also:
    
    Constant Field Values
  - NULL_REF
```
public static final java.lang.String NULL_REF
```
    Special item reference value for using NULL value for looking up items. For instance p123::foo would interprete the middle value as NULL leading to a IS NULL query.
    
    See Also:
    
    Constant Field Values
  - ABSOLUTE_FILE_PATH_PREFIX
```
public static final java.lang.String ABSOLUTE_FILE_PATH_PREFIX
```
    This prefix indicates absolute file path.
    Example: zip:c:\demo.zip&demo1.jpg
    
    See Also:
    
    Constant Field Values
  - URL_BASED_FILE_PATH_PREFIX
```
public static final java.lang.String URL_BASED_FILE_PATH_PREFIX
```
    This prefix indicates an url based path.
    Example: http:http://www.company.com/pictures/logo.gif
    
    See Also:
    
    Constant Field Values
  - JAR_BASED_FILE_PATH_PREFIX
```
public static final java.lang.String JAR_BASED_FILE_PATH_PREFIX
```
    This prefix indicates an jar based path.
    Example: jar:ystorefoundationpackage.jalo.YStoreFoundationManager&/media/jeans/demo2.jpg
    
    See Also:
    
    Constant Field Values
  - ZIP_BASED_FILE_PATH_PREFIX
```
public static final java.lang.String ZIP_BASED_FILE_PATH_PREFIX
```
    This prefix indicates an zip based path.
    Example: file:c:\demo4.jpg
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Syntax
```
public Syntax()
```

Class ImpExConstants.Syntax

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODIFIER_START

MODIFIER_END

MODIFIER_SEPARATOR

MODIFIER_EQUAL

MODIFIER_QUOTE_CHAR

OPEN

CLOSE

ALTERNATIVE_PATTERN_SEPARATOR

ATTRIBUTE_SEPARATOR

DEFAULT_ATTRIBUTE_PATH_SEPARATOR

KEY_PATTERN

VALUE_PATTERN

DEFAULT_MAP_VALUE_DELIMITER

DEFAULT_KEY_2_VALUE_DELIMITER

COLLECTION_VALUE_MODE_APPEND

COLLECTION_VALUE_MODE_REMOVE

COLLECTION_APPEND_PREFIX

COLLECTION_REMOVE_PREFIX

DEFAULT_COLLECTION_VALUE_DELIMITER

START_USERRIGHTS

END_USERRIGHTS

DATERANGE_DELIMITER

BEANSHELL_PREFIX

DEFINITION_PREFIX

DOCUMENT_ID_PREFIX

SPECIAL_COLUMN_PREFIX

IGNORE_PREFIX

NULL_REF

ABSOLUTE_FILE_PATH_PREFIX

URL_BASED_FILE_PATH_PREFIX

JAR_BASED_FILE_PATH_PREFIX

ZIP_BASED_FILE_PATH_PREFIX

Constructor Detail

Syntax