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:

2.0.0

Author:

hceylan

Constructor Summary

Constructors

Constructor and Description
JoinColumn(JdbcAdaptor jdbcAdaptor, AssociationMapping<?,?,?> mapping, AbstractColumn referencedColumn, BasicColumn masterColumn) Constructor with no metadata for mappings with MapsId.
JoinColumn(JdbcAdaptor jdbcAdaptor, AssociationMapping<?,?,?> mapping, AbstractColumn referencedColumn, boolean id) Constructor with no metadata.
JoinColumn(JdbcAdaptor jdbcAdaptor, JoinColumnMetadata metadata, boolean readOnly) Constructor with metadata.
JoinColumn(JdbcAdaptor jdbcAdaptor, PrimaryKeyJoinColumnMetadata metadata, SecondaryTable table, AbstractColumn referencedColumn) Constructor for secondary table join column with metadata.

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.
Mapping<?,?,?>	getMapping() Returns the mapping of the BasicColumn.
AbstractColumn	getMasterColumn() Returns the master column.
String	getName() Returns the name of the JoinColumn.
int	getPrecision() Returns the precision of the column.
AbstractColumn	getReferencedColumn() Returns the referenced column of the join column.
String	getReferencedColumnName() Returns the name of the referenced column of the join column.
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(Connection connection, 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	isUnique() Returns the unique of the JoinColumn.
boolean	isUpdatable() Returns the updatable of the JoinColumn.
boolean	isVirtual() Returns if this join column is a virtual join column.
void	setColumnProperties(AssociationMapping<?,?,?> mapping, AbstractColumn referencedColumn, AbstractColumn masterColumn) Sets the column definition for virtual foreign column.
void	setColumnProperties(AssociationMapping<?,?,?> mapping, AbstractColumn referencedColumn, boolean id) 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
void	setVirtual(AbstractColumn masterColumn) Sets the master column of the join column.
String	toString()

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

convertValue, convertValueForSet, getIdType, getLocator, isLob, isPrimaryKey, setId

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,
          AbstractColumn referencedColumn,
          BasicColumn masterColumn)

Constructor with no metadata for mappings with MapsId.

Parameters:

jdbcAdaptor - the JDBC Adaptor

mapping - the mapping

referencedColumn - the referenced column

masterColumn - the master column

Since:

2.0.0

JoinColumn

public JoinColumn(JdbcAdaptor jdbcAdaptor,
          AssociationMapping<?,?,?> mapping,
          AbstractColumn referencedColumn,
          boolean id)

Constructor with no metadata.

Parameters:

jdbcAdaptor - the JDBC Adaptor

mapping - the mapping

referencedColumn - the referenced column

id - if the column is id

Since:

2.0.0

JoinColumn

public JoinColumn(JdbcAdaptor jdbcAdaptor,
          JoinColumnMetadata metadata,
          boolean readOnly)

Constructor with metadata.

Parameters:

jdbcAdaptor - the JDBC adaptor

metadata - the metadata for the join

readOnly - if the column is readonly

Since:

2.0.0

JoinColumn

public JoinColumn(JdbcAdaptor jdbcAdaptor,
          PrimaryKeyJoinColumnMetadata metadata,
          SecondaryTable table,
          AbstractColumn referencedColumn)

Constructor for secondary table join column with metadata.

Parameters:

jdbcAdaptor - the JDBC Adaptor

metadata - the metadata for the join

table - the secondary table

referencedColumn - the referenced column

Since:

2.0.0

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:

2.0.0

getLength

public int getLength()

Returns the length of the column.

Specified by:

getLength in class AbstractColumn

Returns:

the length of the column

getMapping

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

Returns the mapping of the BasicColumn.

Specified by:

getMapping in class AbstractColumn

Returns:

the mapping of the BasicColumn

getMasterColumn

public AbstractColumn getMasterColumn()

Returns the master column.

Master column is the delegate column for virtual join columns.

Returns:

the master column

Since:

2.0.0

getName

public String getName()

Returns the name of the JoinColumn.

Specified by:

getName in class AbstractColumn

Returns:

the name of the JoinColumn

Since:

2.0.0

getPrecision

public int getPrecision()

Returns the precision of the column.

Specified by:

getPrecision in class AbstractColumn

Returns:

the precision of the column

getReferencedColumn

public AbstractColumn getReferencedColumn()

Returns the referenced column of the join column.

Returns:

the referenced column of the join column

Since:

2.0.0

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:

2.0.0

getReferencedTable

public AbstractTable getReferencedTable()

Returns the referenced table.

Returns:

the referenced table

Since:

2.0.0

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(Connection connection,
              Object instance)

Returns the value for the column

Specified by:

getValue in class AbstractColumn

Parameters:

connection - the connection

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:

2.0.0

isNullable

public boolean isNullable()

Returns the nullable of the JoinColumn.

Specified by:

isNullable in class AbstractColumn

Returns:

the nullable of the JoinColumn

Since:

2.0.0

isUnique

public boolean isUnique()

Returns the unique of the JoinColumn.

Specified by:

isUnique in class AbstractColumn

Returns:

the unique of the JoinColumn

Since:

2.0.0

isUpdatable

public boolean isUpdatable()

Returns the updatable of the JoinColumn.

Specified by:

isUpdatable in class AbstractColumn

Returns:

the updatable of the JoinColumn

Since:

2.0.0

isVirtual

public boolean isVirtual()

Returns if this join column is a virtual join column.

Virtual join columns actually do not have their own storage, but rather references an existing id basic column.

Returns:

true if this join column is a virtual join column, false otherwise

Since:

2.0.0

setColumnProperties

public void setColumnProperties(AssociationMapping<?,?,?> mapping,
                       AbstractColumn referencedColumn,
                       AbstractColumn masterColumn)

Sets the column definition for virtual foreign column.

Parameters:

mapping - the owner mapping

referencedColumn - the refernced column

masterColumn - the master column

Since:

2.0.0

setColumnProperties

public void setColumnProperties(AssociationMapping<?,?,?> mapping,
                       AbstractColumn referencedColumn,
                       boolean id)

Sets the column definition.

Parameters:

mapping - the owner mapping

referencedColumn - the referenced column

id - if the column is id column

Since:

2.0.0

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

setVirtual

public void setVirtual(AbstractColumn masterColumn)

Sets the master column of the join column.

Parameters:

masterColumn - the master column

Since:

2.0.0

toString

public String toString()

Overrides:

toString in class AbstractColumn