DataType (Tentackle Data Model 2.0.4 API)

java.lang.Object
- java.lang.Enum<DataType>
- - org.tentackle.model.DataType

All Implemented Interfaces:

Serializable, Comparable<DataType>
```
public enum DataType
extends Enum<DataType>
```
The data type.

Author:

harald

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataType.SqlTypeWithPostfix
Pair of SqlType and its name postfix.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataType.SqlTypeWithPostfix` Pair of SqlType and its name postfix.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPLICATION` Application specific type. Such types are immutable because they just convert data between internal and external representation.
`BIGDECIMAL` A `BigDecimal`.
`BINARY` A `Binary` (tentackle type).
`BMONEY` A `BMoney` (tentackle type).
`BOOLEAN` A `Boolean`.
`BOOLEAN_PRIMITIVE` A boolean (primitive).
`BYTE` A `Byte`.
`BYTE_PRIMITIVE` A byte (primitive).
`CHARACTER` A `Character`.
`CHARACTER_PRIMITIVE` A char (primitive).
`DATE` A `Date`.
`DMONEY` A `DMoney` (tentackle type).
`DOUBLE` A `Double`.
`DOUBLE_PRIMITIVE` A double (primitive).
`FLOAT` A `Float`.
`FLOAT_PRIMITIVE` A float (primitive).
`INTEGER` A `Integer`.
`INTEGER_PRIMITIVE` An int (primitive).
`LONG` A `Long`.
`LONG_PRIMITIVE` A long (primitive).
`SHORT` A `Short`.
`SHORT_PRIMITIVE` A short (primitive).
`STRING` A `String`.
`TIME` A `Time`.
`TIMESTAMP` A `Timestamp`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DataType`	`createFromJavaType(String javaType)` Creates a datatype from a java type string.
`SqlType[]`	`getSqlTypes()` Gets the sql type. Notice that a tentackle type may be mapped to more than one column for multi-column types such as BMoney.
`DataType.SqlTypeWithPostfix[]`	`getSqlTypesWithPostfix()` Gets the SqlTypes along with their column name postfixes.
`boolean`	`isBool()` Returns whether this is a boolean or Boolean type.
`boolean`	`isDateOrTime()` Returns whether this is a date and/or time type.
`boolean`	`isMultiColumn()` True if this is a multicolumn type.
`boolean`	`isMutable()` Returns whether type is a mutable java object. Mutable objects may change their state.
`boolean`	`isNumeric()` Returns whether this is a numeric type.
`boolean`	`isPrimitive()` Returns whether type is a primitive.
`boolean`	`isScaleInSecondColumn()` Returns whether this is a numeric type with the scale stored in a second column.
`Object`	`parse(String str)` Parses a string and converts to the value of this type.
`DataType`	`toNonPrimitive()` Converts a primitive to a Java class.
`DataType`	`toPrimitive()` Converts to a Java primitive.
`String`	`toString()`
`static DataType`	`valueOf(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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - STRING
```
public static final DataType STRING
```
    A String.
  - DATE
```
public static final DataType DATE
```
    A Date.
  - TIME
```
public static final DataType TIME
```
    A Time.
  - TIMESTAMP
```
public static final DataType TIMESTAMP
```
    A Timestamp.
  - BINARY
```
public static final DataType BINARY
```
    A Binary (tentackle type).
  - BIGDECIMAL
```
public static final DataType BIGDECIMAL
```
    A BigDecimal.
  - BMONEY
```
public static final DataType BMONEY
```
    A BMoney (tentackle type).
  - DMONEY
```
public static final DataType DMONEY
```
    A DMoney (tentackle type).
  - CHARACTER
```
public static final DataType CHARACTER
```
    A Character.
  - CHARACTER_PRIMITIVE
```
public static final DataType CHARACTER_PRIMITIVE
```
    A char (primitive).
  - BOOLEAN
```
public static final DataType BOOLEAN
```
    A Boolean.
  - BOOLEAN_PRIMITIVE
```
public static final DataType BOOLEAN_PRIMITIVE
```
    A boolean (primitive).
  - BYTE
```
public static final DataType BYTE
```
    A Byte.
  - BYTE_PRIMITIVE
```
public static final DataType BYTE_PRIMITIVE
```
    A byte (primitive).
  - SHORT
```
public static final DataType SHORT
```
    A Short.
  - SHORT_PRIMITIVE
```
public static final DataType SHORT_PRIMITIVE
```
    A short (primitive).
  - INTEGER
```
public static final DataType INTEGER
```
    A Integer.
  - INTEGER_PRIMITIVE
```
public static final DataType INTEGER_PRIMITIVE
```
    An int (primitive).
  - LONG
```
public static final DataType LONG
```
    A Long.
  - LONG_PRIMITIVE
```
public static final DataType LONG_PRIMITIVE
```
    A long (primitive).
  - FLOAT
```
public static final DataType FLOAT
```
    A Float.
  - FLOAT_PRIMITIVE
```
public static final DataType FLOAT_PRIMITIVE
```
    A float (primitive).
  - DOUBLE
```
public static final DataType DOUBLE
```
    A Double.
  - DOUBLE_PRIMITIVE
```
public static final DataType DOUBLE_PRIMITIVE
```
    A double (primitive).
  - APPLICATION
```
public static final DataType APPLICATION
```
    Application specific type.
    Such types are immutable because they just convert data between internal and external representation. In most cases this is an enum.
- 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(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isPrimitive
```
public boolean isPrimitive()
```
    Returns whether type is a primitive.
    
    Returns:
    
    true if primitive
  - isMutable
```
public boolean isMutable()
```
    Returns whether type is a mutable java object.
    Mutable objects may change their state.
    
    Returns:
    
    true if mutable
  - isNumeric
```
public boolean isNumeric()
```
    Returns whether this is a numeric type.
    
    Returns:
    
    true if numeric
  - isDateOrTime
```
public boolean isDateOrTime()
```
    Returns whether this is a date and/or time type.
    
    Returns:
    
    true if date or time type
  - isBool
```
public boolean isBool()
```
    Returns whether this is a boolean or Boolean type.
    
    Returns:
    
    true if bool
  - getSqlTypes
```
public SqlType[] getSqlTypes()
```
    Gets the sql type.
    Notice that a tentackle type may be mapped to more than one column for multi-column types such as BMoney.
    
    Returns:
    
    the sql type(s)
  - getSqlTypesWithPostfix
```
public DataType.SqlTypeWithPostfix[] getSqlTypesWithPostfix()
```
    Gets the SqlTypes along with their column name postfixes.
    The first postfix is always the empty string. The second one is "_2", third "_3" and so on. This is a tentackle convention for multi-column types such as BMoney.
    
    Returns:
    
    the sq; types and their postfixes
  - isMultiColumn
```
public boolean isMultiColumn()
```
    True if this is a multicolumn type.
    
    Returns:
    
    true if multicolumn
  - isScaleInSecondColumn
```
public boolean isScaleInSecondColumn()
```
    Returns whether this is a numeric type with the scale stored in a second column.
    BMoney and Dmoney for example.
    
    Returns:
    
    true if scale in second column
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<DataType>
  - toPrimitive
```
public DataType toPrimitive()
```
    Converts to a Java primitive.
    
    Returns:
    
    the primitive type, null if no primitive for given type
  - toNonPrimitive
```
public DataType toNonPrimitive()
```
    Converts a primitive to a Java class.
    
    Returns:
    
    the non-primitive type, null if this is not a primitive
  - parse
```
public Object parse(String str)
```
    Parses a string and converts to the value of this type.
    Notice: the method doesn't use any locale, so the results are always the same regardless of the JVM's locale.
    
    Parameters:
    
    str - the source string
    
    Returns:
    
    the value
  - createFromJavaType
```
public static DataType createFromJavaType(String javaType)
```
    Creates a datatype from a java type string.
    
    Parameters:
    
    javaType - the java type
    
    Returns:
    
    the datatype, null if no such type

Enum DataType

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STRING

DATE

TIME

TIMESTAMP

BINARY

BIGDECIMAL

BMONEY

DMONEY

CHARACTER

CHARACTER_PRIMITIVE

BOOLEAN

BOOLEAN_PRIMITIVE

BYTE

BYTE_PRIMITIVE

SHORT

SHORT_PRIMITIVE

INTEGER

INTEGER_PRIMITIVE

LONG

LONG_PRIMITIVE

FLOAT

FLOAT_PRIMITIVE

DOUBLE

DOUBLE_PRIMITIVE

APPLICATION

Method Detail

values

valueOf

isPrimitive

isMutable

isNumeric

isDateOrTime

isBool

getSqlTypes

getSqlTypesWithPostfix

isMultiColumn

isScaleInSecondColumn

toString

toPrimitive

toNonPrimitive

parse

createFromJavaType