RDBMSColumnInfo (DataNucleus RDBMS plugin 5.2.5-SNAPSHOT API)

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
```
Representation of column schema information in the datastore.

Field Summary

Fields
Modifier and Type	Field and Description
`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

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`setColumnDef(String def)`
`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
  - RDBMSColumnInfo
```
public RDBMSColumnInfo(ResultSet rs)
```
    Constructor to create a column info definition for the current row of the passed ResultSet.
    
    Parameters:
    
    rs - ResultSet (from DatabaseMetaData.getColumns() for example).
    
    Throws:
    
    org.datanucleus.exceptions.NucleusDataStoreException - Thrown if an error occurs getting the information
- Method Detail
  - setParent
```
public void setParent(org.datanucleus.store.schema.StoreSchemaData parent)
```
    Mutator for the parent component.
    
    Specified by:
    
    setParent in interface org.datanucleus.store.schema.ListStoreSchemaData
    
    Parameters:
    
    parent - Parent component
  - getParent
```
public org.datanucleus.store.schema.StoreSchemaData getParent()
```
    Accessor for the parent Table schema component.
    
    Specified by:
    
    getParent in interface org.datanucleus.store.schema.ListStoreSchemaData
    
    Returns:
    
    Table schema
  - setDecimalDigits
```
public void setDecimalDigits(int digits)
```
  - setDataType
```
public void setDataType(short type)
```
  - setColumnSize
```
public void setColumnSize(int size)
```
  - setColumnDef
```
public void setColumnDef(String def)
```
  - getDecimalDigits
```
public int getDecimalDigits()
```
  - getIsNullable
```
public String getIsNullable()
```
  - getNullable
```
public int getNullable()
```
  - getColumnSize
```
public int getColumnSize()
```
  - getDataType
```
public short getDataType()
```
  - getNumPrecRadix
```
public int getNumPrecRadix()
```
  - getCharOctetLength
```
public int getCharOctetLength()
```
  - getOrdinalPosition
```
public int getOrdinalPosition()
```
  - getColumnDef
```
public String getColumnDef()
```
  - getRemarks
```
public String getRemarks()
```
  - getTypeName
```
public String getTypeName()
```
  - getTableName
```
public String getTableName()
```
  - getColumnName
```
public String getColumnName()
```
  - getTableCat
```
public String getTableCat()
```
  - getTableSchem
```
public String getTableSchem()
```
  - addProperty
```
public void addProperty(String name,
                        Object value)
```
    Method to add a property for the column.
    
    Specified by:
    
    addProperty in interface org.datanucleus.store.schema.StoreSchemaData
    
    Parameters:
    
    name - Name of property
    
    value - Its value
  - getProperty
```
public Object getProperty(String name)
```
    Accessor for a property.
    
    Specified by:
    
    getProperty in interface org.datanucleus.store.schema.StoreSchemaData
    
    Parameters:
    
    name - Name of the property
    
    Returns:
    
    Its value, or null if not defined
  - addChild
```
public void addChild(org.datanucleus.store.schema.StoreSchemaData child)
```
    Specified by:
    
    addChild in interface org.datanucleus.store.schema.ListStoreSchemaData
  - clearChildren
```
public void clearChildren()
```
    Method to remove all children.
    
    Specified by:
    
    clearChildren in interface org.datanucleus.store.schema.ListStoreSchemaData
  - getChild
```
public org.datanucleus.store.schema.StoreSchemaData getChild(int position)
```
    Specified by:
    
    getChild in interface org.datanucleus.store.schema.ListStoreSchemaData
  - getChildren
```
public List getChildren()
```
    Specified by:
    
    getChildren in interface org.datanucleus.store.schema.ListStoreSchemaData
  - getNumberOfChildren
```
public int getNumberOfChildren()
```
    Specified by:
    
    getNumberOfChildren in interface org.datanucleus.store.schema.ListStoreSchemaData
  - equals
```
public final boolean equals(Object obj)
```
    Indicates whether some object is "equal to" this one. Two RDBMSColumnInfo are considered equal if their catalog, schema, table, and column name are all equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare
    
    Returns:
    
    true if this object is equal to the obj argument; false otherwise.
  - hashCode
```
public final int hashCode()
```
    Returns a hash code value for this object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
  - toString
```
public String toString()
```
    Returns the string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of this object.

Class RDBMSColumnInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tableCat

tableSchem

tableName

columnName

dataType

typeName

columnSize

decimalDigits

numPrecRadix

nullable

remarks

columnDef

charOctetLength

ordinalPosition

isNullable

Constructor Detail

RDBMSColumnInfo

Method Detail

setParent

getParent

setDecimalDigits

setDataType

setColumnSize

setColumnDef

getDecimalDigits

getIsNullable

getNullable

getColumnSize

getDataType

getNumPrecRadix

getCharOctetLength

getOrdinalPosition

getColumnDef

getRemarks

getTypeName

getTableName

getColumnName

getTableCat

getTableSchem

addProperty

getProperty

addChild

clearChildren

getChild

getChildren

getNumberOfChildren

equals

hashCode

toString