org.batoo.jpa.core.impl.jdbc

Class ForeignKey

java.lang.Object

org.batoo.jpa.core.impl.jdbc.ForeignKey

public class ForeignKey
extends Object

Foreign key definition.

Since:

$version

Author:

hceylan

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	createDestinationJoin(JoinType joinType, String parentAlias, String alias) Creates the join for destination foreign keys.
String	createSourceJoin(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.
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.
AbstractTable	getTable() Returns the table of the ForeignKey.
void	link(AssociationMapping<?,?,?> mapping, EntityTypeImpl<?> targetEntity) Links the foreign key.
void	performAttachChild(ConnectionImpl connection, ManagedInstance<?> instance, Object key, Object child, int index) Attaches the child to the managed instance.
void	performDetachAll(ConnectionImpl connection, ManagedInstance<?> instance) Detaches the instance from all the children.
void	performDetachChild(ConnectionImpl connection, Object key, Object child) Detaches the child.
void	setOrderColumn(ColumnMetadata orderColumn, String name) 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,
          List<JoinColumnMetadata> metadata)

Constructor to create a join foreign key

Parameters:

jdbcAdaptor - the JDBC Adaptor

metadata - the metadata for join column

Since:

$version

ForeignKey

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

Constructor to create a join foreign key

Parameters:

jdbcAdaptor - the JDBC Adaptor

metadata - the metadata for join column

inverseOwner - true if the foreign key is inverse owner

Since:

$version

ForeignKey

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

Parameters:

jdbcAdaptor - the JDBC Adaptor

table - the secondary table

entity - the entity

metadata - the metadata

Since:

$version

Method Detail

createDestinationJoin

public String createDestinationJoin(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:

$version

createSourceJoin

public String createSourceJoin(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:

$version

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:

$version

getName

public String getName()

Returns a generated name for the foreign key.

Returns:

the name of the foreign key

Since:

$version

getOrderColumn

public OrderColumn getOrderColumn()

Returns the order column.

Returns:

the order column

Since:

$version

getReferencedTableName

public String getReferencedTableName()

Returns the referenced table of the foreign key.

Returns:

the referenced table of the foreign key

Since:

$version

getTable

public AbstractTable getTable()

Returns the table of the ForeignKey.

Returns:

the table of the ForeignKey

Since:

$version

link

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

Links the foreign key.

Parameters:

mapping - the owner attribute

targetEntity - the target entity

Since:

$version

performAttachChild

public void performAttachChild(ConnectionImpl connection,
                      ManagedInstance<?> instance,
                      Object key,
                      Object child,
                      int index)
                        throws SQLException

Attaches the child to the managed instance.

Parameters:

connection - the connection

instance - the instance

key - the key object

child - the child

index - the index

Throws:

SQLException - thrown in case of an SQL error

Since:

$version

performDetachAll

public void performDetachAll(ConnectionImpl connection,
                    ManagedInstance<?> 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:

$version

performDetachChild

public void performDetachChild(ConnectionImpl 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:

$version

setOrderColumn

public void setOrderColumn(ColumnMetadata orderColumn,
                  String name)

Sets the order column.

Parameters:

orderColumn - the order column

name - the name of the column

Since:

$version

setTable

public void setTable(AbstractTable table)

Sets the table of the foreign key.

Parameters:

table - the table

Since:

$version

toString

public String toString()

Overrides:

toString in class Object