com.wrq.apptrieve.appconn
Class ColumnMetaData

java.lang.Object
  extended by com.wrq.apptrieve.appconn.ColumnMetaData
All Implemented Interfaces:
AppConnMetaData

public class ColumnMetaData
extends java.lang.Object
implements AppConnMetaData

Provides metadata about a column that is defined in a table of a Host Integrator model.


Field Summary
static int COLUMN_TYPE_FLOAT
          Return value of getType() for Float columns.
static int COLUMN_TYPE_INTEGER
          Return value of getType() for Integer columns.
static int COLUMN_TYPE_TEXT
          Return value of getType() for Text columns.
 
Fields inherited from interface com.wrq.apptrieve.appconn.AppConnMetaData
METADATA_TYPE_ATTRIBUTE, METADATA_TYPE_COLUMN, METADATA_TYPE_FIELD, METADATA_TYPE_OPERATION, METADATA_TYPE_PROCEDURE, METADATA_TYPE_RECORDSET, METADATA_TYPE_VARIABLE
 
Constructor Summary
ColumnMetaData(TableColumnMeta saObject)
          Constructor for internal use only.
 
Method Summary
 java.lang.String getDescription()
          Gets the description for the column as specified in the Design Tool.
 int getMax()
          Gets the maximum value or number of characters for the column.
 int getMetaDataType()
          Gets the meta data type for this object.
 int getMin()
          Gets the minimum value or number of characters for the column.
 java.lang.String getName()
          Gets the name of the column.
 int getType()
          Gets the data type of the column.
 boolean isKey()
          Discovers whether this column is defined to be the key or part of the key for the table.
 java.lang.String toString()
          Generates a String object that represents the current values of this ColumnMetaData object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COLUMN_TYPE_INTEGER

public static final int COLUMN_TYPE_INTEGER
Return value of getType() for Integer columns.


COLUMN_TYPE_TEXT

public static final int COLUMN_TYPE_TEXT
Return value of getType() for Text columns.


COLUMN_TYPE_FLOAT

public static final int COLUMN_TYPE_FLOAT
Return value of getType() for Float columns.

Constructor Detail

ColumnMetaData

public ColumnMetaData(TableColumnMeta saObject)
Constructor for internal use only.

Parameters:
saObject - data
Method Detail

getDescription

public java.lang.String getDescription()
Gets the description for the column as specified in the Design Tool.

Specified by:
getDescription in interface AppConnMetaData
Returns:
String the description

getMax

public int getMax()
Gets the maximum value or number of characters for the column. For text columns, returns the maximum length of the text. For integer columns, returns the maximum value of the integer.

Returns:
int maximum length of text, value of integers

getMetaDataType

public int getMetaDataType()
Gets the meta data type for this object.

Specified by:
getMetaDataType in interface AppConnMetaData
Returns:
int - always returns AppConnMetaData.METADATA_TYPE_COLUMN

getMin

public int getMin()
Gets the minimum value or number of characters for the column. For text columns, returns the minimum length of the text. For integer columns, returns the minimum value of the integer.

Returns:
int minimum length of text, value of integers

getName

public java.lang.String getName()
Gets the name of the column.

Specified by:
getName in interface AppConnMetaData
Returns:
String the name

getType

public int getType()
Gets the data type of the column.

The returned value is one of:

Returns:
int - enumeration of the column type

isKey

public boolean isKey()
Discovers whether this column is defined to be the key or part of the key for the table.

A key can be a single column or composed of multiple columns.

Returns:
boolean true if the column is defined as a key for the table

toString

public java.lang.String toString()
Generates a String object that represents the current values of this ColumnMetaData object.

Overrides:
toString in class java.lang.Object
Returns:
java.lang.String - the string representation of this object