de.aristaflow.adept2.model.orgmodel

Enum DataType

java.lang.Object

java.lang.Enum<DataType>

de.aristaflow.adept2.model.orgmodel.DataType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DataType>

public enum DataType
extends java.lang.Enum<DataType>

Enumeration that defines the allowed data types for the attributes of entity types.

INTEGER, FLOAT and STRING are the respective equivalents of ProcessConstants.AdeptDataType.INTEGER, ProcessConstants.AdeptDataType.FLOAT and ProcessConstants.AdeptDataType.STRING (see #fromAdeptDataType(AdeptDataType) and toAdeptDataType(DataType)).

If new DataTypes are added, isAssignableFrom(DataType), OrgModelTools.toPolicyToken(Object) and CmpOperator.canCompare(DataType, DataType) might have to be adapted, too.

Author:

Patrick Schmidt

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLOAT a Java double (or Double) which is equivalent to ProcessConstants.AdeptDataType.FLOAT
INTEGER a Java long (or Long) which is equivalent to ProcessConstants.AdeptDataType.INTEGER
NULL NULL is of course no real data type, but very useful in cases where attribute values should be unset (i.e. set to null) or compared to null.
STRING a Java String which is equivalent to ProcessConstants.AdeptDataType.STRING
TIMESTAMP a date + time in the format yyyy-MM-dd HH:mm:ss

Method Summary

Modifier and Type	Method and Description
java.lang.String	displayName() Returns a display name for this DataType.
static DataType	fromAdeptDataType(ProcessConstants.AdeptDataType adeptDataType) Returns the equivalent DataType for the specified ProcessConstants.AdeptDataType or null if there is none.
static DataType	getDataTypeForObject(java.lang.Object object) Returns the appropriate DataType for the given type of the object.
boolean	isAssignableFrom(DataType dataType) Returns whether the given data type can be assign to this data type.
boolean	isEnabled() Returns whether this data type is enabled in the system.
boolean	isNumber() Returns whether this DataType is a number type.
static ProcessConstants.AdeptDataType	toAdeptDataType(DataType dataType) Returns the equivalent ProcessConstants.AdeptDataType for the specified DataType or null if there is none.
static DataType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DataType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NULL

public static final DataType NULL

NULL is of course no real data type, but very useful in cases where attribute values should be unset (i.e. set to null) or compared to null. The actual data type of an attribute can NEVER be NULL.

INTEGER

public static final DataType INTEGER

a Java long (or Long) which is equivalent to ProcessConstants.AdeptDataType.INTEGER

FLOAT

public static final DataType FLOAT

a Java double (or Double) which is equivalent to ProcessConstants.AdeptDataType.FLOAT

STRING

public static final DataType STRING

a Java String which is equivalent to ProcessConstants.AdeptDataType.STRING

TIMESTAMP

public static final DataType TIMESTAMP

a date + time in the format yyyy-MM-dd HH:mm:ss

Method Detail

values

public static DataType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataType c : DataType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isEnabled

public boolean isEnabled()

Returns whether this data type is enabled in the system.

Returns:

whether this data type is enabled in the system

isNumber

public boolean isNumber()

Returns whether this DataType is a number type.

Returns:

whether this DataType is a number type

isAssignableFrom

public boolean isAssignableFrom(DataType dataType)

Returns whether the given data type can be assign to this data type. The main purpose of this method is to test whether a given value object is assignable to an attribute of this type, i.e. attributeType.isAssignableFrom(valueObjectType), in ModelChangeOperations.updateEntity(de.aristaflow.adept2.base.sessionmanagement.SessionToken, Entity). If dataType is NULL this method will return whether null can be assigned (which means that the attribute value will be unset).

Parameters:

dataType - the data type to test

Returns:

whether the given data type can be assign to this data type

displayName

public java.lang.String displayName()

Returns a display name for this DataType.

Returns:

a display name for this DataType

getDataTypeForObject

public static DataType getDataTypeForObject(java.lang.Object object)

Returns the appropriate DataType for the given type of the object. E.g. an Long-object will be mapped to INTEGER. If it can't be mapped, null will be returned. If the parameter is null, the NULL type will be returned.

Parameters:

object - the object whose type should be mapped to a DataType

Returns:

the determined DataType of the object or null if the object type couldn't be mapped

fromAdeptDataType

public static DataType fromAdeptDataType(ProcessConstants.AdeptDataType adeptDataType)

Returns the equivalent DataType for the specified ProcessConstants.AdeptDataType or null if there is none.

INTEGER, FLOAT and STRING are the respective equivalents of ProcessConstants.AdeptDataType.INTEGER, ProcessConstants.AdeptDataType.FLOAT and ProcessConstants.AdeptDataType.STRING.

Parameters:

adeptDataType - the ProcessConstants.AdeptDataType to be mapped

Returns:

the equivalent DataType

toAdeptDataType

public static ProcessConstants.AdeptDataType toAdeptDataType(DataType dataType)

Returns the equivalent ProcessConstants.AdeptDataType for the specified DataType or null if there is none.

INTEGER, FLOAT and STRING are the respective equivalents of ProcessConstants.AdeptDataType.INTEGER, ProcessConstants.AdeptDataType.FLOAT and ProcessConstants.AdeptDataType.STRING.

Parameters:

dataType - the DataType to be mapped

Returns:

the equivalent ProcessConstants.AdeptDataType