org.batoo.jpa.core.impl.jdbc

Class JoinColumn

java.lang.Object

org.batoo.jpa.core.impl.jdbc.AbstractColumn

org.batoo.jpa.core.impl.jdbc.JoinColumn

public class JoinColumn
extends AbstractColumn

Mapping of two BasicColumns.

Since:

$version

Author:

hceylan

Constructor Summary

Constructors

Constructor and Description
JoinColumn(JdbcAdaptor jdbcAdaptor, AssociationMapping<?,?,?> mapping, BasicMapping<?,?> idMapping) Constructor with no metadata.
JoinColumn(JdbcAdaptor jdbcAdaptor, EntityTable table, BasicMapping<?,?> idMapping) Constructor for inheritance and secondary table joins.
JoinColumn(JdbcAdaptor jdbcAdaptor, JoinColumnMetadata metadata) Constructor with metadata.
JoinColumn(JdbcAdaptor jdbcAdaptor, PrimaryKeyJoinColumnMetadata metadata, SecondaryTable table, BasicMapping<?,?> idMapping) Constructor for secondary table join column with metadata.
JoinColumn(JdbcAdaptor jdbcAdaptor, SecondaryTable table, BasicMapping<?,?> idMapping) Constructor for inheritance and secondary table joins.

Method Summary

Methods

Modifier and Type	Method and Description
String	getColumnDefinition() Returns the columnDefinition of the JoinColumn.
int	getLength() Returns the length of the column.
AbstractLocator	getLocator() Returns the locator of the JoinColumn.
Mapping<?,?,?>	getMapping() Returns the mapping of the BasicColumn.
String	getMappingName() Returns the mapping name of the column.
String	getName() Returns the name of the JoinColumn.
int	getPrecision() Returns the precision of the column.
String	getReferencedColumnName() Returns the name of the referenced column of the join column.
BasicMapping<?,?>	getReferencedMapping() Returns the referencedMapping of the JoinColumn.
AbstractTable	getReferencedTable() Returns the referenced table.
int	getScale() Returns the scale of the column.
int	getSqlType() Returns the SQL Type of the column.
AbstractTable	getTable() Returns the table of the column
String	getTableName() Returns the table name of the column.
Object	getValue(Object instance) Returns the value for the column
boolean	isInsertable() Returns the insertable of the JoinColumn.
boolean	isNullable() Returns the nullable of the JoinColumn.
boolean	isPrimaryKey() Returns if the column is a primary key column.
boolean	isUnique() Returns the unique of the JoinColumn.
boolean	isUpdatable() Returns the updatable of the JoinColumn.
void	setColumnProperties(AssociationMapping<?,?,?> mapping, BasicMapping<?,?> referencedMapping) Sets the column definition.
void	setTable(AbstractTable table) Sets the table of the column.
void	setValue(Object instance, Object value) Sets the value for the instance

Methods inherited from class org.batoo.jpa.core.impl.jdbc.AbstractColumn

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JoinColumn

public JoinColumn(JdbcAdaptor jdbcAdaptor,
          AssociationMapping<?,?,?> mapping,
          BasicMapping<?,?> idMapping)

Constructor with no metadata.

Parameters:

jdbcAdaptor - the JDBC Adaptor

mapping - the mapping

idMapping - the referenced mapping

Since:

$version

JoinColumn

public JoinColumn(JdbcAdaptor jdbcAdaptor,
          EntityTable table,
          BasicMapping<?,?> idMapping)

Constructor for inheritance and secondary table joins.

Parameters:

jdbcAdaptor - the JDBC Adaptor

table - the table

idMapping - the referenced id mapping

Since:

$version

JoinColumn

public JoinColumn(JdbcAdaptor jdbcAdaptor,
          JoinColumnMetadata metadata)

Constructor with metadata.

Parameters:

jdbcAdaptor - the JDBC adaptor

metadata - the metadata for the join

Since:

$version

JoinColumn

public JoinColumn(JdbcAdaptor jdbcAdaptor,
          PrimaryKeyJoinColumnMetadata metadata,
          SecondaryTable table,
          BasicMapping<?,?> idMapping)

Constructor for secondary table join column with metadata.

Parameters:

jdbcAdaptor - the JDBC Adaptor

metadata - the metadata for the join

table - the secondary table

idMapping - the id mapping

Since:

$version

JoinColumn

public JoinColumn(JdbcAdaptor jdbcAdaptor,
          SecondaryTable table,
          BasicMapping<?,?> idMapping)

Constructor for inheritance and secondary table joins.

Parameters:

jdbcAdaptor - the JDBC Adaptor

table - the table

idMapping - the referenced id mapping

Since:

$version

Method Detail

getColumnDefinition

public String getColumnDefinition()

Returns the columnDefinition of the JoinColumn.

Specified by:

getColumnDefinition in class AbstractColumn

Returns:

the columnDefinition of the JoinColumn

Since:

$version

getLength

public int getLength()

Returns the length of the column.

Specified by:

getLength in class AbstractColumn

Returns:

the length of the column

getLocator

public AbstractLocator getLocator()

Returns the locator of the JoinColumn.

Specified by:

getLocator in class AbstractColumn

Returns:

the locator of the JoinColumn

Since:

$version

getMapping

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

Returns the mapping of the BasicColumn.

Specified by:

getMapping in class AbstractColumn

Returns:

the mapping of the BasicColumn

getMappingName

public String getMappingName()

Returns the mapping name of the column.

Specified by:

getMappingName in class AbstractColumn

Returns:

the mapping name of the column

getName

public String getName()

Returns the name of the JoinColumn.

Specified by:

getName in class AbstractColumn

Returns:

the name of the JoinColumn

Since:

$version

getPrecision

public int getPrecision()

Returns the precision of the column.

Specified by:

getPrecision in class AbstractColumn

Returns:

the precision of the column

getReferencedColumnName

public String getReferencedColumnName()

Returns the name of the referenced column of the join column.

Returns:

the name of the referenced column of the join column

Since:

$version

getReferencedMapping

public BasicMapping<?,?> getReferencedMapping()

Returns the referencedMapping of the JoinColumn.

Returns:

the referencedMapping of the JoinColumn

Since:

$version

getReferencedTable

public AbstractTable getReferencedTable()

Returns the referenced table.

Returns:

the referenced table

Since:

$version

getScale

public int getScale()

Returns the scale of the column.

Specified by:

getScale in class AbstractColumn

Returns:

the scale of the column

getSqlType

public int getSqlType()

Returns the SQL Type of the column.

Specified by:

getSqlType in class AbstractColumn

Returns:

the SQL Type of the column

getTable

public AbstractTable getTable()

Returns the table of the column

Specified by:

getTable in class AbstractColumn

Returns:

the table

getTableName

public String getTableName()

Returns the table name of the column.

Specified by:

getTableName in class AbstractColumn

Returns:

the table name of the column

getValue

public Object getValue(Object instance)

Returns the value for the column

Specified by:

getValue in class AbstractColumn

Parameters:

instance - the instance

Returns:

the value

isInsertable

public boolean isInsertable()

Returns the insertable of the JoinColumn.

Specified by:

isInsertable in class AbstractColumn

Returns:

the insertable of the JoinColumn

Since:

$version

isNullable

public boolean isNullable()

Returns the nullable of the JoinColumn.

Specified by:

isNullable in class AbstractColumn

Returns:

the nullable of the JoinColumn

Since:

$version

isPrimaryKey

public boolean isPrimaryKey()

Returns if the column is a primary key column.

Overrides:

isPrimaryKey in class AbstractColumn

Returns:

true if the column is a primary key column false otherwise

isUnique

public boolean isUnique()

Returns the unique of the JoinColumn.

Specified by:

isUnique in class AbstractColumn

Returns:

the unique of the JoinColumn

Since:

$version

isUpdatable

public boolean isUpdatable()

Returns the updatable of the JoinColumn.

Specified by:

isUpdatable in class AbstractColumn

Returns:

the updatable of the JoinColumn

Since:

$version

setColumnProperties

public void setColumnProperties(AssociationMapping<?,?,?> mapping,
                       BasicMapping<?,?> referencedMapping)

Sets the column definition.

Parameters:

mapping - the owner mapping

referencedMapping - the referenced primary key Column

Since:

$version

setTable

public void setTable(AbstractTable table)

Sets the table of the column.

Specified by:

setTable in class AbstractColumn

Parameters:

table - the owning table

setValue

public void setValue(Object instance,
            Object value)

Sets the value for the instance

Specified by:

setValue in class AbstractColumn

Parameters:

instance - the instance of which to set value

value - the value to set