ColumnImpl (DataNucleus RDBMS 3.2.9 API)

java.lang.Object
- org.datanucleus.store.rdbms.table.ColumnImpl

All Implemented Interfaces:

Column
```
public class ColumnImpl
extends Object
implements Column
```
Implementation of a Column in an RDBMS datastore. Contains the full definition of the column, its type, size, whether it is identity, nullable, part of the PK etc. The SQL column definition is generated here.

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.datanucleus.metadata.ColumnMetaData`	`columnMetaData` ColumnMetaData for this column.
`protected String`	`constraints` Optional constraints to apply to this column in its SQL specification.
`protected DatastoreMapping`	`datastoreMapping` Datastore mapping for this column.
`protected Object`	`defaultValue` Default value accepted by the datastore for this column, from DatabaseMetaData.
`protected byte`	`flags` Operational flags, for nullability, PK, autoinc, etc.
`protected DatastoreIdentifier`	`identifier` Identifier for the column in the datastore.
`protected String`	`storedJavaType` Java type that this column is storing.
`protected Table`	`table` Table containing this column in the datastore.
`protected SQLTypeInfo`	`typeInfo` SQL Type info for the JDBC type being stored in this column
`protected String[]`	`wrapperFunction` Function wrapping the column (for example, SQRT(COLUMN)).

Fields inherited from interface org.datanucleus.store.rdbms.table.Column
WRAPPER_FUNCTION_INSERT, WRAPPER_FUNCTION_SELECT, WRAPPER_FUNCTION_UPDATE

Constructor Summary

Constructors
Constructor and Description
`ColumnImpl(Table table, String javaType, DatastoreIdentifier identifier, org.datanucleus.metadata.ColumnMetaData colmd)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`applySelectFunction(String replacementValue)` Wraps the column name with a FUNCTION.
`void`	`checkDecimal()` Checks the column definition as a decimal.
`void`	`checkInteger()` Checks the column definition as an integer.
`void`	`checkPrimitive()` Checks the column definition as a primitive.
`void`	`checkString()` Checks the column definition as a string.
`void`	`copyConfigurationTo(Column colIn)` Copy the configuration of this field to another field
`boolean`	`equals(Object obj)`
`org.datanucleus.metadata.ColumnMetaData`	`getColumnMetaData()` Access the metadata definition defining this column.
`String`	`getConstraints()`
`DatastoreMapping`	`getDatastoreMapping()` Accessor for the datastore mapping that this datastore field relates to.
`Object`	`getDefaultValue()` Accessor for the default Value
`DatastoreIdentifier`	`getIdentifier()` Accessor for the identifier for this object.
`JavaTypeMapping`	`getJavaTypeMapping()` Accessor for the JavaTypeMapping for the field/property that owns this column.
`int`	`getJdbcType()` Accessor for the JDBC type being used for this Column
`org.datanucleus.metadata.AbstractMemberMetaData`	`getMemberMetaData()` Accessor for the MetaData of the field/property that this is the datastore field for.
`String`	`getSQLDefinition()` Accessor for the SQL definition of this column.
`String`	`getStoredJavaType()` Accessor for the type of data stored in this field.
`RDBMSStoreManager`	`getStoreManager()` Accessor for the StoreManager for this table.
`Table`	`getTable()` Accessor for the table for this column
`SQLTypeInfo`	`getTypeInfo()` Accessor for the type info for this column.
`String`	`getWrapperFunction(int wrapperMode)` Gets the wrapper for parameters.
`int`	`hashCode()`
`void`	`initializeColumnInfoFromDatastore(RDBMSColumnInfo ci)` Initialize the default column value and auto increment
`boolean`	`isDefaultable()` Accessor for whether the column is defaultable.
`boolean`	`isIdentity()` Accessor for the whether this column is an identity column.
`boolean`	`isNullable()` Accessor for whether the field is nullable in the datastore.
`boolean`	`isPrimaryKey()` Accessor for whether the field is the primary key in the datastore.
`boolean`	`isUnique()` Accessor for whether the column is unique.
`boolean`	`isUnlimitedLength()` Convenience method to check if the length is required to be unlimited (BLOB/CLOB).
`void`	`setAsPrimaryKey()` Mutator to make the field the primary key.
`void`	`setColumnMetaData(org.datanucleus.metadata.ColumnMetaData colmd)` Method to set the MetaData for this datastore field.
`Column`	`setConstraints(String constraints)` Mutator for the constraints of the column.
`void`	`setDatastoreMapping(DatastoreMapping mapping)` Method to associate this datastore field with its mapping.
`Column`	`setDefaultable()` Mutator for the defaultability of the datastore field.
`void`	`setDefaultValue(Object object)` Mutator for the default Value
`void`	`setIdentifier(DatastoreIdentifier identifier)` Mutator for the identifier of the column.
`Column`	`setIdentity(boolean identity)` Mutator for whether we set this column as an identity column.
`Column`	`setNullable()` Mutator for the nullability of the datastore field.
`Column`	`setTypeInfo(SQLTypeInfo typeInfo)` Mutator for the type information of the column.
`Column`	`setUnique()` Mutator for the uniqueness of the column.
`void`	`setWrapperFunction(String wrapperFunction, int wrapperMode)` Sets a function to wrap the column.
`String`	`toString()`
`void`	`validate(RDBMSColumnInfo ci)` Method to validate the contents of the column.

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

- Field Detail
  - identifier
```
protected DatastoreIdentifier identifier
```
    Identifier for the column in the datastore.
  - columnMetaData
```
protected org.datanucleus.metadata.ColumnMetaData columnMetaData
```
    ColumnMetaData for this column.
  - table
```
protected final Table table
```
    Table containing this column in the datastore.
  - datastoreMapping
```
protected DatastoreMapping datastoreMapping
```
    Datastore mapping for this column.
  - storedJavaType
```
protected final String storedJavaType
```
    Java type that this column is storing. (can we just get this from the mapping above ?)
  - typeInfo
```
protected SQLTypeInfo typeInfo
```
    SQL Type info for the JDBC type being stored in this column
  - constraints
```
protected String constraints
```
    Optional constraints to apply to this column in its SQL specification.
  - flags
```
protected byte flags
```
    Operational flags, for nullability, PK, autoinc, etc.
  - defaultValue
```
protected Object defaultValue
```
    Default value accepted by the datastore for this column, from DatabaseMetaData.
  - wrapperFunction
```
protected String[] wrapperFunction
```
    Function wrapping the column (for example, SQRT(COLUMN)).
- Constructor Detail
  - ColumnImpl
```
public ColumnImpl(Table table,
          String javaType,
          DatastoreIdentifier identifier,
          org.datanucleus.metadata.ColumnMetaData colmd)
```
    Constructor.
    
    Parameters:
    table - The table in the datastore that this column belongs to.
    javaType - The type of data being stored in this column
    identifier - The identifier of the column (in the datastore).
    colmd - The ColumnMetaData for this column
- Method Detail
  - isUnlimitedLength
```
public boolean isUnlimitedLength()
```
    Description copied from interface: Column
    
    Convenience method to check if the length is required to be unlimited (BLOB/CLOB).
    
    Specified by:
    
    isUnlimitedLength in interface Column
    
    Returns:
    Whether unlimited length required.
  - getIdentifier
```
public DatastoreIdentifier getIdentifier()
```
    Description copied from interface: Column
    
    Accessor for the identifier for this object.
    
    Specified by:
    
    getIdentifier in interface Column
    
    Returns:
    The identifier.
  - setIdentifier
```
public void setIdentifier(DatastoreIdentifier identifier)
```
    Description copied from interface: Column
    
    Mutator for the identifier of the column.
    
    Specified by:
    
    setIdentifier in interface Column
    
    Parameters:
    identifier - The identifier
  - getTable
```
public Table getTable()
```
    Description copied from interface: Column
    
    Accessor for the table for this column
    
    Specified by:
    
    getTable in interface Column
    
    Returns:
    The table
  - getDatastoreMapping
```
public DatastoreMapping getDatastoreMapping()
```
    Description copied from interface: Column
    
    Accessor for the datastore mapping that this datastore field relates to.
    
    Specified by:
    
    getDatastoreMapping in interface Column
    
    Returns:
    The datastore mapping
  - setDatastoreMapping
```
public void setDatastoreMapping(DatastoreMapping mapping)
```
    Description copied from interface: Column
    
    Method to associate this datastore field with its mapping.
    
    Specified by:
    
    setDatastoreMapping in interface Column
    
    Parameters:
    mapping - The mapping for this datastore field
  - getJavaTypeMapping
```
public JavaTypeMapping getJavaTypeMapping()
```
    Description copied from interface: Column
    
    Accessor for the JavaTypeMapping for the field/property that owns this column.
    
    Specified by:
    
    getJavaTypeMapping in interface Column
    
    Returns:
    The JavaTypeMapping
  - getStoredJavaType
```
public String getStoredJavaType()
```
    Description copied from interface: Column
    
    Accessor for the type of data stored in this field.
    
    Specified by:
    
    getStoredJavaType in interface Column
    
    Returns:
    The type of data in the field.
  - getTypeInfo
```
public final SQLTypeInfo getTypeInfo()
```
    Description copied from interface: Column
    
    Accessor for the type info for this column.
    
    Specified by:
    
    getTypeInfo in interface Column
    
    Returns:
    The type info
  - getJdbcType
```
public int getJdbcType()
```
    Description copied from interface: Column
    
    Accessor for the JDBC type being used for this Column
    
    Specified by:
    
    getJdbcType in interface Column
    
    Returns:
    The JDBC data type
  - getStoreManager
```
public RDBMSStoreManager getStoreManager()
```
    Description copied from interface: Column
    
    Accessor for the StoreManager for this table.
    
    Specified by:
    
    getStoreManager in interface Column
    
    Returns:
    The StoreManager.
  - getSQLDefinition
```
public String getSQLDefinition()
```
    Description copied from interface: Column
    
    Accessor for the SQL definition of this column.
    
    Specified by:
    
    getSQLDefinition in interface Column
    
    Returns:
    The SQL definition of the column
  - initializeColumnInfoFromDatastore
```
public void initializeColumnInfoFromDatastore(RDBMSColumnInfo ci)
```
    Description copied from interface: Column
    
    Initialize the default column value and auto increment
    
    Specified by:
    
    initializeColumnInfoFromDatastore in interface Column
    
    Parameters:
    ci - The column information
  - validate
```
public void validate(RDBMSColumnInfo ci)
```
    Description copied from interface: Column
    
    Method to validate the contents of the column. This method can throw IncompatibleDataTypeException, WrongScaleException, WrongPrecisionException, IsNullableException if the data in the column is not compatible with the supplied ColumnInfo.
    
    Specified by:
    
    validate in interface Column
    
    Parameters:
    ci - The column information taken from the database
  - setTypeInfo
```
public final Column setTypeInfo(SQLTypeInfo typeInfo)
```
    Description copied from interface: Column
    
    Mutator for the type information of the column.
    
    Specified by:
    
    setTypeInfo in interface Column
    
    Parameters:
    typeInfo - The type info
    
    Returns:
    The column with the updated info
  - setConstraints
```
public final Column setConstraints(String constraints)
```
    Description copied from interface: Column
    
    Mutator for the constraints of the column.
    
    Specified by:
    
    setConstraints in interface Column
    
    Parameters:
    constraints - The constraints
    
    Returns:
    The column with the updated info
  - setAsPrimaryKey
```
public final void setAsPrimaryKey()
```
    Description copied from interface: Column
    
    Mutator to make the field the primary key.
    
    Specified by:
    
    setAsPrimaryKey in interface Column
  - setNullable
```
public final Column setNullable()
```
    Description copied from interface: Column
    
    Mutator for the nullability of the datastore field.
    
    Specified by:
    
    setNullable in interface Column
    
    Returns:
    The datastore field with the updated info
  - setDefaultable
```
public final Column setDefaultable()
```
    Description copied from interface: Column
    
    Mutator for the defaultability of the datastore field.
    
    Specified by:
    
    setDefaultable in interface Column
    
    Returns:
    The datastore field with the updated info
  - setUnique
```
public final Column setUnique()
```
    Description copied from interface: Column
    
    Mutator for the uniqueness of the column.
    
    Specified by:
    
    setUnique in interface Column
    
    Returns:
    The datastore field with the updated info
  - setIdentity
```
public Column setIdentity(boolean identity)
```
    Description copied from interface: Column
    
    Mutator for whether we set this column as an identity column. An "identity" column is typically treated differently in the datastore being given a value by the datastore itself. In RDBMS this would mean that the column is "AUTO_INCREMENT", "SERIAL" or
    
    Specified by:
    
    setIdentity in interface Column
    
    Parameters:
    identity - True if column is identity
  - isPrimaryKey
```
public final boolean isPrimaryKey()
```
    Description copied from interface: Column
    
    Accessor for whether the field is the primary key in the datastore.
    
    Specified by:
    
    isPrimaryKey in interface Column
    
    Returns:
    whether the field is (part of) the primary key
  - isNullable
```
public final boolean isNullable()
```
    Description copied from interface: Column
    
    Accessor for whether the field is nullable in the datastore.
    
    Specified by:
    
    isNullable in interface Column
    
    Returns:
    whether the field is nullable
  - isDefaultable
```
public final boolean isDefaultable()
```
    Description copied from interface: Column
    
    Accessor for whether the column is defaultable.
    
    Specified by:
    
    isDefaultable in interface Column
    
    Returns:
    whether the column is defaultable
  - isUnique
```
public final boolean isUnique()
```
    Description copied from interface: Column
    
    Accessor for whether the column is unique.
    
    Specified by:
    
    isUnique in interface Column
    
    Returns:
    whether the column is unique
  - isIdentity
```
public boolean isIdentity()
```
    Description copied from interface: Column
    
    Accessor for the whether this column is an identity column.
    
    Specified by:
    
    isIdentity in interface Column
    
    Returns:
    true if column is identity.
  - applySelectFunction
```
public String applySelectFunction(String replacementValue)
```
    Description copied from interface: Column
    Wraps the column name with a FUNCTION.
```
example: SQRT(?) generates: SQRT(columnName)
```
    Specified by:
    
    applySelectFunction in interface Column
    
    Parameters:
    replacementValue - the replacement to ?. Probably it's a column name, that may be fully qualified name or not
    
    Returns:
    a String with function taking as parameter the replacementValue
  - getDefaultValue
```
public Object getDefaultValue()
```
    Description copied from interface: Column
    
    Accessor for the default Value
    
    Specified by:
    
    getDefaultValue in interface Column
    
    Returns:
    the default value
  - setDefaultValue
```
public void setDefaultValue(Object object)
```
    Description copied from interface: Column
    
    Mutator for the default Value
    
    Specified by:
    
    setDefaultValue in interface Column
    
    Parameters:
    object - default value
  - getColumnMetaData
```
public final org.datanucleus.metadata.ColumnMetaData getColumnMetaData()
```
    Description copied from interface: Column
    
    Access the metadata definition defining this column.
    
    Specified by:
    
    getColumnMetaData in interface Column
    
    Returns:
    the MetaData
  - getMemberMetaData
```
public org.datanucleus.metadata.AbstractMemberMetaData getMemberMetaData()
```
    Description copied from interface: Column
    
    Accessor for the MetaData of the field/property that this is the datastore field for.
    
    Specified by:
    
    getMemberMetaData in interface Column
    
    Returns:
    MetaData of the field/property (if representing a field/property of a class).
  - setColumnMetaData
```
public void setColumnMetaData(org.datanucleus.metadata.ColumnMetaData colmd)
```
    Description copied from interface: Column
    
    Method to set the MetaData for this datastore field. Should only be called before completion of initialisation.
    
    Specified by:
    
    setColumnMetaData in interface Column
    
    Parameters:
    colmd - The MetaData
  - getConstraints
```
public String getConstraints()
```
    Specified by:
    
    getConstraints in interface Column
    
    Returns:
    Returns the constraints.
  - checkPrimitive
```
public final void checkPrimitive()
                          throws ColumnDefinitionException
```
    Description copied from interface: Column
    
    Checks the column definition as a primitive.
    
    Specified by:
    
    checkPrimitive in interface Column
    
    Throws:
    
    ColumnDefinitionException
  - checkInteger
```
public final void checkInteger()
                        throws ColumnDefinitionException
```
    Description copied from interface: Column
    
    Checks the column definition as an integer.
    
    Specified by:
    
    checkInteger in interface Column
    
    Throws:
    
    ColumnDefinitionException
  - checkDecimal
```
public final void checkDecimal()
                        throws ColumnDefinitionException
```
    Description copied from interface: Column
    
    Checks the column definition as a decimal.
    
    Specified by:
    
    checkDecimal in interface Column
    
    Throws:
    
    ColumnDefinitionException
  - checkString
```
public final void checkString()
                       throws ColumnDefinitionException
```
    Description copied from interface: Column
    
    Checks the column definition as a string.
    
    Specified by:
    
    checkString in interface Column
    
    Throws:
    
    ColumnDefinitionException
  - copyConfigurationTo
```
public void copyConfigurationTo(Column colIn)
```
    Description copied from interface: Column
    
    Copy the configuration of this field to another field
    
    Specified by:
    
    copyConfigurationTo in interface Column
    
    Parameters:
    colIn - the column to copy
  - setWrapperFunction
```
public void setWrapperFunction(String wrapperFunction,
                      int wrapperMode)
```
    Description copied from interface: Column
    Sets a function to wrap the column. The wrapper function String must use "?" to be replaced later by the column name. For example
```
SQRT(?) generates: SQRT(COLUMN)
```
    Specified by:
    
    setWrapperFunction in interface Column
    
    Parameters:
    wrapperFunction - The wrapperFunction to set.
    wrapperMode - whether select, insert or update
  - getWrapperFunction
```
public String getWrapperFunction(int wrapperMode)
```
    Description copied from interface: Column
    
    Gets the wrapper for parameters.
    
    Specified by:
    
    getWrapperFunction in interface Column
    
    Parameters:
    wrapperMode - whether select, insert or update
    
    Returns:
    Returns the wrapperFunction.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ColumnImpl

Field Summary

Fields inherited from interface org.datanucleus.store.rdbms.table.Column

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

identifier

columnMetaData

table

datastoreMapping

storedJavaType

typeInfo

constraints

flags

defaultValue

wrapperFunction

Constructor Detail

ColumnImpl

Method Detail

isUnlimitedLength

getIdentifier

setIdentifier

getTable

getDatastoreMapping

setDatastoreMapping

getJavaTypeMapping

getStoredJavaType

getTypeInfo

getJdbcType

getStoreManager

getSQLDefinition

initializeColumnInfoFromDatastore

validate

setTypeInfo

setConstraints

setAsPrimaryKey

setNullable

setDefaultable

setUnique

setIdentity

isPrimaryKey

isNullable

isDefaultable

isUnique

isIdentity

applySelectFunction

getDefaultValue

setDefaultValue

getColumnMetaData

getMemberMetaData

setColumnMetaData

getConstraints

checkPrimitive

checkInteger

checkDecimal

checkString

copyConfigurationTo

setWrapperFunction

getWrapperFunction

equals

hashCode

toString