Package org.odpi.openmetadata.frameworks.openmetadata.enums

Enum Class KeyPattern

java.lang.Object
java.lang.Enum<KeyPattern>
org.odpi.openmetadata.frameworks.openmetadata.enums.KeyPattern
All Implemented Interfaces:
Serializable, Comparable<KeyPattern>, Constable, OpenMetadataEnum
public enum KeyPattern extends Enum<KeyPattern> implements OpenMetadataEnum
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 Details

    • LOCAL_KEY

      public static final KeyPattern LOCAL_KEY
      Unique key allocated and used within the scope of a single system.

    • RECYCLED_KEY

      public static final KeyPattern RECYCLED_KEY
      Key allocated and used within the scope of a single system that is periodically reused for different records.

    • NATURAL_KEY

      public static final KeyPattern NATURAL_KEY
      Key derived from an attribute of the entity, such as email address, passport number.

    • MIRROR_KEY

      public static final KeyPattern MIRROR_KEY
      Key value copied from another system.

    • AGGREGATE_KEY

      public static final KeyPattern AGGREGATE_KEY
      Key formed by combining keys from multiple systems.

    • CALLERS_KEY

      public static final KeyPattern CALLERS_KEY
      Key from another system can bey used if system name provided.

    • STABLE_KEY

      public static final KeyPattern STABLE_KEY
      Key value will remain active even if records are merged.

    • OTHER

      public static final KeyPattern OTHER
      Another key pattern.

  • Method Details

    • values

      public static KeyPattern[] 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

      public static KeyPattern valueOf(String name)
      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 name
      NullPointerException - if the argument is null

    • getOrdinal

      public int getOrdinal()
      Return the numeric representation of the enumeration.
      Specified by:
      getOrdinal in interface OpenMetadataEnum
      Returns:
      int ordinal

    • getName

      public String getName()
      Return the default name of the enumeration.
      Specified by:
      getName in interface OpenMetadataEnum
      Returns:
      String name

    • getDescription

      public String getDescription()
      Return the default description of the enumeration.
      Specified by:
      getDescription in interface OpenMetadataEnum
      Returns:
      String description

    • getDescriptionGUID

      public String getDescriptionGUID()
      Return the unique identifier for the valid value that represents the enum value.
      Specified by:
      getDescriptionGUID in interface OpenMetadataEnum
      Returns:
      guid

    • isDefault

      public boolean isDefault()
      Return whether the enum is the default value or not.
      Specified by:
      isDefault in interface OpenMetadataEnum
      Returns:
      boolean

    • getOpenTypeGUID

      public static String getOpenTypeGUID()
      Return the unique identifier for the open metadata enum type that this enum class represents.
      Returns:
      string guid

    • getOpenTypeName

      public static String getOpenTypeName()
      Return the unique name for the open metadata enum type that this enum class represents.
      Returns:
      string name

    • getOpenTypeDescription

      public static String getOpenTypeDescription()
      Return the description for the open metadata enum type that this enum class represents.
      Returns:
      string description

    • getOpenTypeDescriptionGUID

      public static String getOpenTypeDescriptionGUID()
      Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
      Returns:
      string guid

    • getOpenTypeDescriptionWiki

      public static String getOpenTypeDescriptionWiki()
      Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
      Returns:
      string guid

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Enum<KeyPattern>
      Returns:
      print out of variables in a JSON-style