AbstractColumn (Batoo Persistence Core 2.0.0.RC1 API)

java.lang.Object
- org.batoo.jpa.core.impl.jdbc.AbstractColumn

Direct Known Subclasses:

BasicColumn, DiscriminatorColumn, ElementColumn, JoinColumn, MapKeyColumn, OrderColumn
```
public abstract class AbstractColumn
extends Object
```
Abstract base implementation for columns

Since:

$version

Author:

hceylan

Constructor Summary

Constructors
Constructor and Description
`AbstractColumn(AbstractLocator locator)`
`AbstractColumn(Class<?> javaType, javax.persistence.TemporalType temporalType, javax.persistence.EnumType enumType, boolean lob, AbstractLocator locator)`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`convertValue(Connection connection, Object value)` Converts the value corresponding to enum, temporal type, number or [cb]lob.
`protected Object`	`convertValueForSet(Object value)` Converts the value corresponding to enum, temporal type, number or [cb]lob.
`abstract String`	`getColumnDefinition()` Returns the static definition of the column.
`abstract int`	`getLength()` Returns the length of the column.
`AbstractLocator`	`getLocator()` Returns the locator of the column.
`abstract Mapping<?,?,?>`	`getMapping()` Returns the mapping of the BasicColumn.
`abstract String`	`getName()` Returns the name of the column.
`abstract int`	`getPrecision()` Returns the precision of the column.
`abstract int`	`getScale()` Returns the scale of the column.
`abstract int`	`getSqlType()` Returns the SQL Type of the column.
`abstract AbstractTable`	`getTable()` Returns the table of the column
`abstract String`	`getTableName()` Returns the table name of the column.
`abstract Object`	`getValue(Connection connection, Object instance)` Returns the value for the column
`abstract boolean`	`isInsertable()` Returns the insertable of the column.
`boolean`	`isLob()` Returns if the column is lob type.
`abstract boolean`	`isNullable()` Returns the nullable of the column.
`boolean`	`isPrimaryKey()` Returns if the column is a primary key column.
`abstract boolean`	`isUnique()` Returns the unique of the column.
`abstract boolean`	`isUpdatable()` Returns the updatable of the column.
`abstract void`	`setTable(AbstractTable table)` Sets the table of the column.
`abstract void`	`setValue(Object instance, Object value)` Sets the value for the instance
`String`	`toString()`

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

- Constructor Detail
  - AbstractColumn
```
public AbstractColumn(AbstractLocator locator)
```
    Parameters:
    locator - the locator
    Since:
    
    $version
  - AbstractColumn
```
public AbstractColumn(Class<?> javaType,
              javax.persistence.TemporalType temporalType,
              javax.persistence.EnumType enumType,
              boolean lob,
              AbstractLocator locator)
```
    Parameters:
    javaType - the java type
    temporalType - the temporal type
    enumType - the enum type
    lob - if the column is lob
    locator - the locator
    Since:
    
    $version
- Method Detail
  - convertValue
```
public Object convertValue(Connection connection,
                  Object value)
```
    Converts the value corresponding to enum, temporal type, number or [cb]lob.
    
    Parameters:
    connection - the connection
    value - the raw value
    
    Returns:
    the converted value
    Since:
    
    $version
  - convertValueForSet
```
protected Object convertValueForSet(Object value)
```
    Converts the value corresponding to enum, temporal type, number or [cb]lob.
    
    Parameters:
    value - the raw value
    
    Returns:
    the converted value
    Since:
    
    $version
  - getColumnDefinition
```
public abstract String getColumnDefinition()
```
    Returns the static definition of the column.
    
    Returns:
    the static definition of the column
    Since:
    
    $version
  - getLength
```
public abstract int getLength()
```
    Returns the length of the column.
    
    Returns:
    the length of the column
    Since:
    
    $version
  - getLocator
```
public final AbstractLocator getLocator()
```
    Returns the locator of the column.
    
    Returns:
    the locator of the column
    Since:
    
    $version
  - getMapping
```
public abstract Mapping<?,?,?> getMapping()
```
    Returns the mapping of the BasicColumn.
    
    Returns:
    the mapping of the BasicColumn
    Since:
    
    $version
  - getName
```
public abstract String getName()
```
    Returns the name of the column.
    
    Returns:
    the name of the column
    Since:
    
    $version
  - getPrecision
```
public abstract int getPrecision()
```
    Returns the precision of the column.
    
    Returns:
    the precision of the column
    Since:
    
    $version
  - getScale
```
public abstract int getScale()
```
    Returns the scale of the column.
    
    Returns:
    the scale of the column
    Since:
    
    $version
  - getSqlType
```
public abstract int getSqlType()
```
    Returns the SQL Type of the column.
    
    Returns:
    the SQL Type of the column
    Since:
    
    $version
  - getTable
```
public abstract AbstractTable getTable()
```
    Returns the table of the column
    
    Returns:
    the table
    Since:
    
    $version
  - getTableName
```
public abstract String getTableName()
```
    Returns the table name of the column.
    
    Returns:
    the table name of the column
    Since:
    
    $version
  - getValue
```
public abstract Object getValue(Connection connection,
              Object instance)
```
    Returns the value for the column
    
    Parameters:
    connection - the connection
    instance - the instance
    
    Returns:
    the value
    Since:
    
    $version
  - isInsertable
```
public abstract boolean isInsertable()
```
    Returns the insertable of the column.
    
    Returns:
    the insertable of the column
    Since:
    
    $version
  - isLob
```
public boolean isLob()
```
    Returns if the column is lob type.
    
    Returns:
    true if the column is lob type, false otherwise
    Since:
    
    $version
  - isNullable
```
public abstract boolean isNullable()
```
    Returns the nullable of the column.
    
    Returns:
    the nullable of the column
    Since:
    
    $version
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Returns if the column is a primary key column.
    
    Returns:
    true if the column is a primary key column false otherwise
    Since:
    
    $version
  - isUnique
```
public abstract boolean isUnique()
```
    Returns the unique of the column.
    
    Returns:
    the unique of the column
    Since:
    
    $version
  - isUpdatable
```
public abstract boolean isUpdatable()
```
    Returns the updatable of the column.
    
    Returns:
    the updatable of the column
    Since:
    
    $version
  - setTable
```
public abstract void setTable(AbstractTable table)
```
    Sets the table of the column.
    
    Parameters:
    table - the owning table
    Since:
    
    $version
  - setValue
```
public abstract void setValue(Object instance,
            Object value)
```
    Sets the value for the instance
    
    Parameters:
    instance - the instance of which to set value
    value - the value to set
    Since:
    
    $version
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractColumn

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractColumn

AbstractColumn

Method Detail

convertValue

convertValueForSet

getColumnDefinition

getLength

getLocator

getMapping

getName

getPrecision

getScale

getSqlType

getTable

getTableName

getValue

isInsertable

isLob

isNullable

isPrimaryKey

isUnique

isUpdatable

setTable

setValue

toString