Enum KeyPattern
- java.lang.Object
-
- java.lang.Enum<KeyPattern>
-
- org.odpi.openmetadata.accessservices.datamanager.properties.KeyPattern
-
- All Implemented Interfaces:
Serializable
,Comparable<KeyPattern>
public enum KeyPattern extends Enum<KeyPattern> implements Serializable
A KeyPattern defines the type of External Identifier in use for an asset, or the type of Primary Key used within an asset.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AGGREGATE_KEY
CALLERS_KEY
LOCAL_KEY
MIRROR_KEY
NATURAL_KEY
OTHER
RECYCLED_KEY
STABLE_KEY
-
Field Summary
Fields Modifier and Type Field Description static String
ENUM_TYPE_GUID
static String
ENUM_TYPE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
Return the default description for the key pattern for this enum instance.String
getName()
Return the default name for this enum instance.String
getOpenTypeGUID()
Return the unique identifier for the open metadata enum type that this enum class represents.String
getOpenTypeName()
Return the unique name for the open metadata enum type that this enum class represents.int
getOpenTypeOrdinal()
Return the code for this enum that comes from the Open Metadata Type that this enum represents.int
getOrdinal()
Return the code for this enum instanceString
toString()
Standard toString method.static KeyPattern
valueOf(String name)
Returns the enum constant of this type with the specified name.static KeyPattern[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
LOCAL_KEY
public static final KeyPattern LOCAL_KEY
-
RECYCLED_KEY
public static final KeyPattern RECYCLED_KEY
-
NATURAL_KEY
public static final KeyPattern NATURAL_KEY
-
MIRROR_KEY
public static final KeyPattern MIRROR_KEY
-
AGGREGATE_KEY
public static final KeyPattern AGGREGATE_KEY
-
CALLERS_KEY
public static final KeyPattern CALLERS_KEY
-
STABLE_KEY
public static final KeyPattern STABLE_KEY
-
OTHER
public static final KeyPattern OTHER
-
-
Field Detail
-
ENUM_TYPE_GUID
public static final String ENUM_TYPE_GUID
- See Also:
- Constant Field Values
-
ENUM_TYPE_NAME
public static final String ENUM_TYPE_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
values
public static KeyPattern[] 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 (KeyPattern c : KeyPattern.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static KeyPattern 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
-
getOrdinal
public int getOrdinal()
Return the code for this enum instance- Returns:
- int key pattern code
-
getName
public String getName()
Return the default name for this enum instance.- Returns:
- String default name
-
getDescription
public String getDescription()
Return the default description for the key pattern for this enum instance.- Returns:
- String default description
-
getOpenTypeOrdinal
public int getOpenTypeOrdinal()
Return the code for this enum that comes from the Open Metadata Type that this enum represents.- Returns:
- int code number
-
getOpenTypeGUID
public String getOpenTypeGUID()
Return the unique identifier for the open metadata enum type that this enum class represents.- Returns:
- string guid
-
getOpenTypeName
public String getOpenTypeName()
Return the unique name for the open metadata enum type that this enum class represents.- Returns:
- string name
-
toString
public String toString()
Standard toString method.- Overrides:
toString
in classEnum<KeyPattern>
- Returns:
- print out of variables in a JSON-style
-
-