Package org.odpi.openmetadata.frameworks.openmetadata.types

Enum Class DataType

java.lang.Object

java.lang.Enum<DataType>

org.odpi.openmetadata.frameworks.openmetadata.types.DataType

All Implemented Interfaces:

Serializable, Comparable<DataType>, Constable, OpenMetadataEnum

public enum DataType
extends Enum<DataType>
implements OpenMetadataEnum

DataType identifies the type for a data item.

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_INT	An ordered list of strings.
ARRAY_STRING	An ordered list of strings.
BIGDECIMAL	Big Decimal
BIGINTEGER	Big Integer
BOOLEAN	Boolean
BYTE	Byte
CHAR	Character
DATE	Date
DOUBLE	Double
FLOAT	Float
INT	Integer
LONG	Long
MAP_STRING_BOOLEAN	A map from string value to boolean value.
MAP_STRING_DATE	A map from string value to date value.
MAP_STRING_DOUBLE	A map from string value to double value.
MAP_STRING_INT	A map from string value to integer value.
MAP_STRING_LONG	A map from string value to long value.
MAP_STRING_OBJECT	A map from string value to date value.
MAP_STRING_STRING	A map from string value to string value.
OBJECT	A generic data type.
SHORT	Short
STRING	String

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STRING

public static final DataType STRING

String

INT

public static final DataType INT

Integer

LONG

public static final DataType LONG

Long

DATE

public static final DataType DATE

Date

BOOLEAN

public static final DataType BOOLEAN

Boolean

CHAR

public static final DataType CHAR

Character

BYTE

public static final DataType BYTE

Byte

FLOAT

public static final DataType FLOAT

Float

DOUBLE

public static final DataType DOUBLE

Double

BIGINTEGER

public static final DataType BIGINTEGER

Big Integer

BIGDECIMAL

public static final DataType BIGDECIMAL

Big Decimal

ARRAY_STRING

public static final DataType ARRAY_STRING

An ordered list of strings.

ARRAY_INT

public static final DataType ARRAY_INT

An ordered list of strings.

MAP_STRING_STRING

public static final DataType MAP_STRING_STRING

A map from string value to string value.

MAP_STRING_BOOLEAN

public static final DataType MAP_STRING_BOOLEAN

A map from string value to boolean value.

MAP_STRING_INT

public static final DataType MAP_STRING_INT

A map from string value to integer value.

MAP_STRING_LONG

public static final DataType MAP_STRING_LONG

A map from string value to long value.

MAP_STRING_DOUBLE

public static final DataType MAP_STRING_DOUBLE

A map from string value to double value.

MAP_STRING_DATE

public static final DataType MAP_STRING_DATE

A map from string value to date value.

MAP_STRING_OBJECT

public static final DataType MAP_STRING_OBJECT

A map from string value to date value.

SHORT

public static final DataType SHORT

Short

OBJECT

public static final DataType OBJECT

A generic data type.

Method Details

values

public static DataType[] 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 DataType 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 enumeration.

Specified by:

getOrdinal in interface OpenMetadataEnum

Returns:

int ordinal

getName

public String getName()

Return the default name of the enumeration.

Specified by:

getName in interface OpenMetadataEnum

Returns:

String name

getDescription

public String getDescription()

Return the default description of the enumeration.

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

getQualifiedName

public String getQualifiedName()

Return the qualified name for this value.

Returns:

string

getCategory

public String getCategory()

Return the category for this value.

Returns:

string

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<DataType>

Returns:

print out of variables in a JSON-style