Package org.odpi.openmetadata.frameworks.connectors.properties.beans

Enum Class KeyPattern

java.lang.Object
java.lang.Enum<KeyPattern>
org.odpi.openmetadata.frameworks.connectors.properties.beans.KeyPattern
All Implemented Interfaces:
Serializable, Comparable<KeyPattern>, Constable
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 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 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 class Enum<KeyPattern>
      Returns:
      print out of variables in a JSON-style