org.batoo.jpa.jdbc

Class ForeignKey

java.lang.Object

org.batoo.jpa.jdbc.ForeignKey

public class ForeignKey
extends Object

Foreign key definition.

Since:

2.0.0

Author:

hceylan

Constructor Summary

Constructors

Constructor and Description
ForeignKey(JdbcAdaptor jdbcAdaptor, Mapping<?,?,?> mapping, List<JoinColumnMetadata> metadata) Constructor to create a join foreign key
ForeignKey(JdbcAdaptor jdbcAdaptor, Mapping<?,?,?> mapping, List<JoinColumnMetadata> metadata, boolean inverseOwner) Constructor to create a join foreign key
ForeignKey(JdbcAdaptor jdbcAdaptor, SecondaryTable table, EntityTypeDescriptor entity, List<PrimaryKeyJoinColumnMetadata> metadata)

Method Summary

Methods

Modifier and Type	Method and Description
String	createDestinationJoin(javax.persistence.criteria.JoinType joinType, String parentAlias, String alias) Creates the join for destination foreign keys.
String	createSourceJoin(javax.persistence.criteria.JoinType joinType, String parentAlias, String alias) Creates the join for source foreign keys.
List<JoinColumn>	getJoinColumns() Returns the list of join columns of the foreign key.
Mapping<?,?,?>	getMapping() Returns the mapping of the ForeignKey.
String	getName() Returns a generated name for the foreign key.
OrderColumn	getOrderColumn() Returns the order column.
String	getReferencedTableName() Returns the referenced table of the foreign key.
String	getReferencedTableQName() Returns the qualified referenced table of the foreign key.
AbstractTable	getTable() Returns the table of the ForeignKey.
boolean	isReadOnly() Returns if the foreign key maps to a readonly join.
void	link(AssociationMapping<?,?,?> mapping, EntityTypeDescriptor targetEntity) Links the foreign key.
void	performAttachChild(Connection connection, Object instance, Joinable[] batch, int size) Attaches the child to the managed instance.
void	performDetachAll(Connection connection, Object instance) Detaches the instance from all the children.
void	performDetachChild(Connection connection, Object key, Object child) Detaches the child.
void	setOrderColumn(ColumnMetadata orderColumn, String name, AbstractLocator locator) Sets the order column.
void	setTable(AbstractTable table) Sets the table of the foreign key.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ForeignKey

public ForeignKey(JdbcAdaptor jdbcAdaptor,
          Mapping<?,?,?> mapping,
          List<JoinColumnMetadata> metadata)

Constructor to create a join foreign key

Parameters:

jdbcAdaptor - the JDBC Adaptor

mapping - the owner mapping

metadata - the metadata for join column

Since:

2.0.0

ForeignKey

public ForeignKey(JdbcAdaptor jdbcAdaptor,
          Mapping<?,?,?> mapping,
          List<JoinColumnMetadata> metadata,
          boolean inverseOwner)

Constructor to create a join foreign key

Parameters:

jdbcAdaptor - the JDBC Adaptor

mapping - the owner mapping

metadata - the metadata for join column

inverseOwner - true if the foreign key is inverse owner

Since:

2.0.0

ForeignKey

public ForeignKey(JdbcAdaptor jdbcAdaptor,
          SecondaryTable table,
          EntityTypeDescriptor entity,
          List<PrimaryKeyJoinColumnMetadata> metadata)

Parameters:

jdbcAdaptor - the JDBC Adaptor

table - the secondary table

entity - the entity

metadata - the metadata

Since:

2.0.0

Method Detail

createDestinationJoin

public String createDestinationJoin(javax.persistence.criteria.JoinType joinType,
                           String parentAlias,
                           String alias)

Creates the join for destination foreign keys.

Parameters:

joinType - the type of the join

parentAlias - the alias of the parent table

alias - the alias of the table

Returns:

the join SQL fragment

Since:

2.0.0

createSourceJoin

public String createSourceJoin(javax.persistence.criteria.JoinType joinType,
                      String parentAlias,
                      String alias)

Creates the join for source foreign keys.

Parameters:

joinType - the type of the join

parentAlias - the alias of the parent table

alias - the alias of the table

Returns:

the join SQL fragment

Since:

2.0.0

getJoinColumns

public List<JoinColumn> getJoinColumns()

Returns the list of join columns of the foreign key.

Returns:

the list of join columns of the foreign key.

Since:

2.0.0

getMapping

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

Returns the mapping of the ForeignKey.

Returns:

the mapping of the ForeignKey

Since:

2.0.1

getName

public String getName()

Returns a generated name for the foreign key.

Returns:

the name of the foreign key

Since:

2.0.0

getOrderColumn

public OrderColumn getOrderColumn()

Returns the order column.

Returns:

the order column

Since:

2.0.0

getReferencedTableName

public String getReferencedTableName()

Returns the referenced table of the foreign key.

Returns:

the referenced table of the foreign key

Since:

2.0.0

getReferencedTableQName

public String getReferencedTableQName()

Returns the qualified referenced table of the foreign key.

Returns:

the qualified referenced table of the foreign key

Since:

2.0.0

getTable

public AbstractTable getTable()

Returns the table of the ForeignKey.

Returns:

the table of the ForeignKey

Since:

2.0.0

isReadOnly

public boolean isReadOnly()

Returns if the foreign key maps to a readonly join.

Returns:

true if the foreign key maps to a readonly join, false otherwise

Since:

2.0.0

link

public void link(AssociationMapping<?,?,?> mapping,
        EntityTypeDescriptor targetEntity)

Links the foreign key.

Parameters:

mapping - the owner attribute

targetEntity - the target entity

Since:

2.0.0

performAttachChild

public void performAttachChild(Connection connection,
                      Object instance,
                      Joinable[] batch,
                      int size)
                        throws SQLException

Attaches the child to the managed instance.

Parameters:

connection - the connection

instance - the instance

batch - the batch of joinables

size - the size of the batch

Throws:

SQLException - thrown in case of an SQL error

Since:

2.0.0

performDetachAll

public void performDetachAll(Connection connection,
                    Object instance)
                      throws SQLException

Detaches the instance from all the children.

Parameters:

connection - the connection

instance - the instance

Throws:

SQLException - thrown in case of an SQL error

Since:

2.0.0

performDetachChild

public void performDetachChild(Connection connection,
                      Object key,
                      Object child)
                        throws SQLException

Detaches the child.

Parameters:

connection - the connection

key - the key object

child - the child

Throws:

SQLException - thrown in case of an SQL error

Since:

2.0.0

setOrderColumn

public void setOrderColumn(ColumnMetadata orderColumn,
                  String name,
                  AbstractLocator locator)

Sets the order column.

Parameters:

orderColumn - the order column

name - the name of the column

locator - the locator

Since:

2.0.0

setTable

public void setTable(AbstractTable table)

Sets the table of the foreign key.

Parameters:

table - the table

Since:

2.0.0

toString

public String toString()

Overrides:

toString in class Object