RDBMSColumnInfo (DataNucleus RDBMS 3.1.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.datanucleus.store.rdbms.schema
Class RDBMSColumnInfo

java.lang.Object
  org.datanucleus.store.rdbms.schema.RDBMSColumnInfo

All Implemented Interfaces:: org.datanucleus.store.schema.ListStoreSchemaData, org.datanucleus.store.schema.StoreSchemaData

public class RDBMSColumnInfo
extends Object
implements org.datanucleus.store.schema.ListStoreSchemaData
extends Object
implements org.datanucleus.store.schema.ListStoreSchemaData

Representation of column schema information in the datastore.

Field Summary
`protected int`	`charOctetLength` Indicates the maximum number of bytes in the column (for char types only).
`protected String`	`columnDef` The default value for the column; may be `null`.
`protected String`	`columnName` The column name.
`protected int`	`columnSize` The column size.
`protected short`	`dataType` Indicates the JDBC (SQL) data type from `Types`.
`protected int`	`decimalDigits` Indicates the number of fractional digits.
`protected String`	`isNullable` Whether the column definitely doesnt allow NULL values ("NO") or possibly does ("YES").
`protected int`	`nullable` Indicates whether the column can be NULL.
`protected int`	`numPrecRadix` Indicates the radix, which is typically either 10 or 2.
`protected int`	`ordinalPosition` The index of the column in its table; the first column is 1, the second column is 2.
`protected String`	`remarks` An explanatory comment on the column; may be `null`.
`protected String`	`tableCat` The table catalog, which may be `null`.
`protected String`	`tableName` The table name.
`protected String`	`tableSchem` The table schema, which may be `null`.
`protected String`	`typeName` The local type name used by the data source.

Constructor Summary
`RDBMSColumnInfo(ResultSet rs)` Constructor to create a column info definition for the current row of the passed ResultSet.

Method Summary
`void`	`addChild(org.datanucleus.store.schema.StoreSchemaData child)`
`void`	`addProperty(String name, Object value)` Method to add a property for the column.
`void`	`clearChildren()` Method to remove all children.
`boolean`	`equals(Object obj)` Indicates whether some object is "equal to" this one.
`int`	`getCharOctetLength()`
`org.datanucleus.store.schema.StoreSchemaData`	`getChild(int position)`
`List`	`getChildren()`
`String`	`getColumnDef()`
`String`	`getColumnName()`
`int`	`getColumnSize()`
`short`	`getDataType()`
`int`	`getDecimalDigits()`
`String`	`getIsNullable()`
`int`	`getNullable()`
`int`	`getNumberOfChildren()`
`int`	`getNumPrecRadix()`
`int`	`getOrdinalPosition()`
`org.datanucleus.store.schema.StoreSchemaData`	`getParent()` Accessor for the parent Table schema component.
`Object`	`getProperty(String name)` Accessor for a property.
`String`	`getRemarks()`
`String`	`getTableCat()`
`String`	`getTableName()`
`String`	`getTableSchem()`
`String`	`getTypeName()`
`int`	`hashCode()` Returns a hash code value for this object.
`void`	`setColumnSize(int size)`
`void`	`setDataType(short type)`
`void`	`setDecimalDigits(int digits)`
`void`	`setParent(org.datanucleus.store.schema.StoreSchemaData parent)` Mutator for the parent component.
`String`	`toString()` Returns the string representation of this object.

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

tableCat

protected String tableCat

The table catalog, which may be null.

tableSchem

protected String tableSchem

The table schema, which may be null.

tableName

protected String tableName

The table name.

columnName

protected String columnName

The column name.

dataType

protected short dataType

Indicates the JDBC (SQL) data type from Types.

typeName

protected String typeName

The local type name used by the data source.

columnSize

protected int columnSize

The column size. For char/date types, this is the maximum num of chars, otherwise precision.

decimalDigits

protected int decimalDigits

Indicates the number of fractional digits.

numPrecRadix

protected int numPrecRadix

Indicates the radix, which is typically either 10 or 2.

nullable

protected int nullable

Indicates whether the column can be NULL.

remarks

protected String remarks

An explanatory comment on the column; may be null.

columnDef

protected String columnDef

The default value for the column; may be null.

charOctetLength

protected int charOctetLength

Indicates the maximum number of bytes in the column (for char types only).

ordinalPosition

protected int ordinalPosition

The index of the column in its table; the first column is 1, the second column is 2.

isNullable

protected String isNullable

Whether the column definitely doesnt allow NULL values ("NO") or possibly does ("YES").

Constructor Detail