Package org.odpi.openmetadata.frameworks.governanceaction.properties

Enum Class OpenMetadataAttributeCardinality

java.lang.Object

java.lang.Enum<OpenMetadataAttributeCardinality>

org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataAttributeCardinality

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataAttributeCardinality>, Constable

public enum OpenMetadataAttributeCardinality
extends Enum<OpenMetadataAttributeCardinality>

OpenMetadataAttributeCardinality is used on an association from one OpenMetadataTypeDef to another. It defines how many instances the "linked to" OpenMetadataTypeDef are permitted to be connected to the "linked from" OpenMetadataTypeDef:

• UNKNOWN: uninitialized cardinality
• AT_MOST_ONE: means there can be zero or one instances connected to an instance of this OpenMetadataTypeDef. This relationship is often written as 0..1.
• ONE_ONLY: means there must be one instance, no more and no less.
• AT_LEAST_ONE_ORDERED: means there must be one or more instances connected to an instance of this OpenMetadataTypeDef. This relationship is often written as 1..*. The linked instances are maintained in an ordered list/array.
• AT_LEAST_ONE_UNORDERED: means there must be one or more instances connected to an instance of this OpenMetadataTypeDef. This relationship is often written as 1..*. The linked instances are maintained in an unordered set.
• ANY_NUMBER_ORDERED: means there can be none, one or many instances connected an instance of this OpenMetadataTypeDef. This relationship is often written as 0..*. The linked instances are maintained in an ordered list/array.
• ANY_NUMBER_UNORDERED: means there can be none, one or many instances connected an instance of this OpenMetadataTypeDef. This relationship is often written as 0..*. The linked instances are maintained in an unordered set.

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
ANY_NUMBER_ORDERED	0..* for any number of instances (stored in a specific order).
ANY_NUMBER_UNORDERED	0..* for any number of instances (stored in any order).
AT_LEAST_ONE_ORDERED	1..* for one or more instances (stored in specific order).
AT_LEAST_ONE_UNORDERED	1..* for one or more instances (stored in any order).
AT_MOST_ONE	0..1 for zero or one instances.
ONE_ONLY	1 for one instance, no more and no less.
UNKNOWN	Unknown or uninitialized cardinality.

Method Summary

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

Unknown or uninitialized cardinality.

AT_MOST_ONE

public static final OpenMetadataAttributeCardinality AT_MOST_ONE

0..1 for zero or one instances. 0..1.

ONE_ONLY

public static final OpenMetadataAttributeCardinality ONE_ONLY

1 for one instance, no more and no less.

AT_LEAST_ONE_ORDERED

public static final OpenMetadataAttributeCardinality AT_LEAST_ONE_ORDERED

1..* for one or more instances (stored in specific order).

AT_LEAST_ONE_UNORDERED

public static final OpenMetadataAttributeCardinality AT_LEAST_ONE_UNORDERED

1..* for one or more instances (stored in any order).

ANY_NUMBER_ORDERED

public static final OpenMetadataAttributeCardinality ANY_NUMBER_ORDERED

0..* for any number of instances (stored in a specific order).

ANY_NUMBER_UNORDERED

public static final OpenMetadataAttributeCardinality ANY_NUMBER_UNORDERED

0..* for any number of instances (stored in any order).

Method Details

values

public static OpenMetadataAttributeCardinality[] 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 OpenMetadataAttributeCardinality 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 cardinality.

Returns:

int ordinal

getName

public String getName()

Return the default name of the cardinality.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the cardinality.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<OpenMetadataAttributeCardinality>

Returns:

string description