org.batoo.jpa.jdbc

Class AbstractColumn

java.lang.Object

org.batoo.jpa.jdbc.AbstractColumn

All Implemented Interfaces:

Column

Direct Known Subclasses:

BasicColumn, DiscriminatorColumn, ElementColumn, JoinColumn, MapKeyColumn, OrderColumn

public abstract class AbstractColumn
extends Object
implements Column

Abstract base implementation for columns

Since:

2.0.0

Author:

hceylan

Constructor Summary

Constructors

Constructor and Description
AbstractColumn(AbstractLocator locator, boolean id)
AbstractColumn(Class<?> javaType, IdType idType, 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.
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.
IdType	getIdType() Returns the idType 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.
boolean	isVersion() Returns if the column is a version column.
void	setId() Sets the column as id 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,
              boolean id)

Parameters:

locator - the locator

id - if the column is id column

Since:

2.0.0

AbstractColumn

public AbstractColumn(Class<?> javaType,
              IdType idType,
              javax.persistence.TemporalType temporalType,
              javax.persistence.EnumType enumType,
              boolean lob,
              AbstractLocator locator)

Parameters:

javaType - the java type

idType - the id type

temporalType - the temporal type

enumType - the enum type

lob - if the column is lob

locator - the locator

Since:

2.0.0

Method Detail

convertValue

public Object convertValue(Connection connection,
                  Object value)

Converts the value corresponding to enum, temporal type, number or [cb]lob.

Specified by:

convertValue in interface Column

Parameters:

connection - the connection

value - the raw value

Returns:

the converted value

convertValueForSet

public 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:

2.0.0

getColumnDefinition

public abstract String getColumnDefinition()

Returns the static definition of the column.

Specified by:

getColumnDefinition in interface Column

Returns:

the static definition of the column

getIdType

public IdType getIdType()

Returns the idType of the column.

Specified by:

getIdType in interface Column

Returns:

the idType of the column

getLength

public abstract int getLength()

Returns the length of the column.

Specified by:

getLength in interface Column

Returns:

the length of the column

getLocator

public final AbstractLocator getLocator()

Returns the locator of the column.

Specified by:

getLocator in interface Column

Returns:

the locator of the column

getMapping

public abstract Mapping<?,?,?> getMapping()

Returns the mapping of the BasicColumn.

Specified by:

getMapping in interface Column

Returns:

the mapping of the BasicColumn

getName

public abstract String getName()

Returns the name of the column.

Specified by:

getName in interface Column

Returns:

the name of the column

getPrecision

public abstract int getPrecision()

Returns the precision of the column.

Specified by:

getPrecision in interface Column

Returns:

the precision of the column

getScale

public abstract int getScale()

Returns the scale of the column.

Specified by:

getScale in interface Column

Returns:

the scale of the column

getSqlType

public abstract int getSqlType()

Returns the SQL Type of the column.

Specified by:

getSqlType in interface Column

Returns:

the SQL Type of the column

getTable

public abstract AbstractTable getTable()

Returns the table of the column

Specified by:

getTable in interface Column

Returns:

the table

getTableName

public abstract String getTableName()

Returns the table name of the column.

Specified by:

getTableName in interface Column

Returns:

the table name of the column

getValue

public abstract Object getValue(Connection connection,
              Object instance)

Returns the value for the column

Specified by:

getValue in interface Column

Parameters:

connection - the connection

instance - the instance

Returns:

the value

isInsertable

public abstract boolean isInsertable()

Returns the insertable of the column.

Specified by:

isInsertable in interface Column

Returns:

the insertable of the column

isLob

public boolean isLob()

Returns if the column is lob type.

Specified by:

isLob in interface Column

Returns:

true if the column is lob type, false otherwise

isNullable

public abstract boolean isNullable()

Returns the nullable of the column.

Specified by:

isNullable in interface Column

Returns:

the nullable of the column

isPrimaryKey

public boolean isPrimaryKey()

Returns if the column is a primary key column.

Specified by:

isPrimaryKey in interface Column

Returns:

true if the column is a primary key column false otherwise

isUnique

public abstract boolean isUnique()

Returns the unique of the column.

Specified by:

isUnique in interface Column

Returns:

the unique of the column

isUpdatable

public abstract boolean isUpdatable()

Returns the updatable of the column.

Specified by:

isUpdatable in interface Column

Returns:

the updatable of the column

isVersion

public boolean isVersion()

Returns if the column is a version column.

Returns:

true if the column is a version column, false otherwise

Since:

2.0.1

setId

public void setId()

Sets the column as id column.

Specified by:

setId in interface Column

setTable

public abstract void setTable(AbstractTable table)

Sets the table of the column.

Specified by:

setTable in interface Column

Parameters:

table - the owning table

setValue

public abstract void setValue(Object instance,
            Object value)

Sets the value for the instance

Specified by:

setValue in interface Column

Parameters:

instance - the instance of which to set value

value - the value to set

toString

public String toString()

Overrides:

toString in class Object