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

Enum Class ElementOriginCategory

java.lang.Object

java.lang.Enum<ElementOriginCategory>

org.odpi.openmetadata.frameworks.openmetadata.enums.ElementOriginCategory

All Implemented Interfaces:

Serializable, Comparable<ElementOriginCategory>, Constable, OpenMetadataEnum

public enum ElementOriginCategory
extends Enum<ElementOriginCategory>
implements OpenMetadataEnum

ElementOriginCategory defines where the metadata comes from.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONFIGURATION	The element is part of a service's configuration.
CONTENT_PACK	The element comes from an open metadata content pack.
DEREGISTERED_REPOSITORY	The element comes from a metadata repository that used to be a member of the one of the local repository's cohorts, but it has been deregistered.
EXPORT_ARCHIVE	The element was created from an export archive.
EXTERNAL_SOURCE	The element is maintained by an external technology.
LOCAL_COHORT	The element is being maintained within one of the local cohort members.
UNKNOWN	Unknown provenance.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of the metadata element origin.
String	getDescriptionGUID()	Return the unique identifier for the valid value that represents the enum value.
String	getName()	Return the name of the metadata element origin.
int	getOrdinal()	Return the code for metadata element.
boolean	isDefault()	Return whether the enum is the default value or not.
String	toString()	Standard toString method.
static ElementOriginCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ElementOriginCategory[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final ElementOriginCategory UNKNOWN

Unknown provenance.

LOCAL_COHORT

public static final ElementOriginCategory LOCAL_COHORT

The element is being maintained within one of the local cohort members. The metadata collection id is for one of the repositories in the cohort. This metadata collection id identifies the home repository for this element.

EXPORT_ARCHIVE

public static final ElementOriginCategory EXPORT_ARCHIVE

The element was created from an export archive. The metadata collection id for the element is the metadata collection id of the originating server. If the originating server later joins the cohort with the same metadata collection id then these elements will be refreshed from the originating server's current repository.

CONTENT_PACK

public static final ElementOriginCategory CONTENT_PACK

The element comes from an open metadata content pack. The metadata collection id of the elements is set to the GUID of the pack.

DEREGISTERED_REPOSITORY

public static final ElementOriginCategory DEREGISTERED_REPOSITORY

The element comes from a metadata repository that used to be a member of the one of the local repository's cohorts, but it has been deregistered. The metadata collection id remains the same. If the repository rejoins the cohort then these elements can be refreshed from the rejoining repository.

CONFIGURATION

public static final ElementOriginCategory CONFIGURATION

The element is part of a service's configuration. The metadata collection id is null.

EXTERNAL_SOURCE

public static final ElementOriginCategory EXTERNAL_SOURCE

The element is maintained by an external technology. The metadata collection id is the guid of the technology's descriptive entity.

Method Details

values

public static ElementOriginCategory[] 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 ElementOriginCategory 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 metadata element.

Specified by:

getOrdinal in interface OpenMetadataEnum

Returns:

int code for the origin

getName

public String getName()

Return the name of the metadata element origin.

Specified by:

getName in interface OpenMetadataEnum

Returns:

String name

getDescription

public String getDescription()

Return the description of the metadata element origin.

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

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<ElementOriginCategory>

Returns:

print out of variables in a JSON-style