intradoc.data
Class FieldInfo

java.lang.Object
  |
  +--intradoc.data.FieldInfo

public class FieldInfo

extends java.lang.Object

A cross database/storage representation of field type information for a field in a table or parameter list.
Note: If m_type is null then there is no field type information available beyond the index at which the field is located. Depending on where the data was retrieved for creating the result set, there may be less or more information about the field type present.

Field Summary

static short	BINARY Variable length binary data.
static short	BLOB Variable length Binary large object.
static short	BOOLEAN Field holds true or false.
static short	CHAR Field holds a single character.
static short	DATE Field holds a date.
static short	FLOAT Field holds a floating point number (The Java 'double' type is used to hold these values).
static short	INT Field holds an integer.
int	m_index Index in result set row where field is located.
boolean	m_isFixedLen Set to true if field always consumes the same number of characters or bytes.
int	m_maxLen Maximum length of field in characters when translated to a string.
java.lang.String	m_name Name of the field
int	m_type Field type (corresponds to an intersection of MS Access and JDBC field types).
static short	MEMO Variable length Unicode string for memo field.
static short	STRING Field holds a Unicode string (although the source of the string may not be Unicode).

Constructor Summary

FieldInfo()
Default constructor.

Method Summary

void	copy(FieldInfo info) Copies data from the passed parameter into this object.
boolean	equals(java.lang.Object obj) Compares type, name, and length.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BOOLEAN

public static final short BOOLEAN

Field holds true or false.

See Also:

Constant Field Values

CHAR

public static final short CHAR

Field holds a single character.

See Also:

Constant Field Values

INT

public static final short INT

Field holds an integer.

See Also:

Constant Field Values

FLOAT

public static final short FLOAT

Field holds a floating point number (The Java 'double' type is used to hold these values).

See Also:

Constant Field Values

DATE

public static final short DATE

Field holds a date.

See Also:

Constant Field Values

STRING

public static final short STRING

Field holds a Unicode string (although the source of the string may not be Unicode). If m_isFixedLen is set to false then it is a variable length string.

See Also:

Constant Field Values

BINARY

public static final short BINARY

Variable length binary data.

See Also:

Constant Field Values

MEMO

public static final short MEMO

Variable length Unicode string for memo field.

See Also:

Constant Field Values

BLOB

public static final short BLOB

Variable length Binary large object.

See Also:

Constant Field Values

m_index

public int m_index

Index in result set row where field is located.

m_name

public java.lang.String m_name

Name of the field

m_type

public int m_type

Field type (corresponds to an intersection of MS Access and JDBC field types).

m_isFixedLen

public boolean m_isFixedLen

Set to true if field always consumes the same number of characters or bytes. If a character field, then the string returned is always the exact same length (the string is space padded on the right).

m_maxLen

public int m_maxLen

Maximum length of field in characters when translated to a string. The value is a "guess" if it is date or numeric field and is supposed to be a hint to the user interface. For example, a date may only require 8 bytes to store internally but the value of this field might be 20 to indicate that it should require at most 20 characters of string input to specifiy a date. If this value is 0 and m_isFixedLen is false, then the field is a CLOB or a BLOB depending on field type. Presumably if m_maxLen is a very large number then the internal storage also may be a CLOB or a BLOB.

Constructor Detail

FieldInfo

public FieldInfo()

Default constructor. Sets the field to be variable length string with result set lookup index of -1 (m_index is set to -1).

Method Detail

copy

public void copy(FieldInfo info)

Copies data from the passed parameter into this object.

Parameters:

info - The source object.

equals

public boolean equals(java.lang.Object obj)

Compares type, name, and length.

Overrides:

equals in class java.lang.Object

Parameters:

obj - The source object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object