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

Enum Class ClassificationOrigin

java.lang.Object

java.lang.Enum<ClassificationOrigin>

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

All Implemented Interfaces:

Serializable, Comparable<ClassificationOrigin>, Constable

public enum ClassificationOrigin
extends Enum<ClassificationOrigin>

ClassificationOrigin describes the provenance of a classification attached to an entity. Most classifications are explicitly assigned to an entity. However, it is possible for some classifications to flow along relationships to other entities. These are the propagated classifications. Each entity can only have one classification of a certain type. A propagated classification can not override an assigned classification. Classifications can only be attached to entities of specific types. However a propagated classification can flow through an entity that does not support the particular type of classification and then on to other relationships attached to the entity. The ClassificationPropagateRule in the relationship's RelationshipDef defines where the classification can flow to.

Note: the repository services have no mechanism to automatically propagate classifications. This is set up by higher level services working with knowledge of the specific instance types of metadata and their significance.

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
ASSIGNED	The classification is explicitly assigned to the entity.
PROPAGATED	The classification has propagated along a relationship to this entity.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the classification origin.
String	getName()	Return the default name of the classification origin.
int	getOrdinal()	Return the numeric representation of the classification origin.
String	toString()	toString() JSON-style
static ClassificationOrigin	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ClassificationOrigin[]	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

ASSIGNED

public static final ClassificationOrigin ASSIGNED

The classification is explicitly assigned to the entity.

PROPAGATED

public static final ClassificationOrigin PROPAGATED

The classification has propagated along a relationship to this entity.

Method Details

values

public static ClassificationOrigin[] 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 ClassificationOrigin 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 classification origin.

Returns:

int ordinal

getName

public String getName()

Return the default name of the classification origin.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the classification origin.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<ClassificationOrigin>

Returns:

string description