Class ImpExConstants.Syntax
java.lang.Object
de.hybris.platform.impex.constants.ImpExConstants.Syntax
- Enclosing class:
- ImpExConstants
Contains all constants which are used for ImpEx syntax.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classDefines the constant strings for all code markers allowed in script and used by ImpEx.static final classContains all supported header modes.static final classDeclares the allowed set of modifiers. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThis prefix indicates absolute file path.
Example:zip:c:\demo.zip&demo1.jpgstatic final charSeparates alternative expressions.static final charSeparates attributes in item expression patterns.static final StringIndicates a bean shell line (contains java statements).static final charIndicates the end of an item pattern expression.static final StringThis prefix of a element in a collection value indicates, that the element will be added to the existing resolved collection.static final Stringstatic final StringThis prefix of a element in a collection value indicates, that the element will be removed from the existing resolved collection.static final StringIf this mode is set at modifierImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE, the elements of the given collection value will be added to the existing resolved collection.static final StringIf this mode is set at modifierImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE, the elements of the given collection value will be added to the existing resolved collection, but only if they are not already part of the collection.static final StringIf this mode is set at modifierImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE, the elements of the given collection value will be removed from the existing resolved collection.static final charSeaparates the part of a standard date range value.static final charDefault separator for giving item expressions in value lines like 'bath:Online:Default' for item expression '(code,catalog(id)catalogVersion(code))'.static final charSee CORE-3347, CORE-3348 --> CORE-3378 !static final StringSpecifies the default delimiter for separating a key - value pair at map values.static final charSpecifies the default delimiter for separating key - value pairs at map values.static final StringIndicates a definition line or definition usage.static final StringIndicates a whole document ID column or an item expression using the document id for referencing.static final StringIndicates the end of a UserRight import block.static final StringMarks a value as to ignore.static final StringThis prefix indicates an jar based path.
Example:jar:ystorefoundationpackage.jalo.YStoreFoundationManager&/media/jeans/demo2.jpgstatic final StringIndicates the type of the key when specifying a map.static final charMarks the end of modifier definitions.
CAUTION: '[' and ']' will be interpreted as a regular expression when calling stuff likeString.replaceAll(String, String)static final charSeparates key and value of a modifier definition.static final charCharacter used for quotation within a modifier value.static final charSeparates modifiers defined in same modifier definition block (enclosed byMODIFIER_STARTandMODIFIER_END.static final charMarks the start of modifier definitions.
CAUTION: '[' and ']' will be interpreted as a regular expression when calling stuff likeString.replaceAll(String, String)static final StringSpecial item reference value for using NULL value for looking up items.static final charIndicates the start of an item pattern expression.static final StringIndicates a special column.static final StringIndicates the start of a UserRight import block.static final StringThis prefix indicates an url based path.
Example:http:http://www.company.com/pictures/logo.gifstatic final StringIndicates the type of the value when specifying a map.static final StringThis prefix indicates an zip based path.
Example:file:c:\demo4.jpg -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
MODIFIER_START
public static final char MODIFIER_STARTMarks the start of modifier definitions.
CAUTION: '[' and ']' will be interpreted as a regular expression when calling stuff likeString.replaceAll(String, String)- See Also:
-
MODIFIER_END
public static final char MODIFIER_ENDMarks the end of modifier definitions.
CAUTION: '[' and ']' will be interpreted as a regular expression when calling stuff likeString.replaceAll(String, String)- See Also:
-
MODIFIER_SEPARATOR
public static final char MODIFIER_SEPARATORSeparates modifiers defined in same modifier definition block (enclosed byMODIFIER_STARTandMODIFIER_END.- See Also:
-
MODIFIER_EQUAL
public static final char MODIFIER_EQUALSeparates key and value of a modifier definition.- See Also:
-
MODIFIER_QUOTE_CHAR
public static final char MODIFIER_QUOTE_CHARCharacter used for quotation within a modifier value.- See Also:
-
OPEN
public static final char OPENIndicates the start of an item pattern expression.- See Also:
-
CLOSE
public static final char CLOSEIndicates the end of an item pattern expression.- See Also:
-
ALTERNATIVE_PATTERN_SEPARATOR
public static final char ALTERNATIVE_PATTERN_SEPARATORSeparates alternative expressions.- See Also:
-
ATTRIBUTE_SEPARATOR
public static final char ATTRIBUTE_SEPARATORSeparates attributes in item expression patterns.- See Also:
-
DEFAULT_ATTRIBUTE_PATH_SEPARATOR
public static final char DEFAULT_ATTRIBUTE_PATH_SEPARATORDefault separator for giving item expressions in value lines like 'bath:Online:Default' for item expression '(code,catalog(id)catalogVersion(code))'.- See Also:
-
KEY_PATTERN
Indicates the type of the key when specifying a map.- See Also:
-
VALUE_PATTERN
Indicates the type of the value when specifying a map.- See Also:
-
DEFAULT_MAP_VALUE_DELIMITER
public static final char DEFAULT_MAP_VALUE_DELIMITERSpecifies the default delimiter for separating key - value pairs at map values.- See Also:
-
DEFAULT_KEY_2_VALUE_DELIMITER
Specifies the default delimiter for separating a key - value pair at map values.- See Also:
-
COLLECTION_VALUE_MODE_APPEND
If this mode is set at modifierImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE, the elements of the given collection value will be added to the existing resolved collection.- See Also:
-
COLLECTION_VALUE_MODE_REMOVE
If this mode is set at modifierImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE, the elements of the given collection value will be removed from the existing resolved collection.- See Also:
-
COLLECTION_VALUE_MODE_MERGE
If this mode is set at modifierImpExConstants.Syntax.Modifier.COLLECTION_VALUE_MODE, the elements of the given collection value will be added to the existing resolved collection, but only if they are not already part of the collection.- See Also:
-
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:
-
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:
-
COLLECTION_MERGE_PREFIX
- See Also:
-
DEFAULT_COLLECTION_VALUE_DELIMITER
public static final char DEFAULT_COLLECTION_VALUE_DELIMITERSee CORE-3347, CORE-3348 --> CORE-3378 !- See Also:
-
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 containingEND_USERRIGHTS.- See Also:
-
END_USERRIGHTS
Indicates the end of a UserRight import block. This constant has to be a single line.- See Also:
-
DATERANGE_DELIMITER
public static final char DATERANGE_DELIMITERSeaparates the part of a standard date range value.- See Also:
-
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:
-
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:
-
DOCUMENT_ID_PREFIX
Indicates a whole document ID column or an item expression using the document id for referencing. See CORE-3870.- See Also:
-
SPECIAL_COLUMN_PREFIX
Indicates a special column.
Caution: MS Excel doesn't like '@', see CORE-3350.- See Also:
-
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:
-
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:
-
ABSOLUTE_FILE_PATH_PREFIX
This prefix indicates absolute file path.
Example:zip:c:\demo.zip&demo1.jpg- See Also:
-
URL_BASED_FILE_PATH_PREFIX
This prefix indicates an url based path.
Example:http:http://www.company.com/pictures/logo.gif- See Also:
-
JAR_BASED_FILE_PATH_PREFIX
This prefix indicates an jar based path.
Example:jar:ystorefoundationpackage.jalo.YStoreFoundationManager&/media/jeans/demo2.jpg- See Also:
-
ZIP_BASED_FILE_PATH_PREFIX
This prefix indicates an zip based path.
Example:file:c:\demo4.jpg- See Also:
-
-
Constructor Details
-
Syntax
public Syntax()
-