Package de.xima.fc.mdl.enums
Enum ECompressAsZipNamingScheme
- java.lang.Object
-
- java.lang.Enum<ECompressAsZipNamingScheme>
-
- de.xima.fc.mdl.enums.ECompressAsZipNamingScheme
-
- All Implemented Interfaces:
INamedUiElement
,Serializable
,Comparable<ECompressAsZipNamingScheme>
public enum ECompressAsZipNamingScheme extends Enum<ECompressAsZipNamingScheme> implements INamedUiElement
Enumeration with the possible values for how files are named when put into a ZIP archive. Used by the compress as ZIP action.- Since:
- 7.0.5
- Author:
- XIMA MEDIA GmbH
-
-
Enum Constant Summary
Enum Constants Enum Constant Description FLAT_FILE_NAME_ONLY
Uses the original file name for each file.FLAT_PREFIXED_WITH_SOURCE_NAME
The name of each file is prefixed with the name of the workflow action that produced the file.NESTED_WITH_NAMED_SOURCE
A sub directory is created based on the source of the file.NESTED_WITH_TECHNICAL_SOURCE
A sub directory is created based on the source of the file.
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
ATTR_DISPLAY_NAME
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDisplayName(Locale locale)
static ECompressAsZipNamingScheme
valueOf(String name)
Returns the enum constant of this type with the specified name.static ECompressAsZipNamingScheme[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
FLAT_FILE_NAME_ONLY
public static final ECompressAsZipNamingScheme FLAT_FILE_NAME_ONLY
Uses the original file name for each file. All files are put into the same directory. Conflicts are resolved by adding an incrementing number to the conflicting files.SubmissionXYZ.zip/FormData.xml SubmissionXYZ.zip/FormData_2.xml SubmissionXYZ.zip/Town map.pdf SubmissionXYZ.zip/Town map_2.pdf
-
FLAT_PREFIXED_WITH_SOURCE_NAME
public static final ECompressAsZipNamingScheme FLAT_PREFIXED_WITH_SOURCE_NAME
The name of each file is prefixed with the name of the workflow action that produced the file. The action name and file name are separated by a dash:[ACTION_NAME] - [FILE_NAME]
. All files are put into the same directory. Conflicts are resolved by adding an incrementing number to the conflicting files.SubmissionXYZ.zip/Export as XML - FormData.xml SubmissionXYZ.zip/Export as XML - FormData.xml SubmissionXYZ.zip/Upload upl1 - Town map.pdf SubmissionXYZ.zip/Upload upl2 - Town map.pdf
-
NESTED_WITH_NAMED_SOURCE
public static final ECompressAsZipNamingScheme NESTED_WITH_NAMED_SOURCE
A sub directory is created based on the source of the file. Uses a more human friendly name of the source, such as the name of the workflow action or the name of the upload field.SubmissionXYZ.zip/nodes/Export as XML/FormData.xml SubmissionXYZ.zip/nodes/Export as XML/FormData.xml SubmissionXYZ.zip/uploads/upl1/Town map.pdf SubmissionXYZ.zip/uploads/upl2/Town map.pdf
-
NESTED_WITH_TECHNICAL_SOURCE
public static final ECompressAsZipNamingScheme NESTED_WITH_TECHNICAL_SOURCE
A sub directory is created based on the source of the file. Uses the technical name of the source, such as the ID or UUID.SubmissionXYZ.zip/nodes/710/FormData.xml SubmissionXYZ.zip/nodes/712/FormData.xml SubmissionXYZ.zip/upload/2f80b5cb-27df-47b3-8b61-9a329eb66b0d/TownMap.pdf SubmissionXYZ.zip/uploads/08616c48-ce74-43cd-8399-0c3095eefd41/TownMap.pdf
-
-
Method Detail
-
values
public static ECompressAsZipNamingScheme[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ECompressAsZipNamingScheme c : ECompressAsZipNamingScheme.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ECompressAsZipNamingScheme valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getDisplayName
public String getDisplayName(Locale locale)
- Specified by:
getDisplayName
in interfaceINamedUiElement
- Returns:
- Wert, der das entsprechende Objekt an Oberfläche repräsentiert (wird i.A. zur Laufzeit ermittelt).
-
-