com.ibm.ims.base

Class DLITypeInfo

java.lang.Object

com.ibm.ims.base.DLITypeInfo

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DLITypeInfoList, SecondaryIndexInfo

public class DLITypeInfo
extends java.lang.Object
implements java.io.Serializable

A DLITypeInfo object is used to provide the layout of a segment's fields. With this metadata, the segment is able to provide access to all of the fields in any segment using either the defined field name or the 1-based index of the DLITypeInfo object in the array that is registered for each segment type. The defined field name can be an alias for the defined search field name in the DBD source file. When referring to the field, you can use the field alias instead of the search or key field name, as these field names are limited to only 8 characters. Note that the field names are case sensitive and must be written exactly as defined in the DLITypeInfo objects. When defining a key or search field, you must use the DLITypeInfo(String, int, int, int, String) constructor, which allows you to provide the alias and actual name of the search or key field.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARRAY
static int	BIGINT
static int	BINARY
static int	BIT
static int	BLOB
static int	CHAR
static int	CLOB
static int	DATE
static int	DBCS
static int	DOUBLE
static int	FLOAT
static int	INTEGER
static int	NON_UNIQUE_KEY
static int	NOT_KEY
static int	OTHER
static int	PACKEDDECIMAL
static int	SECONDARY_INDEX
static int	SMALLINT
static int	STRUCT
static int	TIME
static int	TIMESTAMP
static int	TINYINT
static int	TYPELIST
static int	UBIGINT
static int	UINTEGER
static int	UNIQUE_KEY
static int	USMALLINT
static int	UTINYINT
static int	VARCHAR
static int	XML
static int	ZONEDDECIMAL

Constructor Summary

Constructors

Constructor and Description
DLITypeInfo(java.lang.String fieldName, int type, int startingOffset, int length) Constructs a DLITypeInfo object.
DLITypeInfo(java.lang.String fieldName, int type, int startingOffset, int length, com.ibm.ims.base.DBType dbType, boolean isRoot) Constructs a DLITypeInfo object.
DLITypeInfo(java.lang.String fieldName, int type, int startingOffset, int length, java.lang.String searchFieldName) Constructs a DLITypeInfo object.
DLITypeInfo(java.lang.String fieldName, int type, int startingOffset, int length, java.lang.String searchFieldName, com.ibm.ims.base.DBType dbType, boolean isRoot) Constructs a DLITypeInfo object.
DLITypeInfo(java.lang.String fieldName, int type, int startingOffset, int length, java.lang.String searchFieldName, int keyType) Constructs a DLITypeInfo object, adding the ability to specify a key type.
DLITypeInfo(java.lang.String fieldName, int type, int startingOffset, int length, java.lang.String searchFieldName, int keyType, com.ibm.ims.base.DBType dbType, boolean isRoot) Constructs a DLITypeInfo object, adding the ability to specify a key type and db type.
DLITypeInfo(java.lang.String fieldName, java.lang.String xmlSchema, int type) Constructs a DLITypeInfo object.
DLITypeInfo(java.lang.String fieldName, java.lang.String typeQualifier, int type, int startingOffset, int length) Constructs a DLITypeInfo object.
DLITypeInfo(java.lang.String fieldName, java.lang.String typeQualifier, int type, int startingOffset, int length, com.ibm.ims.base.DBType dbType, boolean isRoot) Constructs a DLITypeInfo object.
DLITypeInfo(java.lang.String fieldName, java.lang.String typeQualifier, int type, int startingOffset, int length, java.lang.String searchFieldName) Constructs a DLITypeInfo object.
DLITypeInfo(java.lang.String fieldName, java.lang.String typeQualifier, int type, int startingOffset, int length, java.lang.String searchFieldName, com.ibm.ims.base.DBType dbType, boolean isRoot) Constructs a DLITypeInfo object.
DLITypeInfo(java.lang.String fieldName, java.lang.String typeQualifier, int type, int startingOffset, int length, java.lang.String searchFieldName, int keyType) Constructs a DLITypeInfo object, adding the ability to specify a key type.
DLITypeInfo(java.lang.String fieldName, java.lang.String typeQualifier, int type, int startingOffset, int length, java.lang.String searchFieldName, int keyType, com.ibm.ims.base.DBType dbType, boolean isRoot) Constructs a DLITypeInfo object, adding the ability to specify a key type and db type.
DLITypeInfo(java.lang.String fieldName, java.lang.String overflowSegment, java.lang.String xmlSchema, int type, int startingOffset, int length) Constructs a DLITypeInfo object.

Method Summary

Modifier and Type	Method and Description
com.ibm.ims.base.DBType	getDBType() Returns the DBType for this DLITypeInfo
int	getFieldLength() Returns the length of the field's value in the segment.
java.lang.String	getFieldName() Returns the field name given to this field in the segment.
int	getFieldOffset() Returns the offset of the field in the segment's I/O area.
int	getFieldType() Returns the type assigned to a field's value in the segment.
boolean	getIsRoot() Indicates if this DLITypeInfo is a root
int	getKeyType() Returns the type of key the field is: DLITypeInfo.NOT_KEY DLITypeInfo.UNIQUE_KEY DLITypeInfo.NON_UNIQUE_KEY
int	getPrecision() Returns the precision of a BigDecimal
int	getScale() Returns the scale of a BigDecimal
java.lang.String	getSearchFieldName() Returns the search field name given to this field in the segment, which must be exactly as defined in the DBD source file.
java.lang.String	getTypeQualifier() Returns the type qualifier for this type.
java.lang.String	getXmlSchema() Returns the XML Schema assigned to a field's value in the segment.
boolean	isSigned() Indicates whether this type is signed.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TINYINT

public static final int TINYINT

See Also:

Constant Field Values

INTEGER

public static final int INTEGER

See Also:

Constant Field Values

CHAR

public static final int CHAR

See Also:

Constant Field Values

DOUBLE

public static final int DOUBLE

See Also:

Constant Field Values

FLOAT

public static final int FLOAT

See Also:

Constant Field Values

BIT

public static final int BIT

See Also:

Constant Field Values

BLOB

public static final int BLOB

See Also:

Constant Field Values

BIGINT

public static final int BIGINT

See Also:

Constant Field Values

SMALLINT

public static final int SMALLINT

See Also:

Constant Field Values

VARCHAR

public static final int VARCHAR

See Also:

Constant Field Values

PACKEDDECIMAL

public static final int PACKEDDECIMAL

See Also:

Constant Field Values

ZONEDDECIMAL

public static final int ZONEDDECIMAL

See Also:

Constant Field Values

DATE

public static final int DATE

See Also:

Constant Field Values

TIME

public static final int TIME

See Also:

Constant Field Values

TIMESTAMP

public static final int TIMESTAMP

See Also:

Constant Field Values

TYPELIST

public static final int TYPELIST

See Also:

Constant Field Values

BINARY

public static final int BINARY

See Also:

Constant Field Values

SECONDARY_INDEX

public static final int SECONDARY_INDEX

See Also:

Constant Field Values

CLOB

public static final int CLOB

See Also:

Constant Field Values

DBCS

public static final int DBCS

See Also:

Constant Field Values

XML

public static final int XML

See Also:

Constant Field Values

USMALLINT

public static final int USMALLINT

See Also:

Constant Field Values

UINTEGER

public static final int UINTEGER

See Also:

Constant Field Values

UBIGINT

public static final int UBIGINT

See Also:

Constant Field Values

UTINYINT

public static final int UTINYINT

See Also:

Constant Field Values

STRUCT

public static final int STRUCT

See Also:

Constant Field Values

ARRAY

public static final int ARRAY

See Also:

Constant Field Values

OTHER

public static final int OTHER

See Also:

Constant Field Values

NOT_KEY

public static final int NOT_KEY

See Also:

Constant Field Values

UNIQUE_KEY

public static final int UNIQUE_KEY

See Also:

Constant Field Values

NON_UNIQUE_KEY

public static final int NON_UNIQUE_KEY

See Also:

Constant Field Values

Constructor Detail

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   int type,
                   int startingOffset,
                   int length)

Constructs a DLITypeInfo object. Use this constructor only for non-key and non-search fields. For all other field types, including zoned decimal, packed decimal, date, time, and timestamp, use either DLITypeInfo(String, String, int, int, int) or DLITypeInfo(String, String, int, int, int, String) constructors for these types.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: CHAR, INTEGER, DOUBLE, FLOAT, BIT, BLOB, BIGINT, TINYINT, BINARY, and SMALLINT. Certain types have predefined lengths and cannot be changed. The INTEGER and FLOAT types are always 4 bytes long. The DOUBLE and BIGINT types are always 8 bytes long. The SMALLINT type is always 2 bytes long. The TINYINT and BIT types are always 1 byte long. If another length value is specified for one of these types, an exception will be thrown.

Parameters:

fieldName - The name of the field.

type - the type of the field

startingOffset - the starting offset in the I/O area of this field, beginning at offset 1

length - the length, in bytes, of this field

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   int type,
                   int startingOffset,
                   int length,
                   com.ibm.ims.base.DBType dbType,
                   boolean isRoot)

Constructs a DLITypeInfo object. Use this constructor only for non-key and non-search fields. For all other field types, including zoned decimal, packed decimal, date, time, and timestamp, use either DLITypeInfo(String, String, int, int, int) or DLITypeInfo(String, String, int, int, int, String) constructors for these types.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: CHAR, INTEGER, DOUBLE, FLOAT, BIT, BLOB, BIGINT, TINYINT, BINARY, and SMALLINT. Certain types have predefined lengths and cannot be changed. The INTEGER and FLOAT types are always 4 bytes long. The DOUBLE and BIGINT types are always 8 bytes long. The SMALLINT type is always 2 bytes long. The TINYINT and BIT types are always 1 byte long. If another length value is specified for one of these types, an exception will be thrown.

Parameters:

fieldName - The name of the field.

type - the type of the field

startingOffset - the starting offset in the I/O area of this field, beginning at offset 1

length - the length, in bytes, of this field

dbType - the database type

isRoot - true if field is a unique key of a direct access database (DEDB, HDAM, PHDAM) root segment

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   int type,
                   int startingOffset,
                   int length,
                   java.lang.String searchFieldName)

Constructs a DLITypeInfo object. Use this constructor only for non-key and non-search fields. For all other field types, including zoned decimal, packed decimal, date, time, and timestamp, use either DLITypeInfo(String, String, int, int, int) or DLITypeInfo(String, String, int, int, int, String) constructors for these types. It provides functionality to provide an alias for the key and search fields. This alias name is not limited to 8 characters.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: CHAR, INTEGER, DOUBLE, FLOAT, BIT, BLOB, BIGINT, TINYINT, BINARY, and SMALLINT. Certain types have predefined lengths and cannot be changed. The INTEGER and FLOAT types are always 4 bytes long. The DOUBLE and BIGINT types are always 8 bytes long. The SMALLINT type is always 2 bytes long. The TINYINT and BIT types are always 1 byte long. If another length value is specified for one of these types, an exception will be thrown.

Parameters:

fieldName - The name of the field. This name can be an alias that maps to the the actual name as defined in the DBD source file, which is given by the searchFieldName parameter.

type - the type of the field

startingOffset - the starting offset in the I/O area of this field, beginning at offset 1

length - the length, in bytes, of this field

searchFieldName - the name of the search or key field exactly as defined in the DBD source file

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   int type,
                   int startingOffset,
                   int length,
                   java.lang.String searchFieldName,
                   com.ibm.ims.base.DBType dbType,
                   boolean isRoot)

Constructs a DLITypeInfo object. Use this constructor only for non-key and non-search fields. For all other field types, including zoned decimal, packed decimal, date, time, and timestamp, use either DLITypeInfo(String, String, int, int, int) or DLITypeInfo(String, String, int, int, int, String) constructors for these types. It provides functionality to provide an alias for the key and search fields. This alias name is not limited to 8 characters.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: CHAR, INTEGER, DOUBLE, FLOAT, BIT, BLOB, BIGINT, TINYINT, BINARY, and SMALLINT. Certain types have predefined lengths and cannot be changed. The INTEGER and FLOAT types are always 4 bytes long. The DOUBLE and BIGINT types are always 8 bytes long. The SMALLINT type is always 2 bytes long. The TINYINT and BIT types are always 1 byte long. If another length value is specified for one of these types, an exception will be thrown.

Parameters:

fieldName - The name of the field. This name can be an alias that maps to the the actual name as defined in the DBD source file, which is given by the searchFieldName parameter.

type - the type of the field

startingOffset - the starting offset in the I/O area of this field, beginning at offset 1

length - the length, in bytes, of this field

searchFieldName - the name of the search or key field exactly as defined in the DBD source file

dbType - the database type

isRoot - true if field is a unique key of a direct access database (DEDB, HDAM, PHDAM) root segment

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   int type,
                   int startingOffset,
                   int length,
                   java.lang.String searchFieldName,
                   int keyType)

Constructs a DLITypeInfo object, adding the ability to specify a key type. Values include: NOT_KEY indicates field is not a key field (default) UNIQUE_KEY indicates field is a (or part of) a unique key NON_UNIQUE_KEY indicates field is a (or part of) a non-unique key

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   int type,
                   int startingOffset,
                   int length,
                   java.lang.String searchFieldName,
                   int keyType,
                   com.ibm.ims.base.DBType dbType,
                   boolean isRoot)

Constructs a DLITypeInfo object, adding the ability to specify a key type and db type. Key values include: NOT_KEY indicates field is not a key field (default) UNIQUE_KEY indicates field is a (or part of) a unique key NON_UNIQUE_KEY indicates field is a (or part of) a non-unique key

Parameters:

dbType - the database type

isRoot - true if field is a unique key of a direct access database (DEDB, HDAM, PHDAM) root segment

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   java.lang.String typeQualifier,
                   int type,
                   int startingOffset,
                   int length)

Constructs a DLITypeInfo object. This constructor is to be used with non-key and non-search fields of zoned or packed decimal, Date/Time/Timestamp data, or clob strings. Use the DLITypeInfo(String, String, int, int, int) or DLITypeInfo(String, String, int, int, int, String) constructors for all other types. The uses of the type qualifier are as follows: If the field type is either packed or zoned decimal, the type qualifier is the PICTURE string representing the layout of the field. All COBOL PICTURE strings containing valid combinations of 9s, Vs, and Ss are supported. If the field contains Date/Time/Timestamp data, the type qualifier specifies the format of the data. For example, a type qualifier of ddMMyyyy indicates that the data is formatted as follows: 02011999 is January 2, 1999. For DATE and TIME, all formatting options in the java.text.SimpleDateFormat class are supported. For the TIMESTAMP type an additional formatting option 'f' has been provided for nanoseconds. TIMESTAMP can contain up to 9 'f's and replaces the 'S' options for milliseconds; instead, 'fff' indicates milliseconds of precision. An example TIMESTAMP format is yyyy-mm-dd hh:mm:ss.fffffffff If the field type is a CLOB the type qualifier is the name of the child overflow segment. The child overflow segment is used to store any overflow characters after the first length-4 characters which will be stored in this field. This base field will only hold length-4 characters since the CLOB field type reserves the first 4 bytes for version info and length.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: CLOB, DATE, TIME, TIMESTAMP, ZONEDDECIMAL and PACKEDDECIMAL.

Parameters:

fieldName - The name of the field.

typeQualifier - the type qualifier for the field, or the child overflow segment name, as described above

type - the type of the field

startingOffset - the starting offset in the I/O area of this field, beginning at offset 1

length - the length of the field for a PACKEDDECIMAL number, the length can be calculated with the following function: ceiling((number of digits + 1)/2) for a ZONEDDECIMAL number, the length can be calculated with the following function: number of digits + 1 (if the decimal is stored in memory) number of digits (if the decimal is not stored in memory)

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   java.lang.String xmlSchema,
                   int type)

Constructs a DLITypeInfo object. This constructor is to be used for virtual XML columns.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: XML,

Parameters:

fieldName - The name of the field.

xmlSchema - The xmlSchema name

type - the type of the field

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   java.lang.String overflowSegment,
                   java.lang.String xmlSchema,
                   int type,
                   int startingOffset,
                   int length)

Constructs a DLITypeInfo object. This constructor is to be used for virtual XML columns for intact data.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: XML,

Parameters:

fieldName - The name of the field.

overflowSegment - Child overflow segment name, as described above

xmlSchema - The xmlSchema name

type - the type of the field

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   java.lang.String typeQualifier,
                   int type,
                   int startingOffset,
                   int length,
                   com.ibm.ims.base.DBType dbType,
                   boolean isRoot)

Constructs a DLITypeInfo object. Use this constructor only for non-key and non-search fields. For all other field types, including zoned decimal, packed decimal, date, time, and timestamp, use either DLITypeInfo(String, String, int, int, int) or DLITypeInfo(String, String, int, int, int, String) constructors for all other types. The uses of the type qualifier are as follows: If the field type is either packed or zoned decimal, the type qualifier is the PICTURE string representing the layout of the field. All COBOL PICTURE strings containing valid combinations of 9s, Vs, and Ss are supported. If the field contains Date/Time/Timestamp data, the type qualifier specifies the format of the data. For example, a type qualifier of ddMMyyyy indicates that the data is formatted as follows: 02011999 is January 2, 1999. For DATE and TIME, all formatting options in the java.text.SimpleDateFormat class are supported. For the TIMESTAMP type an additional formatting option 'f' has been provided for nanoseconds. TIMESTAMP can contain up to 9 'f's and replaces the 'S' options for milliseconds; instead, 'fff' indicates milliseconds of precision. An example TIMESTAMP format is yyyy-mm-dd hh:mm:ss.fffffffff If the field type is a CLOB the type qualifier is the name of the child overflow segment. The child overflow segment is used to store any overflow characters after the first length-4 characters which will be stored in this field. This base field will only hold length-4 characters since the CLOB field type reserves the first 4 bytes for version info and length.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: CLOB, DATE, TIME, TIMESTAMP, ZONEDDECIMAL and PACKEDDECIMAL.

Parameters:

fieldName - The name of the field.

typeQualifier - the type qualifier for the field, or the child overflow segment name, as described above

type - the type of the field

startingOffset - the starting offset in the I/O area of this field, beginning at offset 1

length - the length of the field for a PACKEDDECIMAL number, the length can be calculated with the following function: ceiling((number of digits + 1)/2) for a ZONEDDECIMAL number, the length can be calculated with the following function: number of digits + 1 (if the decimal is stored in memory) number of digits (if the decimal is not stored in memory)

dbType - the database type

isRoot - true if field is a unique key of a direct access database (DEDB, HDAM, PHDAM) root segment

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   java.lang.String typeQualifier,
                   int type,
                   int startingOffset,
                   int length,
                   java.lang.String searchFieldName)

Constructs a DLITypeInfo object. Use this constructor only for non-key and non-search fields. For all other field types, including zoned decimal, packed decimal, date, time, and timestamp, use either DLITypeInfo(String, String, int, int, int) or DLITypeInfo(String, String, int, int, int, String, int) constructors for all other types. This constructor provides functionality to provide an alias for the key and search fields. This alias name is not limited to 8 characters. The uses of the type qualifier are as follows: If the field type is either packed or zoned decimal, the type qualifier is the PICTURE string representing the layout of the field. All COBOL PICTURE strings containing valid combinations of 9s, Vs, and Ss are supported. If the field contains Date/Time/Timestamp data, the type qualifier specifies the format of the data. For example, a type qualifier of ddMMyyyy indicates that the data is formatted as follows: 02011999 is January 2, 1999. For DATE and TIME, all formatting options in the java.text.SimpleDateFormat class are supported. For the TIMESTAMP type an additional formatting option 'f' has been provided for nanoseconds. TIMESTAMP can contain up to 9 'f's and replaces the 'S' options for milliseconds; instead, 'fff' indicates milliseconds of precision. An example TIMESTAMP format is yyyy-mm-dd hh:mm:ss.fffffffff If the field type is a CLOB the type qualifier is the name of the child overflow segment. The child overflow segment is used to store any overflow characters after the first length-4 characters which will be stored in this field. This base field will only hold length-4 characters since the CLOB field type reserves the first 4 bytes for version info and length.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: CLOB, DATE, TIME, TIMESTAMP, ZONEDDECIMAL and PACKEDDECIMAL.

Parameters:

fieldName - The name of the field. This name can be an alias that maps to the the actual name as defined in the DBD source file, which is given by the searchFieldName parameter.

typeQualifier - the type qualifier for the field

type - the type of the field

startingOffset - the starting offset in the I/O area of this field, beginning at offset 1

length - the length of the field

searchFieldName - the name of the search or key field exactly as defined in the DBD source file

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   java.lang.String typeQualifier,
                   int type,
                   int startingOffset,
                   int length,
                   java.lang.String searchFieldName,
                   com.ibm.ims.base.DBType dbType,
                   boolean isRoot)

Constructs a DLITypeInfo object. Use this constructor only for non-key and non-search fields. For all other field types, including zoned decimal, packed decimal, date, time, and timestamp, use either DLITypeInfo(String, String, int, int, int) or DLITypeInfo(String, String, int, int, int, String, int) constructors for all other types. This constructor provides functionality to provide an alias for the key and search fields. This alias name is not limited to 8 characters. The uses of the type qualifier are as follows: If the field type is either packed or zoned decimal, the type qualifier is the PICTURE string representing the layout of the field. All COBOL PICTURE strings containing valid combinations of 9s, Vs, and Ss are supported. If the field contains Date/Time/Timestamp data, the type qualifier specifies the format of the data. For example, a type qualifier of ddMMyyyy indicates that the data is formatted as follows: 02011999 is January 2, 1999. For DATE and TIME, all formatting options in the java.text.SimpleDateFormat class are supported. For the TIMESTAMP type an additional formatting option 'f' has been provided for nanoseconds. TIMESTAMP can contain up to 9 'f's and replaces the 'S' options for milliseconds; instead, 'fff' indicates milliseconds of precision. An example TIMESTAMP format is yyyy-mm-dd hh:mm:ss.fffffffff If the field type is a CLOB the type qualifier is the name of the child overflow segment. The child overflow segment is used to store any overflow characters after the first length-4 characters which will be stored in this field. This base field will only hold length-4 characters since the CLOB field type reserves the first 4 bytes for version info and length.

The DLITypeInfo class defines several constants that can be supplied as values for the type argument: CLOB, DATE, TIME, TIMESTAMP, ZONEDDECIMAL and PACKEDDECIMAL.

Parameters:

fieldName - The name of the field. This name can be an alias that maps to the the actual name as defined in the DBD source file, which is given by the searchFieldName parameter.

typeQualifier - the type qualifier for the field

type - the type of the field

startingOffset - the starting offset in the I/O area of this field, beginning at offset 1

length - the length of the field

searchFieldName - the name of the search or key field exactly as defined in the DBD source file

dbType - the database type

isRoot - true if field is a unique key of a direct access database (DEDB, HDAM, PHDAM) root segment

Throws:

java.lang.IllegalArgumentException - if the starting offset is less than zero, an unsupported type is given, or an invalid length is given

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   java.lang.String typeQualifier,
                   int type,
                   int startingOffset,
                   int length,
                   java.lang.String searchFieldName,
                   int keyType)

Constructs a DLITypeInfo object, adding the ability to specify a key type. Values include: NOT_KEY indicates field is not a key field (default) UNIQUE_KEY indicates field is a (or part of) a unique key NON_UNIQUE_KEY indicates field is a (or part of) a non-unique key

DLITypeInfo

public DLITypeInfo(java.lang.String fieldName,
                   java.lang.String typeQualifier,
                   int type,
                   int startingOffset,
                   int length,
                   java.lang.String searchFieldName,
                   int keyType,
                   com.ibm.ims.base.DBType dbType,
                   boolean isRoot)

Constructs a DLITypeInfo object, adding the ability to specify a key type and db type. Key values include: NOT_KEY indicates field is not a key field (default) UNIQUE_KEY indicates field is a (or part of) a unique key NON_UNIQUE_KEY indicates field is a (or part of) a non-unique key

Parameters:

dbType - the database type

isRoot - true if field is a unique key of a direct access database (DEDB, HDAM, PHDAM) root segment

Method Detail

getFieldLength

public int getFieldLength()

Returns the length of the field's value in the segment.

Returns:

int the length, in bytes

getFieldName

public java.lang.String getFieldName()

Returns the field name given to this field in the segment.

Returns:

String the name of the field

getFieldOffset

public int getFieldOffset()

Returns the offset of the field in the segment's I/O area.

Returns:

int the zero-based offset

getXmlSchema

public java.lang.String getXmlSchema()

Returns the XML Schema assigned to a field's value in the segment.

Returns:

String the XML Schema associated

getFieldType

public int getFieldType()

Returns the type assigned to a field's value in the segment.

Returns:

int the type

getKeyType

public int getKeyType()

Returns the type of key the field is: DLITypeInfo.NOT_KEY DLITypeInfo.UNIQUE_KEY DLITypeInfo.NON_UNIQUE_KEY

getSearchFieldName

public java.lang.String getSearchFieldName()

Returns the search field name given to this field in the segment, which must be exactly as defined in the DBD source file.

Returns:

String the name of the search field as defined in the DBD source file

getTypeQualifier

public java.lang.String getTypeQualifier()

Returns the type qualifier for this type.

Returns:

the type qualifier

getDBType

public com.ibm.ims.base.DBType getDBType()

Returns the DBType for this DLITypeInfo

Returns:

DBType

getIsRoot

public boolean getIsRoot()

Indicates if this DLITypeInfo is a root

getScale

public int getScale()
             throws DLIException

Returns the scale of a BigDecimal

Returns:

the scale

Throws:

DLIException

getPrecision

public int getPrecision()
                 throws DLIException

Returns the precision of a BigDecimal

Returns:

the precision

Throws:

DLIException

isSigned

public boolean isSigned()

Indicates whether this type is signed.