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 SummaryEnum Constants Enum Constant Description ImportRowsImport rows from the archive with values of CHECK:newValue and leaving existing rows not in the archive in the database.ImportTableImport the entire table from the archive, dropping existing rows.MergeSimilar to Import Rows but two rows with the same key will be merged taking the value from the car file.
 - 
Field SummaryFields Modifier and Type Field Description static charImportRowsCodeThe char returned from ImportRows.getCodeEx().static charImportTableCodeThe char returned from ImportTable.getCodeEx().static charMergeCodeThe char returned from Merge.getCodeEx().
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description chargetCodeEx()Get the code that is used to represent this enumeration in the database.CharactergetCodeExCharacter()Get the code that is used to represent this enumeration in the database.StringgetCodeExString()Get the code that is used to represent this enumeration in the database.CharactergetCodeExValue()Return the code for the enumeration item as the database type of this enumeration.StringgetDescriptionKey()Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.StringgetTranslationEN()Get the English name of this enumeration.StringgetTranslationKey()Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static TableImportModesafeValueOf(String value)Helper function to return the TableImportMode represented byvalue.static TableImportModevalueOf(char code)Helper function to return the TableImportMode represented by code.static TableImportModevalueOf(Character code)Helper function to return the TableImportMode represented by code.static TableImportModevalueOf(String name)Returns the enum constant of this type with the specified name.static TableImportModevalueOfCode(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.Enumclone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 - 
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumerationname, ordinal
 - 
Methods inherited from interface java.lang.ComparablecompareTo
 
- 
 
- 
- 
- 
Enum Constant Detail- 
ImportRowspublic 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.
 - 
ImportTablepublic static final TableImportMode ImportTable Import the entire table from the archive, dropping existing rows.
 - 
Mergepublic 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- 
ImportRowsCodepublic static final char ImportRowsCode The char returned from ImportRows.getCodeEx().- See Also:
- ImportRows, Constant Field Values
 
 - 
ImportTableCodepublic static final char ImportTableCode The char returned from ImportTable.getCodeEx().- See Also:
- ImportTable, Constant Field Values
 
 - 
MergeCodepublic static final char MergeCode The char returned from Merge.getCodeEx().- See Also:
- Merge, Constant Field Values
 
 
- 
 - 
Method Detail- 
valuespublic 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
 
 - 
valueOfpublic 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 name
- NullPointerException- if the argument is null
 
 - 
valueOfCodepublic 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
 
 - 
safeValueOfpublic static TableImportMode safeValueOf(String value) Helper function to return the TableImportMode represented byvalue. Ifvalueis 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, ifvalueis null, or not a valid enumeration
- See Also:
- valueOf(String)
 
 - 
valueOfpublic 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
 
 - 
valueOfpublic 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
 
 - 
getCodeExpublic char getCodeEx() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExin interface- SchedulerEnumeration<TableImportMode>
- Returns:
- the database code for the enumeration
 
 - 
getCodeExValuepublic Character getCodeExValue() Description copied from interface:BaseSchedulerEnumerationReturn the code for the enumeration item as the database type of this enumeration.- Specified by:
- getCodeExValuein interface- BaseSchedulerEnumeration<TableImportMode,Character>
- Returns:
- the enumeration code
 
 - 
getCodeExCharacterpublic Character getCodeExCharacter() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExCharacterin interface- SchedulerEnumeration<TableImportMode>
- Returns:
- the database code for the enumeration
 
 - 
getTranslationKeypublic String getTranslationKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
- getTranslationKeyin interface- BaseSchedulerEnumeration<TableImportMode,Character>
- Returns:
- the key.
 
 - 
getTranslationENpublic String getTranslationEN() Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
- getTranslationENin interface- BaseSchedulerEnumeration<TableImportMode,Character>
- Returns:
- the English name of this enumeration.
 
 - 
getDescriptionKeypublic String getDescriptionKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
- getDescriptionKeyin interface- BaseSchedulerEnumeration<TableImportMode,Character>
- Returns:
- the key that can be passed to
         SchedulerSession.translateField(String)to retrieve the translated description.
 
 - 
getCodeExStringpublic String getCodeExString() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExStringin interface- SchedulerEnumeration<TableImportMode>
- Returns:
- the database code for the enumeration
 
 
- 
 
-