Enum TableImportMode
- java.lang.Object
-
- java.lang.Enum<TableImportMode>
-
- com.redwood.scheduler.api.model.enumeration.TableImportMode
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<TableImportMode,Character>
,SchedulerEnumeration<TableImportMode>
,Serializable
,Comparable<TableImportMode>
public enum TableImportMode extends Enum<TableImportMode> implements SchedulerEnumeration<TableImportMode>
The import mode for a table. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ImportRows
Import rows from the archive with values of CHECK:newValue and leaving existing rows not in the archive in the database.ImportTable
Import the entire table from the archive, dropping existing rows.Merge
Similar to Import Rows but two rows with the same key will be merged taking the value from the car file.
-
Field Summary
Fields Modifier and Type Field Description static char
ImportRowsCode
The char returned from ImportRows.getCodeEx().static char
ImportTableCode
The char returned from ImportTable.getCodeEx().static char
MergeCode
The char returned from Merge.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description char
getCodeEx()
Get the code that is used to represent this enumeration in the database.Character
getCodeExCharacter()
Get the code that is used to represent this enumeration in the database.String
getCodeExString()
Get the code that is used to represent this enumeration in the database.Character
getCodeExValue()
Return the code for the enumeration item as the database type of this enumeration.String
getDescriptionKey()
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.String
getTranslationEN()
Get the English name of this enumeration.String
getTranslationKey()
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static TableImportMode
safeValueOf(String value)
Helper function to return the TableImportMode represented byvalue
.static TableImportMode
valueOf(char code)
Helper function to return the TableImportMode represented by code.static TableImportMode
valueOf(Character code)
Helper function to return the TableImportMode represented by code.static TableImportMode
valueOf(String name)
Returns the enum constant of this type with the specified name.static TableImportMode
valueOfCode(String code)
Helper function to return the TableImportMode represented by code.static TableImportMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
ImportRows
public static final TableImportMode ImportRows
Import rows from the archive with values of CHECK:newValue and leaving existing rows not in the archive in the database.
-
ImportTable
public static final TableImportMode ImportTable
Import the entire table from the archive, dropping existing rows.
-
Merge
public static final TableImportMode Merge
Similar to Import Rows but two rows with the same key will be merged taking the value from the car file.
-
-
Field Detail
-
ImportRowsCode
public static final char ImportRowsCode
The char returned from ImportRows.getCodeEx().- See Also:
ImportRows
, Constant Field Values
-
ImportTableCode
public static final char ImportTableCode
The char returned from ImportTable.getCodeEx().- See Also:
ImportTable
, Constant Field Values
-
MergeCode
public static final char MergeCode
The char returned from Merge.getCodeEx().- See Also:
Merge
, Constant Field Values
-
-
Method Detail
-
values
public static TableImportMode[] 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 (TableImportMode c : TableImportMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TableImportMode 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
-
valueOfCode
public static TableImportMode valueOfCode(String code)
Helper function to return the TableImportMode represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.- Parameters:
code
- A string with one character that is one of the codes for TableImportMode- Returns:
- The TableImportMode corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static TableImportMode safeValueOf(String value)
Helper function to return the TableImportMode represented byvalue
. Ifvalue
is null, or not a valid TableImportMode enumeration then this method will return null.The main difference between this method and
valueOf(String)
, is that this method will return null when passed an invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The TableImportMode corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static TableImportMode valueOf(Character code)
Helper function to return the TableImportMode represented by code. If code is null, or not a valid TableImportMode code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The TableImportMode corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static TableImportMode valueOf(char code)
Helper function to return the TableImportMode represented by code. If code is not a valid TableImportMode code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The TableImportMode corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerEnumeration<TableImportMode>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumeration
Return the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValue
in interfaceBaseSchedulerEnumeration<TableImportMode,Character>
- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacter
in interfaceSchedulerEnumeration<TableImportMode>
- Returns:
- the database code for the enumeration
-
getTranslationKey
public String getTranslationKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
getTranslationKey
in interfaceBaseSchedulerEnumeration<TableImportMode,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<TableImportMode,Character>
- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public String getDescriptionKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
getDescriptionKey
in interfaceBaseSchedulerEnumeration<TableImportMode,Character>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
getCodeExString
public String getCodeExString()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExString
in interfaceSchedulerEnumeration<TableImportMode>
- Returns:
- the database code for the enumeration
-
-