TypeInfo (trafodion-sql 2.1.0 API)

java.lang.Object
+
- org.trafodion.sql.udr.TMUDRSerializableObject
- +
  - org.trafodion.sql.udr.TypeInfo
  +
+

+
+
+
```
public class TypeInfo
+extends TMUDRSerializableObject
```
+
Data types in the UDR interface + +
Describes an SQL data type and the corresponding C/C++ type, + used for scalar parameters, columns of input rows and + columns of result rows.
+

+ +

Nested Class Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Nested Classes
Modifier and Type	Class and Description
`static class`	`TypeInfo.SQLCharsetCode` + Character sets +
`static class`	`TypeInfo.SQLCollationCode` + Collations +
`static class`	`TypeInfo.SQLIntervalCode` + Start and end fields of interval columns +
`static class`	`TypeInfo.SQLTypeClassCode` + Classes of types defined in the SQL standard +
`static class`	`TypeInfo.SQLTypeCode` + SQL data types +
`static class`	`TypeInfo.SQLTypeSubClassCode` + More detailed type information, but not as detailed as the actual type +

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Constructors
Constructor and Description
`TypeInfo()` + Default constructor +
`TypeInfo(TypeInfo.SQLTypeCode sqlType)` + Constructor with type +
`TypeInfo(TypeInfo.SQLTypeCode sqlType, + boolean nullable, + int scale, + TypeInfo.SQLCharsetCode charset, + TypeInfo.SQLIntervalCode intervalCode, + int precision, + TypeInfo.SQLCollationCode collation, + int length)`
`TypeInfo(TypeInfo.SQLTypeCode sqlType, + int length)` + Constructor with type, and length +
`TypeInfo(TypeInfo.SQLTypeCode sqlType, + int length, + boolean nullable)` + Constructor with type, length, and nullable +
`TypeInfo(TypeInfo.SQLTypeCode sqlType, + int length, + boolean nullable, + int scale)` + Constructor with type, length, nullable and scale +
`TypeInfo(TypeInfo.SQLTypeCode sqlType, + int length, + boolean nullable, + int scale, + TypeInfo.SQLCharsetCode charset)` + Constructor with type, length, nullable, scale and charset +
`TypeInfo(TypeInfo.SQLTypeCode sqlType, + int length, + boolean nullable, + int scale, + TypeInfo.SQLCharsetCode charset, + TypeInfo.SQLIntervalCode intervalCode)` + Constructor with all parameters except precision and collation +
`TypeInfo(TypeInfo.SQLTypeCode sqlType, + int length, + boolean nullable, + int scale, + TypeInfo.SQLCharsetCode charset, + TypeInfo.SQLIntervalCode intervalCode, + int precision)` + Constructor with all parameters except collation +
`TypeInfo(TypeInfo.SQLTypeCode sqlType, + int length, + boolean nullable, + int scale, + TypeInfo.SQLCharsetCode charset, + TypeInfo.SQLIntervalCode intervalCode, + int precision, + TypeInfo.SQLCollationCode collation)` + Constructor with arguments +
`TypeInfo(TypeInfo type)` + Copy constructor +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`int`	`getByteLength()` + Get the length of a value of the type. +
`TypeInfo.SQLCharsetCode`	`getCharset()` + Get the character set of the data type. +
`TypeInfo.SQLCollationCode`	`getCollation()` + Get the collation for char/varchar data types. +
`int`	`getFlags()`
`TypeInfo.SQLIntervalCode`	`getIntervalCode()` + Get the interval code for start/end fields. +
`boolean`	`getIsNullable()` + Get whether the type is nullable. +
`int`	`getMaxCharLength()` + Get the maximum number of characters that can be stored in this type. +
`int`	`getPrecision()` + Get the precision (max. +
`int`	`getScale()` + Get the scale of the data type. +
`TypeInfo.SQLTypeCode`	`getSQLType()` + Get the SQL type. +
`TypeInfo.SQLTypeClassCode`	`getSQLTypeClass()` + Get the SQL type class. +
`TypeInfo.SQLTypeSubClassCode`	`getSQLTypeSubClass()` + Get the SQL type subclass. +
`void`	`setNullable(boolean nullable)` + Set the nullable attribute of a type + + Use this method to set types created locally in the UDF + to be nullable or not nullable. +

+ + +
Methods inherited from class java.lang.Object
+equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo type)
```
    +
    Copy constructor
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo.SQLTypeCode sqlType,
+        int length,
+        boolean nullable,
+        int scale,
+        TypeInfo.SQLCharsetCode charset,
+        TypeInfo.SQLIntervalCode intervalCode,
+        int precision,
+        TypeInfo.SQLCollationCode collation)
+         throws UDRException
```
    +
    Constructor with arguments + +
    Construct a TypeInfo object from an SQL type, with several + arguments (including the SQL type). This is mostly used to create + formal parameters or output columns in the compiler interface, if + a more complex data type is required that is not covered by the + TupleInfo.addXXXColumn() methods.
    +
    Parameters:
    sqlType - SQL type enum to construct the type from.
    length - Length of CHAR/VARCHAR types, not needed for other types. + Note that the length for UTF-8 types is in bytes, not + characters, so this is equivalent to +
    [VAR]CHAR ( length BYTES) CHARACTER SET UTF8
    nullable - Determines the NULL / NOT NULL attribute of the type + false means NOT NULL
    scale - Scale for numeric type, fraction precision for + fractional seconds, not needed for other types.
    charset - Character set enum for CHAR/VARCHAR types, not needed + for other types.
    intervalCode - Interval code enum for intervals, not needed otherwise.
    precision - Precision for numeric types and leading precision for + interval data types.
    collation - Collation enum for CHAR/VARCHAR types, not needed for + other types. Note that only one type of collation is + currently supported.
    +
    Throws:
    +
    UDRException
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo.SQLTypeCode sqlType,
+        int length,
+        boolean nullable,
+        int scale,
+        TypeInfo.SQLCharsetCode charset,
+        TypeInfo.SQLIntervalCode intervalCode,
+        int precision)
+         throws UDRException
```
    +
    Constructor with all parameters except collation
    +
    Parameters:
    sqlType - SQL type enum to construct the type from.
    length - Length of CHAR/VARCHAR types, not needed for other types. + Note that the length for UTF-8 types is in bytes, not + characters, so this is equivalent to +
    [VAR]CHAR ( length BYTES) CHARACTER SET UTF8
    nullable - Determines the NULL / NOT NULL attribute of the type + false means NOT NULL
    scale - Scale for numeric type, fraction precision for + fractional seconds, not needed for other types.
    charset - Character set enum for CHAR/VARCHAR types, not needed + for other types.
    intervalCode - Interval code enum for intervals, not needed otherwise.
    precision - Precision for numeric types and leading precision for + interval data types.
    +
    Throws:
    +
    UDRException
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo.SQLTypeCode sqlType,
+        int length,
+        boolean nullable,
+        int scale,
+        TypeInfo.SQLCharsetCode charset,
+        TypeInfo.SQLIntervalCode intervalCode)
+         throws UDRException
```
    +
    Constructor with all parameters except precision and collation
    +
    Parameters:
    sqlType - SQL type enum to construct the type from.
    length - Length of CHAR/VARCHAR types, not needed for other types. + Note that the length for UTF-8 types is in bytes, not + characters, so this is equivalent to +
    [VAR]CHAR ( length BYTES) CHARACTER SET UTF8
    nullable - Determines the NULL / NOT NULL attribute of the type + false means NOT NULL
    scale - Scale for numeric type, fraction precision for + fractional seconds, not needed for other types.
    charset - Character set enum for CHAR/VARCHAR types, not needed + for other types.
    intervalCode - Interval code enum for intervals, not needed otherwise.
    +
    Throws:
    +
    UDRException
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo.SQLTypeCode sqlType,
+        int length,
+        boolean nullable,
+        int scale,
+        TypeInfo.SQLCharsetCode charset)
+         throws UDRException
```
    +
    Constructor with type, length, nullable, scale and charset
    +
    Parameters:
    sqlType - SQL type enum to construct the type from.
    length - Length of CHAR/VARCHAR types, not needed for other types. + Note that the length for UTF-8 types is in bytes, not + characters, so this is equivalent to +
    [VAR]CHAR ( length BYTES) CHARACTER SET UTF8
    nullable - Determines the NULL / NOT NULL attribute of the type + false means NOT NULL
    scale - Scale for numeric type, fraction precision for + fractional seconds, not needed for other types.
    charset - Character set enum for CHAR/VARCHAR types, not needed + for other types.
    +
    Throws:
    +
    UDRException
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo.SQLTypeCode sqlType,
+        int length,
+        boolean nullable,
+        int scale)
+         throws UDRException
```
    +
    Constructor with type, length, nullable and scale
    +
    Parameters:
    sqlType - SQL type enum to construct the type from.
    length - Length of CHAR/VARCHAR types, not needed for other types. + Note that the length for UTF-8 types is in bytes, not + characters, so this is equivalent to +
    [VAR]CHAR ( length BYTES) CHARACTER SET UTF8
    nullable - Determines the NULL / NOT NULL attribute of the type + false means NOT NULL
    scale - Scale for numeric type, fraction precision for + fractional seconds, not needed for other types.
    +
    Throws:
    +
    UDRException
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo.SQLTypeCode sqlType,
+        int length,
+        boolean nullable)
+         throws UDRException
```
    +
    Constructor with type, length, and nullable
    +
    Parameters:
    sqlType - SQL type enum to construct the type from.
    length - Length of CHAR/VARCHAR types, not needed for other types. + Note that the length for UTF-8 types is in bytes, not + characters, so this is equivalent to +
    [VAR]CHAR ( length BYTES) CHARACTER SET UTF8
    nullable - Determines the NULL / NOT NULL attribute of the type + false means NOT NULL
    +
    Throws:
    +
    UDRException
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo.SQLTypeCode sqlType,
+        int length)
+         throws UDRException
```
    +
    Constructor with type, and length
    +
    Parameters:
    sqlType - SQL type enum to construct the type from.
    length - Length of CHAR/VARCHAR types, not needed for other types. + Note that the length for UTF-8 types is in bytes, not + characters, so this is equivalent to +
    [VAR]CHAR ( length BYTES) CHARACTER SET UTF8
    +
    Throws:
    +
    UDRException
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo.SQLTypeCode sqlType)
+         throws UDRException
```
    +
    Constructor with type
    +
    Parameters:
    sqlType - SQL type enum to construct the type from.
    +
    Throws:
    +
    UDRException
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo()
+         throws UDRException
```
    +
    Default constructor
    +
    Throws:
    +
    UDRException
    +
  + + + +
  - +
    TypeInfo
    +
```
public TypeInfo(TypeInfo.SQLTypeCode sqlType,
+        boolean nullable,
+        int scale,
+        TypeInfo.SQLCharsetCode charset,
+        TypeInfo.SQLIntervalCode intervalCode,
+        int precision,
+        TypeInfo.SQLCollationCode collation,
+        int length)
+         throws UDRException
```
    +
    Throws:
    +
    UDRException
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getSQLType
    +
```
public TypeInfo.SQLTypeCode getSQLType()
```
    +
    Get the SQL type.
    +
    Returns:
    SQL type enum.
    +
  + + + +
  - +
    getSQLTypeClass
    +
```
public TypeInfo.SQLTypeClassCode getSQLTypeClass()
```
    +
    Get the SQL type class. + Determine whether this is a numeric character, datetime or interval type.
    +
    Returns:
    SQL type class enum.
    +
  + + + +
  - +
    getSQLTypeSubClass
    +
```
public TypeInfo.SQLTypeSubClassCode getSQLTypeSubClass()
```
    +
    Get the SQL type subclass. + This goes to one more level of detail beyond the type class, + like exact/approximate numeric, char/varchar, etc.
    +
    Returns:
    SQL type subclass enum.
    +
  + + + +
  - +
    getIsNullable
    +
```
public boolean getIsNullable()
```
    +
    Get whether the type is nullable.
    +
    Returns:
    True for nullable types, false for non-nullable types.
    +
  + + + +
  - +
    getScale
    +
```
public int getScale()
```
    +
    Get the scale of the data type. + +
    For integer, largeint, etc. types the scale is 0, since these are + integer data types. For NUMERIC and DECIMAL types, a scale can + be specified. Timestamp and some interval data types have a + "fraction precision" value, which is the number of digits + allowed after the decimal point for seconds. This fraction precision + is returned as the scale, since can be considered the scale of + the seconds part. For other data types like CHAR, the scale + value is meaningless.
    +
    Returns:
    Scale (digits after the decimal point) for numeric types, + fraction precision (digits of fractional seconds) for intervals.
    +
  + + + +
  - +
    getCharset
    +
```
public TypeInfo.SQLCharsetCode getCharset()
```
    +
    Get the character set of the data type.
    +
    Returns:
    Character set enum.
    +
  + + + +
  - +
    getIntervalCode
    +
```
public TypeInfo.SQLIntervalCode getIntervalCode()
```
    +
    Get the interval code for start/end fields.
    +
    Returns:
    Interval code enum, indicating start and end fields of an interval type.
    +
  + + + +
  - +
    getPrecision
    +
```
public int getPrecision()
```
    +
    Get the precision (max. number of significant digits). + + The precision is the maximum number of digits before the decimal + point a value can have. For interval types, this is the "leading + precision". For example, an INTEGER value can range from + -2,147,483,648 to 2,147,483,647. It's precision is 10, since the + longest number has 10 digits. Note that not all 10 digit numbers + can be represented in an integer. This is called binary + precision. NUMERIC and DECIMAL types have decimal precision, + meaning that a NUMERIC(10,0) type can represent values from + -9,999,999,999 to +9,999,999,999.
    +
    Returns:
    Precision of numeric types or interval types.
    +
  + + + +
  - +
    getFlags
    +
```
public int getFlags()
```
    +
  + + + +
  - +
    getCollation
    +
```
public TypeInfo.SQLCollationCode getCollation()
```
    +
    Get the collation for char/varchar data types. + +
    Note that, currently, only one collation is supported. + This default collation is a binary collation, except that + trailing blanks are ignored.
    +
    Returns:
    Collation enum.
    +
  + + + +
  - +
    getByteLength
    +
```
public int getByteLength()
```
    +
    Get the length of a value of the type. + +
    Getting the length is useful for CHAR/VARCHAR data types + but probably not as useful for other types that may have + an internal representation unknown to a UDR writer. + This returns the length in bytes, not in characters.
    +
    Returns:
    Length in bytes.
    See Also:
    getMaxCharLength()
    +
  + + + +
  - +
    getMaxCharLength
    +
```
public int getMaxCharLength()
+                     throws UDRException
```
    +
    Get the maximum number of characters that can be stored in this type. + +
    This method should be used only for character types that + have a fixed-width encoding. For variable-length encoding, like + UTF-8, the method returns the highest possible number of characters + (assuming single byte characters in the case of UTF-8). Right now, + UTF-8 data types all have byte semantics, meaning there is no + limit for the number of characters stored in a type, it is only + limited by the number of bytes. The method returns 0 for numeric + types. It returns the length of the string representation for + types that are represented by a string, like datetime types.
    +
    Returns:
    Length in bytes.
    +
    Throws:
    +
    UDRException
    See Also:
    getByteLength()
    +
  + + + +
  - +
    setNullable
    +
```
public void setNullable(boolean nullable)
```
    +
    Set the nullable attribute of a type + + Use this method to set types created locally in the UDF + to be nullable or not nullable.
    +
    Parameters:
    nullable - true to set the type to nullable, false + to give the type the NOT NULL attibute.
    +
  +
+

Class TypeInfo

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TypeInfo

TypeInfo

TypeInfo

TypeInfo

TypeInfo

TypeInfo

TypeInfo

TypeInfo

TypeInfo

TypeInfo

TypeInfo

Method Detail

getSQLType

getSQLTypeClass

getSQLTypeSubClass

getIsNullable

getScale

getCharset

getIntervalCode

getPrecision

getFlags

getCollation

getByteLength

getMaxCharLength

setNullable

Class UDR.QueueStateInfo

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

queueState_