org.odpi.openmetadata.accessservices.subjectarea.properties.enums

Enum KeyPattern

java.lang.Object

java.lang.Enum<KeyPattern>

org.odpi.openmetadata.accessservices.subjectarea.properties.enums.KeyPattern

All Implemented Interfaces:

Serializable, Comparable<KeyPattern>

public enum KeyPattern
extends Enum<KeyPattern>
implements Serializable

Defines the type of identifier used for an asset.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AggregateKey Key formed by combining keys from multiple systems.
CallersKey Key from another system can bey used if system name provided.
LocalKey Unique key allocated and used within the scope of a single system.
MirrorKey Key value copied from another system.
NaturalKey Key derived from an attribute of the entity, such as email address, passport number.
Other Another key pattern.
RecycledKey Key allocated and used within the scope of a single system that is periodically reused for different records.
StableKey Key value will remain active even if records are merged.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the description for the enum.
String	getName() Return the descriptive name for the KeyPattern enum instance
int	getOrdinal() Return the numerical value for the enum.
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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LocalKey

public static final KeyPattern LocalKey

Unique key allocated and used within the scope of a single system.

RecycledKey

public static final KeyPattern RecycledKey

Key allocated and used within the scope of a single system that is periodically reused for different records.

NaturalKey

public static final KeyPattern NaturalKey

Key derived from an attribute of the entity, such as email address, passport number.

MirrorKey

public static final KeyPattern MirrorKey

Key value copied from another system.

AggregateKey

public static final KeyPattern AggregateKey

Key formed by combining keys from multiple systems.

CallersKey

public static final KeyPattern CallersKey

Key from another system can bey used if system name provided.

StableKey

public static final KeyPattern StableKey

Key value will remain active even if records are merged.

Other

public static final KeyPattern Other

Another key pattern.

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 name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the numerical value for the enum.

Returns:

int enum value ordinal

getDescription

public String getDescription()

Return the description for the enum.

Returns:

String description

getName

public String getName()

Return the descriptive name for the KeyPattern enum instance

Returns:

String name