Package com.inductiveautomation.ignition.common.sqltags.model.types

Enum DataType

java.lang.Object

java.lang.Enum<DataType>

com.inductiveautomation.ignition.common.sqltags.model.types.DataType

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
Boolean
BooleanArray
ByteArray
DataSet
DateTime
DateTimeArray
Document
Float4
Float4Array
Float8
Float8Array
Int1
Int1Array
Int2
Int2Array
Int4
Int4Array
Int8
Int8Array
String
StringArray
Text

Method Summary

Modifier and Type	Method	Description
static DataType	fromIntValue(java.lang.Integer val)
DataType	getComponentDataType()	If the data type is an array type, returns the type of the elements.
int	getIntValue()	Returns the integer value for this Data type
java.lang.Class<?>	getJavaType()	Returns the type in the Java world that would encapsulate this type
DataTypeClass	getTypeClass()	Returns the category of data the type represents.
static DataType	getTypeForClass(java.lang.Class<?> clazz)	Gets the DataType for the given java class, returning NULL if a match can't be found.
static DataType	getTypeForValue(int val)	Returns the DataType for the given int value.
boolean	isArray()	Returns true for array types and dataset
boolean	isFloatingPoint()
boolean	isNumeric()	Returns true for integer and float types, and false for everything else (including boolean)
DataType	legacyDataType()	Pre-8 Ignition did not have certain data types.
java.lang.String	toString(java.util.Locale locale)
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

Int1

public static final DataType Int1

Int2

public static final DataType Int2

Int4

public static final DataType Int4

Int8

public static final DataType Int8

Float4

public static final DataType Float4

Float8

public static final DataType Float8

Boolean

public static final DataType Boolean

String

public static final DataType String

DateTime

public static final DataType DateTime

Text

public static final DataType Text

Int1Array

public static final DataType Int1Array

Int2Array

public static final DataType Int2Array

Int4Array

public static final DataType Int4Array

Int8Array

public static final DataType Int8Array

Float4Array

public static final DataType Float4Array

Float8Array

public static final DataType Float8Array

BooleanArray

public static final DataType BooleanArray

StringArray

public static final DataType StringArray

DateTimeArray

public static final DataType DateTimeArray

ByteArray

public static final DataType ByteArray

DataSet

public static final DataType DataSet

Document

public static final DataType Document

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

getIntValue

public int getIntValue()

Returns the integer value for this Data type

fromIntValue

public static DataType fromIntValue(java.lang.Integer val)

getJavaType

public java.lang.Class<?> getJavaType()

Returns the type in the Java world that would encapsulate this type

getComponentDataType

public DataType getComponentDataType()

If the data type is an array type, returns the type of the elements. Otherwise, returns the type itself.

isArray

public boolean isArray()

Returns true for array types and dataset

getTypeClass

public DataTypeClass getTypeClass()

Returns the category of data the type represents.

isNumeric

public boolean isNumeric()

Returns true for integer and float types, and false for everything else (including boolean)

isFloatingPoint

public boolean isFloatingPoint()

getTypeForValue

public static DataType getTypeForValue(int val)

Returns the DataType for the given int value. If there is no Data type for that value, null is returned.

getTypeForClass

public static DataType getTypeForClass(java.lang.Class<?> clazz)

Gets the DataType for the given java class, returning NULL if a match can't be found.

toString

public java.lang.String toString(java.util.Locale locale)

Specified by:

toString in interface Localized

legacyDataType

public DataType legacyDataType()

Pre-8 Ignition did not have certain data types. This function returns String if the type didn't exist.