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

Enum Class OpenMetadataCollectionDefCategory

java.lang.Object

java.lang.Enum<OpenMetadataCollectionDefCategory>

org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataCollectionDefCategory

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataCollectionDefCategory>, Constable

public enum OpenMetadataCollectionDefCategory
extends Enum<OpenMetadataCollectionDefCategory>
implements Serializable

This enum defines the list of open metadata collection types. These types are generic types that need to be configured with specific primitive types before they can be used as an attribute type.

The enum includes a code value, a string name for the type (used in self describing structures such as JSON or XML) and the name of the Java Class that supports this type.

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
OM_COLLECTION_ARRAY	An array of values of the same type.
OM_COLLECTION_MAP	A map from values of one type to another.
OM_COLLECTION_STRUCT	A record with a variety of values.
OM_COLLECTION_UNKNOWN	Unknown collection type

Method Summary

Modifier and Type	Method	Description
int	getArgumentCount()	Return the number of arguments for this collection type.
String	getJavaClassName()	Return the name of the java class that can be used to store properties of this type.
String	getName()	Return the name of type that can be used for text-based interchange formats such as JSON or XML.
int	getOrdinal()	Return the numeric code for the primitive type which can be used in optimized data flows.
String	toString()	toString() JSON-style
static OpenMetadataCollectionDefCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenMetadataCollectionDefCategory[]	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

OM_COLLECTION_UNKNOWN

public static final OpenMetadataCollectionDefCategory OM_COLLECTION_UNKNOWN

Unknown collection type

OM_COLLECTION_MAP

public static final OpenMetadataCollectionDefCategory OM_COLLECTION_MAP

A map from values of one type to another.

OM_COLLECTION_ARRAY

public static final OpenMetadataCollectionDefCategory OM_COLLECTION_ARRAY

An array of values of the same type.

OM_COLLECTION_STRUCT

public static final OpenMetadataCollectionDefCategory OM_COLLECTION_STRUCT

A record with a variety of values.

Method Details

values

public static OpenMetadataCollectionDefCategory[] 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 OpenMetadataCollectionDefCategory 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 code for the primitive type which can be used in optimized data flows.

Returns:

int type code

getName

public String getName()

Return the name of type that can be used for text-based interchange formats such as JSON or XML.

Returns:

String type name

getArgumentCount

public int getArgumentCount()

Return the number of arguments for this collection type.

Returns:

int number of elements

getJavaClassName

public String getJavaClassName()

Return the name of the java class that can be used to store properties of this type.

Returns:

String java class name.

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<OpenMetadataCollectionDefCategory>

Returns:

string description