Enum Class KeyPattern
- All Implemented Interfaces:
Serializable
,Comparable<KeyPattern>
,Constable
A KeyPattern defines the type of External Identifier in use for an asset, or the type of Primary Key used within an
asset.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionKey formed by combining keys from multiple systems.Key from another system can bey used if system name provided.Unique key allocated and used within the scope of a single system.Key value copied from another system.Key derived from an attribute of the entity, such as email address, passport number.Another key pattern.Key allocated and used within the scope of a single system that is periodically reused for different records.Key value will remain active even if records are merged. -
Method Summary
Modifier and TypeMethodDescriptionReturn the default description for the key pattern for this enum instance.getName()
Return the default name for this enum instance.Return the unique identifier for the open metadata enum type that this enum class represents.Return the unique name for the open metadata enum type that this enum class represents.int
Return the code for this enum that comes from the Open Metadata Type that this enum represents.int
Return the code for this enum instancetoString()
Standard toString method.static KeyPattern
Returns the enum constant of this class with the specified name.static KeyPattern[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
LOCAL_KEY
Unique key allocated and used within the scope of a single system. -
RECYCLED_KEY
Key allocated and used within the scope of a single system that is periodically reused for different records. -
NATURAL_KEY
Key derived from an attribute of the entity, such as email address, passport number. -
MIRROR_KEY
Key value copied from another system. -
AGGREGATE_KEY
Key formed by combining keys from multiple systems. -
CALLERS_KEY
Key from another system can bey used if system name provided. -
STABLE_KEY
Key value will remain active even if records are merged. -
OTHER
Another key pattern.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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
Return the default name for this enum instance.- Returns:
- String default name
-
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
Return the unique identifier for the open metadata enum type that this enum class represents.- Returns:
- string guid
-
getOpenTypeName
Return the unique name for the open metadata enum type that this enum class represents.- Returns:
- string name
-
toString
Standard toString method.- Overrides:
toString
in classEnum<KeyPattern>
- Returns:
- print out of variables in a JSON-style
-