Column (DataNucleus RDBMS 3.2.11 API)

All Known Implementing Classes:

ColumnImpl
```
public interface Column
```
Interface for a column in an RDBMS datastore.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`WRAPPER_FUNCTION_INSERT` wrapper function insert
`static int`	`WRAPPER_FUNCTION_SELECT` wrapper function select
`static int`	`WRAPPER_FUNCTION_UPDATE` wrapper function update

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 col)` Copy the configuration of this field to another field
`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.
`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 md)` 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.
`void`	`validate(RDBMSColumnInfo ci)` Method to validate the contents of the column.

- Field Detail
  - WRAPPER_FUNCTION_SELECT
```
static final int WRAPPER_FUNCTION_SELECT
```
    wrapper function select
    
    See Also:
    Constant Field Values
  - WRAPPER_FUNCTION_INSERT
```
static final int WRAPPER_FUNCTION_INSERT
```
    wrapper function insert
    
    See Also:
    Constant Field Values
  - WRAPPER_FUNCTION_UPDATE
```
static final int WRAPPER_FUNCTION_UPDATE
```
    wrapper function update
    
    See Also:
    Constant Field Values
- Method Detail
  - getStoreManager
```
RDBMSStoreManager getStoreManager()
```
    Accessor for the StoreManager for this table.
    
    Returns:
    The StoreManager.
  - getStoredJavaType
```
String getStoredJavaType()
```
    Accessor for the type of data stored in this field.
    
    Returns:
    The type of data in the field.
  - setIdentifier
```
void setIdentifier(DatastoreIdentifier identifier)
```
    Mutator for the identifier of the column.
    
    Parameters:
    identifier - The identifier
  - getIdentifier
```
DatastoreIdentifier getIdentifier()
```
    Accessor for the identifier for this object.
    
    Returns:
    The identifier.
  - setAsPrimaryKey
```
void setAsPrimaryKey()
```
    Mutator to make the field the primary key.
  - isPrimaryKey
```
boolean isPrimaryKey()
```
    Accessor for whether the field is the primary key in the datastore.
    
    Returns:
    whether the field is (part of) the primary key
  - setNullable
```
Column setNullable()
```
    Mutator for the nullability of the datastore field.
    
    Returns:
    The datastore field with the updated info
  - isNullable
```
boolean isNullable()
```
    Accessor for whether the field is nullable in the datastore.
    
    Returns:
    whether the field is nullable
  - setDefaultable
```
Column setDefaultable()
```
    Mutator for the defaultability of the datastore field.
    
    Returns:
    The datastore field with the updated info
  - isDefaultable
```
boolean isDefaultable()
```
    Accessor for whether the column is defaultable.
    
    Returns:
    whether the column is defaultable
  - setUnique
```
Column setUnique()
```
    Mutator for the uniqueness of the column.
    
    Returns:
    The datastore field with the updated info
  - isUnique
```
boolean isUnique()
```
    Accessor for whether the column is unique.
    
    Returns:
    whether the column is unique
  - setIdentity
```
Column setIdentity(boolean identity)
```
    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
    
    Parameters:
    identity - True if column is identity
  - isIdentity
```
boolean isIdentity()
```
    Accessor for the whether this column is an identity column.
    
    Returns:
    true if column is identity.
  - setDefaultValue
```
void setDefaultValue(Object object)
```
    Mutator for the default Value
    
    Parameters:
    object - default value
  - getDefaultValue
```
Object getDefaultValue()
```
    Accessor for the default Value
    
    Returns:
    the default value
  - setDatastoreMapping
```
void setDatastoreMapping(DatastoreMapping mapping)
```
    Method to associate this datastore field with its mapping.
    
    Parameters:
    mapping - The mapping for this datastore field
  - getDatastoreMapping
```
DatastoreMapping getDatastoreMapping()
```
    Accessor for the datastore mapping that this datastore field relates to.
    
    Returns:
    The datastore mapping
  - setColumnMetaData
```
void setColumnMetaData(org.datanucleus.metadata.ColumnMetaData md)
```
    Method to set the MetaData for this datastore field. Should only be called before completion of initialisation.
    
    Parameters:
    md - The MetaData
  - getColumnMetaData
```
org.datanucleus.metadata.ColumnMetaData getColumnMetaData()
```
    Access the metadata definition defining this column.
    
    Returns:
    the MetaData
  - getJavaTypeMapping
```
JavaTypeMapping getJavaTypeMapping()
```
    Accessor for the JavaTypeMapping for the field/property that owns this column.
    
    Returns:
    The JavaTypeMapping
  - getTable
```
Table getTable()
```
    Accessor for the table for this column
    
    Returns:
    The table
  - applySelectFunction
```
String applySelectFunction(String replacementValue)
```
    Wraps the column name with a FUNCTION.
```
example: SQRT(?) generates: SQRT(columnName)
```
    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
  - copyConfigurationTo
```
void copyConfigurationTo(Column col)
```
    Copy the configuration of this field to another field
    
    Parameters:
    col - the column to copy
  - getMemberMetaData
```
org.datanucleus.metadata.AbstractMemberMetaData getMemberMetaData()
```
    Accessor for the MetaData of the field/property that this is the datastore field for.
    
    Returns:
    MetaData of the field/property (if representing a field/property of a class).
  - isUnlimitedLength
```
boolean isUnlimitedLength()
```
    Convenience method to check if the length is required to be unlimited (BLOB/CLOB).
    
    Returns:
    Whether unlimited length required.
  - setTypeInfo
```
Column setTypeInfo(SQLTypeInfo typeInfo)
```
    Mutator for the type information of the column.
    
    Parameters:
    typeInfo - The type info
    
    Returns:
    The column with the updated info
  - getTypeInfo
```
SQLTypeInfo getTypeInfo()
```
    Accessor for the type info for this column.
    
    Returns:
    The type info
  - getJdbcType
```
int getJdbcType()
```
    Accessor for the JDBC type being used for this Column
    
    Returns:
    The JDBC data type
  - getSQLDefinition
```
String getSQLDefinition()
```
    Accessor for the SQL definition of this column.
    
    Returns:
    The SQL definition of the column
  - initializeColumnInfoFromDatastore
```
void initializeColumnInfoFromDatastore(RDBMSColumnInfo ci)
```
    Initialize the default column value and auto increment
    
    Parameters:
    ci - The column information
  - validate
```
void validate(RDBMSColumnInfo ci)
```
    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.
    
    Parameters:
    ci - The column information taken from the database
  - setConstraints
```
Column setConstraints(String constraints)
```
    Mutator for the constraints of the column.
    
    Parameters:
    constraints - The constraints
    
    Returns:
    The column with the updated info
  - getConstraints
```
String getConstraints()
```
    Returns:
    Returns the constraints.
  - checkPrimitive
```
void checkPrimitive()
                    throws ColumnDefinitionException
```
    Checks the column definition as a primitive.
    
    Throws:
    
    ColumnDefinitionException
  - checkInteger
```
void checkInteger()
                  throws ColumnDefinitionException
```
    Checks the column definition as an integer.
    
    Throws:
    
    ColumnDefinitionException
  - checkDecimal
```
void checkDecimal()
                  throws ColumnDefinitionException
```
    Checks the column definition as a decimal.
    
    Throws:
    
    ColumnDefinitionException
  - checkString
```
void checkString()
                 throws ColumnDefinitionException
```
    Checks the column definition as a string.
    
    Throws:
    
    ColumnDefinitionException
  - setWrapperFunction
```
void setWrapperFunction(String wrapperFunction,
                      int wrapperMode)
```
    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)
```
    Parameters:
    wrapperFunction - The wrapperFunction to set.
    wrapperMode - whether select, insert or update
  - getWrapperFunction
```
String getWrapperFunction(int wrapperMode)
```
    Gets the wrapper for parameters.
    
    Parameters:
    wrapperMode - whether select, insert or update
    
    Returns:
    Returns the wrapperFunction.

Interface Column

Field Summary

Method Summary

Field Detail

WRAPPER_FUNCTION_SELECT

WRAPPER_FUNCTION_INSERT

WRAPPER_FUNCTION_UPDATE

Method Detail

getStoreManager

getStoredJavaType

setIdentifier

getIdentifier

setAsPrimaryKey

isPrimaryKey

setNullable

isNullable

setDefaultable

isDefaultable

setUnique

isUnique

setIdentity

isIdentity

setDefaultValue

getDefaultValue

setDatastoreMapping

getDatastoreMapping

setColumnMetaData

getColumnMetaData

getJavaTypeMapping

getTable

applySelectFunction

copyConfigurationTo

getMemberMetaData

isUnlimitedLength

setTypeInfo

getTypeInfo

getJdbcType

getSQLDefinition

initializeColumnInfoFromDatastore

validate

setConstraints

getConstraints

checkPrimitive

checkInteger

checkDecimal

checkString

setWrapperFunction

getWrapperFunction