Type (Treetank 6.0.1-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<Type>
- - org.treetank.node.Type

All Implemented Interfaces:

Serializable, Comparable<Type>
```
public enum Type
extends Enum<Type>
```
Enum that represents the built-in-types of XPath 2.0.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANY_ATOMIC_TYPE` XML Schema type 'anyAtomicType'.
`ANY_SIMPLE_TYPE` XML Schema type 'anySimpleType'.
`ANY_TYPE` XML Schema type 'anyType.
`ANY_URI` XML Schema type 'anyURI'.
`BASE_64_BINARY` XML Schema type 'base64Binary'.
`BOOLEAN` XML Schema type 'boolean'.
`BYTE` XML Schema type 'byte'.
`DATE` XML Schema type 'date'.
`DATE_TIME` XML Schema type 'dateTime'.
`DAY_TIME_DURATION` XML Schema type 'DayTimeDuration'.
`DECIMAL` XML Schema type 'decimal'.
`DOUBLE` XML Schema type 'double'.
`DURATION` XML Schema type 'duration'.
`ENTITY` XML Schema type 'ENTITY'.
`FLOAT` XML Schema type 'float'.
`G_DAY` XML Schema type 'gDay'.
`G_MONTH` XML Schema type 'gMonth'.
`G_MONTH_DAY` XML Schema type 'gMonthDay'.
`G_YEAR` XML Schema type 'gYear'.
`G_YEAR_MONTH` XML Schema type 'gYearMonth'.
`HEX_BINARY` XML Schema type 'hexBinary'.
`ID` XML Schema type 'ID'.
`IDFRES` XML Schema type 'IDREFS'.
`IDREF` XML Schema type 'IDREF'.
`INT` XML Schema type 'int'.
`INTEGER` XML Schema type 'integer'.
`LANGUAGE` XML Schema type 'language'.
`LONG` XML Schema type 'long'.
`NAME` XML Schema type 'name'.
`NCNAME` XML Schema type 'NCName'.
`NEGATIVE_INTEGER` XML Schema type 'negativeInteger'.
`NMTOKEN` XML Schema type 'ENTITIES'.
`NMTOKENS` XML Schema type 'NMTOKENS'.
`NON_NEGATIVE_INTERGER` XML Schema type 'nonNegativeInteger'.
`NON_POSITIVE_INTEGER` XML Schema type 'nonPositiveInteger'.
`NORMALIZED_STRING` XML Schema type 'normalizedString'.
`NOTATION` XML Schema type 'NOTATION'.
`PDECIMAL` XML Schema type 'pDecimal'.
`POSITIVE_INTEGER` XML Schema type 'positiveInteger'.
`QNAME` XML Schema type 'QName'.
`SHORT` XML Schema type 'short'.
`STRING` XML Schema type 'string'.
`TIME` XML Schema type 'time'.
`TOKEN` XML Schema type 'token'.
`UNSIGNED_BYTE` XML Schema type 'unsignedByte'.
`UNSIGNED_INT` XML Schema type 'unsignedInt'.
`UNSIGNED_LONG` XML Schema type 'unsignedLong'.
`UNSIGNED_SHORT` XML Schema type 'unsignedShort'.
`UNTYPED` Additional XMD type 'untyped'.
`UNTYPED_ATOMIC` Additional XMD type 'untyped value'.
`YEAR_MONTH_DURATION` XML Schema type 'YearMonthDuration'.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`castsTo(Type mTargetType)` Defines if the current type is castable to the targetType.
`boolean`	`derivesFrom(Type mExpectedType)` Tests whether a type is derived by restriction from a certain type.
`String`	`getFacet()` Gets the facet of the type.
`static Type`	`getLeastCommonType(int mType1, int mType2)`
`static Type`	`getLeastCommonType(Type mType1, Type mType2)` Returns the least common base type of the given types.
`Type`	`getPrimitiveBaseType()` Return the next base type of the current type that is a primitive one.
`String`	`getStringRepr()` Returns the string representation of the current type.
`static Type`	`getType(int paramKey)` Getting the type for the key
`static Type`	`getType(String paramRepr)` Getting type for string
`boolean`	`isCastableTo(Type mTargetType, String mValue)` Determines, whether a value of the current type can be casted to the input type, as defined in XML Schema 1.1-1 Spec.
`boolean`	`isNumericType()` Specifies if the current type is a numeric type or derived from a numeric type.
`boolean`	`isPrimitive()` Declare, whether the type is one of the primitive value types.
`static Type`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Type[]`	`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
  - ANY_TYPE
```
public static final Type ANY_TYPE
```
    XML Schema type 'anyType.
  - ANY_SIMPLE_TYPE
```
public static final Type ANY_SIMPLE_TYPE
```
    XML Schema type 'anySimpleType'.
  - ANY_ATOMIC_TYPE
```
public static final Type ANY_ATOMIC_TYPE
```
    XML Schema type 'anyAtomicType'.
  - UNTYPED_ATOMIC
```
public static final Type UNTYPED_ATOMIC
```
    Additional XMD type 'untyped value'. It denotes untyped atomic data, such as text that has not been assigned a more specific type. An attribute that has been validated in skip mode is represented in the Data Model by an attribute node with the type xs:untypedAtomic.
  - UNTYPED
```
public static final Type UNTYPED
```
    Additional XMD type 'untyped'. It denotes the dynamic type of an element node that has not been validated, or has been validated in skip mode.
  - STRING
```
public static final Type STRING
```
    XML Schema type 'string'. The string datatype represents character strings in XML.
  - DURATION
```
public static final Type DURATION
```
    XML Schema type 'duration'. duration represents a duration of time.
  - YEAR_MONTH_DURATION
```
public static final Type YEAR_MONTH_DURATION
```
    XML Schema type 'YearMonthDuration'.
  - DAY_TIME_DURATION
```
public static final Type DAY_TIME_DURATION
```
    XML Schema type 'DayTimeDuration'.
  - DATE_TIME
```
public static final Type DATE_TIME
```
    XML Schema type 'dateTime'. dateTime values may be viewed as objects with integer-valued year, month, day, hour and minute properties, a decimal-valued second property, and a boolean timezoned property.
  - TIME
```
public static final Type TIME
```
    XML Schema type 'time'. time represents an instant of time that recurs every day.
  - DATE
```
public static final Type DATE
```
    XML Schema type 'date'. The "value space" of date consists of top-open intervals of exactly one day in length on the timelines of dateTime, beginning on the beginning moment of each day (in each timezone), i.e. '00:00:00', up to but not including '24:00:00' (which is identical with '00:00:00' of the next day).
  - G_YEAR_MONTH
```
public static final Type G_YEAR_MONTH
```
    XML Schema type 'gYearMonth'. gYearMonth represents a specific gregorian month in a specific gregorian year.
  - G_YEAR
```
public static final Type G_YEAR
```
    XML Schema type 'gYear'. gYear represents a gregorian calendar year.
  - G_MONTH_DAY
```
public static final Type G_MONTH_DAY
```
    XML Schema type 'gMonthDay'. gMonthDay is a gregorian date that recurs, specifically a day of the year such as the third of May.
  - G_DAY
```
public static final Type G_DAY
```
    XML Schema type 'gDay'. gDay is a gregorian day that recurs, specifically a day of the month such as the 5th of the month.
  - G_MONTH
```
public static final Type G_MONTH
```
    XML Schema type 'gMonth'. gMonth is a Gregorian month that recurs every year.
  - BOOLEAN
```
public static final Type BOOLEAN
```
    XML Schema type 'boolean'. boolean has the "value space" required to support the mathematical concept of binary-valued logic: {true, false}.
  - BASE_64_BINARY
```
public static final Type BASE_64_BINARY
```
    XML Schema type 'base64Binary'. base64Binary represents Base64-encoded arbitrary binary data.
  - HEX_BINARY
```
public static final Type HEX_BINARY
```
    XML Schema type 'hexBinary'. hexBinary represents arbitrary hex-encoded binary data.
  - ANY_URI
```
public static final Type ANY_URI
```
    XML Schema type 'anyURI'. anyURI represents a Uniform Resource Identifier Reference (URI).
  - QNAME
```
public static final Type QNAME
```
    XML Schema type 'QName'. QName represents XML qualified names.
  - NOTATION
```
public static final Type NOTATION
```
    XML Schema type 'NOTATION'. NOTATION represents the NOTATION attribute type from [XML 1.0 (Second Edition)].
  - FLOAT
```
public static final Type FLOAT
```
    XML Schema type 'float'. float is patterned after the IEEE single-precision 32-bit floating point type [IEEE 754-1985].
  - DOUBLE
```
public static final Type DOUBLE
```
    XML Schema type 'double'. The double data type is patterned after the IEEE double-precision 64-bit floating point type [IEEE 754-1985].
  - PDECIMAL
```
public static final Type PDECIMAL
```
    XML Schema type 'pDecimal'.
  - DECIMAL
```
public static final Type DECIMAL
```
    XML Schema type 'decimal'. decimal represents a subset of the real numbers, which can be represented by decimal numerals.
  - INTEGER
```
public static final Type INTEGER
```
    XML Schema type 'integer'. integer is derived from decimal by fixing the value of fractionDigits to be 0 and disallowing the trailing decimal point. This results in the standard mathematical concept of the integer numbers. The value space of integer is the infinite set {...,-2,-1,0,1,2,...}.
  - LONG
```
public static final Type LONG
```
    XML Schema type 'long'. long is "derived" from integer by setting the value of "maxInclusive" to be 9223372036854775807 and "minInclusive" to be -9223372036854775808.
  - INT
```
public static final Type INT
```
    XML Schema type 'int'. int is "derived" from long by setting the value of "maxInclusive" to be 2147483647 and "minInclusive" to be -2147483648.
  - SHORT
```
public static final Type SHORT
```
    XML Schema type 'short'. short is "derived" from int by setting the value of "maxInclusive" to be 32767 and "minInclusive" to be -32768.
  - BYTE
```
public static final Type BYTE
```
    XML Schema type 'byte'. byte is "derived" from short by setting the value of "maxInclusive" to be 127 and "minInclusive" to be -128.
  - NON_POSITIVE_INTEGER
```
public static final Type NON_POSITIVE_INTEGER
```
    XML Schema type 'nonPositiveInteger'. nonPositiveInteger is "derived" from integer by setting the value of "maxInclusive" to be 0. This results in the standard mathematical concept of the non-positive integers. The "value space" of nonPositiveInteger is the infinite set {...,-2,-1,0}.
  - NEGATIVE_INTEGER
```
public static final Type NEGATIVE_INTEGER
```
    XML Schema type 'negativeInteger'. negativeInteger is "derived" from nonPositiveInteger by setting the value of "maxInclusive" to be -1. This results in the standard mathematical concept of the negative integers. The "value space" of negativeInteger is the infinite set {...,-2,-1}.
  - NON_NEGATIVE_INTERGER
```
public static final Type NON_NEGATIVE_INTERGER
```
    XML Schema type 'nonNegativeInteger'. nonNegativeInteger is "derived" from integer by setting the value of "minInclusive" to be 0. This results in the standard mathematical concept of the non-negative integers. The "value space" of nonNegativeInteger is the infinite set {0,1,2,...}.
  - POSITIVE_INTEGER
```
public static final Type POSITIVE_INTEGER
```
    XML Schema type 'positiveInteger'. positiveInteger is "derived" from nonNegativeInteger by setting the value of "minInclusive" to be 1. This results in the standard mathematical concept of the positive integer numbers. The "value space" of positiveInteger is the infinite set {1,2,...}.
  - UNSIGNED_LONG
```
public static final Type UNSIGNED_LONG
```
    XML Schema type 'unsignedLong'. unsignedLong is "derived" from nonNegativeInteger by setting the value of "maxInclusive" to be 18446744073709551615.
  - UNSIGNED_INT
```
public static final Type UNSIGNED_INT
```
    XML Schema type 'unsignedInt'. unsignedInt is "derived" from unsignedLong by setting the value of "maxInclusive" to be 4294967295.
  - UNSIGNED_SHORT
```
public static final Type UNSIGNED_SHORT
```
    XML Schema type 'unsignedShort'. unsignedShort is "derived" from unsignedInt by setting the value of "maxInclusive" to be 65535.
  - UNSIGNED_BYTE
```
public static final Type UNSIGNED_BYTE
```
    XML Schema type 'unsignedByte'. unsignedByte is "derived" from unsignedShort by setting the value of "maxInclusive" to be 255.
  - NORMALIZED_STRING
```
public static final Type NORMALIZED_STRING
```
    XML Schema type 'normalizedString'. normalizedString represents white space normalized strings. The "value space" of normalizedString is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters. The "lexical space" of normalizedString is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters.
  - TOKEN
```
public static final Type TOKEN
```
    XML Schema type 'token'. token represents tokenized strings. The "value space" of token is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces. The "lexical space" of token is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces.
  - LANGUAGE
```
public static final Type LANGUAGE
```
    XML Schema type 'language'. language represents natural language identifiers as defined by [RFC 3066]. The "value space" of language is the set of all strings that are valid language identifiers as defined [RFC 3066] . The "lexical space" of language is the set of all strings that conform to the pattern [a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})* .
  - NAME
```
public static final Type NAME
```
    XML Schema type 'name'. Name represents XML Names. The "value space" of Name is the set of all strings which "match" the Name production of [XML 1.0 (Second Edition)]. The "lexical space" of Name is the set of all strings which "match" the Name production of [XML 1.0 (Second Edition)].
  - NCNAME
```
public static final Type NCNAME
```
    XML Schema type 'NCName'. NCName represents XML "non-colonized" Names. The "value space" of NCName is the set of all strings which "match" the NCName production of Namespaces in XML. The "lexical space" of NCName is the set of all strings which match the NCName production of [Namespaces in XML].
  - ID
```
public static final Type ID
```
    XML Schema type 'ID'. ID represents the ID attribute type from [XML 1.0 (Second Edition)]. The "value space" of ID is the set of all strings that "match" the NCName production in [Namespaces in XML]. The "lexical space" of ID is the set of all strings that "match" the NCName production in [Namespaces in XML].
  - IDREF
```
public static final Type IDREF
```
    XML Schema type 'IDREF'. IDREF represents the IDREF attribute type from [XML 1.0 (Second Edition)]. The "value space" of IDREF is the set of all strings that "match" the NCName production in [Namespaces in XML]. The "lexical space" of IDREF is the set of strings that "match" the NCName production in Namespaces in XML.
  - ENTITY
```
public static final Type ENTITY
```
    XML Schema type 'ENTITY'. ENTITY represents the ENTITY attribute type from XML 1.0 (Second Edition). The "value space" of ENTITY is the set of all strings that "match" the NCName production in [Namespaces in XML] and have been declared as an unparsed entity in a document type definition. The "lexical space" of ENTITY is the set of all strings that "match" the NCName production in [Namespaces in XML].
  - IDFRES
```
public static final Type IDFRES
```
    XML Schema type 'IDREFS'.
  - NMTOKEN
```
public static final Type NMTOKEN
```
    XML Schema type 'ENTITIES'. ENTITIES(ANY_SIMPLE_TYPE, "xs:ENTITIES", 3) , /** XML Schema type 'NMTOKEN'. NMTOKEN represents the NMTOKEN attribute type from XML 1.0 (2nd Edition). The "value space" of NMTOKEN is the set of tokens that "match" the Nmtoken production in XML 1.0 (2nd Edition). The "lexical space" of NMTOKEN is the set of strings that match the Nmtoken production in XML 1.0 (2nd Edition).
  - NMTOKENS
```
public static final Type NMTOKENS
```
    XML Schema type 'NMTOKENS'.
- Method Detail
  - values
```
public static Type[] 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 (Type c : Type.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Type 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
  - getType
```
public static Type getType(int paramKey)
```
    Getting the type for the key
    
    Parameters:
    paramKey - the key for the type
    
    Returns:
    the type
  - getType
```
public static Type getType(String paramRepr)
```
    Getting type for string
    
    Parameters:
    paramRepr - the string for the type
    
    Returns:
    the type
  - isPrimitive
```
public boolean isPrimitive()
```
    Declare, whether the type is one of the primitive value types.
    
    Returns:
    true, if type is a primitive type
  - getStringRepr
```
public String getStringRepr()
```
    Returns the string representation of the current type.
    
    Returns:
    string representation of the type.
  - getLeastCommonType
```
public static Type getLeastCommonType(int mType1,
                      int mType2)
```
  - getLeastCommonType
```
public static Type getLeastCommonType(Type mType1,
                      Type mType2)
```
    Returns the least common base type of the given types.
    
    Parameters:
    mType1 - First type
    mType2 - Second type
    
    Returns:
    the common type of the parameter types
  - derivesFrom
```
public boolean derivesFrom(Type mExpectedType)
```
    Tests whether a type is derived by restriction from a certain type.
    
    Parameters:
    mExpectedType - the type to check, if this type is derived from
    
    Returns:
    true, if this type is derived from the input type.
  - isNumericType
```
public boolean isNumericType()
```
    Specifies if the current type is a numeric type or derived from a numeric type.
    
    Returns:
    true, if the type is a numeric type.
  - isCastableTo
```
public boolean isCastableTo(Type mTargetType,
                   String mValue)
                     throws TTXPathException
```
    Determines, whether a value of the current type can be casted to the input type, as defined in XML Schema 1.1-1 Spec.
    
    Parameters:
    mTargetType - type to which the current value shall be casted to
    mValue - value of the source value
    
    Returns:
    true, if the source value is castable to the target type.
    
    Throws:
    
    TTXPathException - if casts fails
  - getPrimitiveBaseType
```
public Type getPrimitiveBaseType()
                          throws TTXPathException
```
    Return the next base type of the current type that is a primitive one. If the current type is a primitive type the current type is returned.
    
    Returns:
    primitive base type of the current type
    
    Throws:
    
    TTXPathException
  - getFacet
```
public String getFacet()
```
    Gets the facet of the type.
    
    Returns:
    type'S facet.
  - castsTo
```
public boolean castsTo(Type mTargetType)
```
    Defines if the current type is castable to the targetType.
    
    Parameters:
    mTargetType - the type the current type should be casted to
    
    Returns:
    true, if it is possible to cast the current type to the targettype

Enum Type

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ANY_TYPE

ANY_SIMPLE_TYPE

ANY_ATOMIC_TYPE

UNTYPED_ATOMIC

UNTYPED

STRING

DURATION

YEAR_MONTH_DURATION

DAY_TIME_DURATION

DATE_TIME

TIME

DATE

G_YEAR_MONTH

G_YEAR

G_MONTH_DAY

G_DAY

G_MONTH

BOOLEAN

BASE_64_BINARY

HEX_BINARY

ANY_URI

QNAME

NOTATION

FLOAT

DOUBLE

PDECIMAL

DECIMAL

INTEGER

LONG

INT

SHORT

BYTE

NON_POSITIVE_INTEGER

NEGATIVE_INTEGER

NON_NEGATIVE_INTERGER

POSITIVE_INTEGER

UNSIGNED_LONG

UNSIGNED_INT

UNSIGNED_SHORT

UNSIGNED_BYTE

NORMALIZED_STRING

TOKEN

LANGUAGE

NAME

NCNAME

ID

IDREF

ENTITY

IDFRES

NMTOKEN

NMTOKENS

Method Detail

values

valueOf

getType

getType

isPrimitive

getStringRepr

getLeastCommonType

getLeastCommonType

derivesFrom

isNumericType

isCastableTo

getPrimitiveBaseType

getFacet

castsTo