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

Enum Class SchemaAttributeCategory

java.lang.Object

java.lang.Enum<SchemaAttributeCategory>

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

All Implemented Interfaces:

Serializable, Comparable<SchemaAttributeCategory>, Constable

public enum SchemaAttributeCategory
extends Enum<SchemaAttributeCategory>
implements Serializable

SchemaAttributeCategory summarizes the category of a schema attribute based on its cardinality, ordering and uniques of values stored within it.

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
ARRAY	There may be multiple instances of this attribute.
BAG	There may be multiple instances of this attribute.
SET	There may be multiple instances of this attribute.
SINGLETON	There is at maximum, only one instance of the attribute.
UNKNOWN	The schema type is unknown.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for this enum.
String	getName()	Return the default name for this enum type.
int	getOrdinal()	Return the code for this enum used for indexing based on the enum value.
String	toString()	Standard toString method.
static SchemaAttributeCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SchemaAttributeCategory[]	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 SchemaAttributeCategory UNKNOWN

The schema type is unknown.

ARRAY

public static final SchemaAttributeCategory ARRAY

There may be multiple instances of this attribute. The instances are ordered and the same value may appear in different instances.

SET

public static final SchemaAttributeCategory SET

There may be multiple instances of this attribute. The instances are unordered and the same value can not appear in more than one instance.

BAG

public static final SchemaAttributeCategory BAG

There may be multiple instances of this attribute. The instances are unordered and the same value may appear in different instances.

SINGLETON

public static final SchemaAttributeCategory SINGLETON

There is at maximum, only one instance of the attribute.

Method Details

values

public static SchemaAttributeCategory[] 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 SchemaAttributeCategory 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 this enum used for indexing based on the enum value.

Returns:

int code number

getName

public String getName()

Return the default name for this enum type.

Returns:

String name

getDescription

public String getDescription()

Return the default description for this enum.

Returns:

String description

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<SchemaAttributeCategory>

Returns:

print out of variables in a JSON-style