org.batoo.jpa.core.impl.model.mapping

Interface JoinedMapping<Z,X,Y>

Type Parameters:

Z - the source type

X - the destination type

Y - the attribute type

All Known Subinterfaces:

PluralMapping<Z,C,E>

All Known Implementing Classes:

AssociationMapping, ElementCollectionMapping, EmbeddedMapping, PluralAssociationMapping, SingularAssociationMapping

public interface JoinedMapping<Z,X,Y>

Mapping that have a join or collection table

Since:

$version

Author:

hceylan

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JoinedMapping.MappingType Type of the mapping

Method Summary

Methods

Modifier and Type	Method and Description
Object	extractKey(Y value) Extracts key from the value.
void	flush(ConnectionImpl connection, ManagedInstance<?> managedInstance, boolean removals, boolean force) Flushes the associates.
AttributeImpl<? super Z,X>	getAttribute() Returns the attribute of the mapping
JoinedMapping.MappingType	getMappingType() Returns the type of the mapping.
JoinableTable	getTable() Returns the table for the relation.
TypeImpl<Y>	getType() Returns the bindable entity type.
void	initialize(ManagedInstance<?> instance) Initializes the mapping.
boolean	isAssociation() Returns if the mapping is an association.
boolean	isEager() Returns if the association should be eagerly fetched.
boolean	isJoined() Returns if the mapping is a joined mapping.
boolean	isMap() Returns if the mapping is a map collection.
String	join(String parentAlias, String alias, JoinType joinType) Returns the join SQL for the mapping.

Method Detail

extractKey

Object extractKey(Y value)

Extracts key from the value.

Parameters:

value - the value

Returns:

the key of the value

Since:

$version

flush

void flush(ConnectionImpl connection,
         ManagedInstance<?> managedInstance,
         boolean removals,
         boolean force)
           throws SQLException

Flushes the associates.

Parameters:

connection - the connection to use

managedInstance - the managed instance

removals - true if the removals should be flushed and false for the additions

force - true to force, effective only for insertions and for new entities.

Throws:

SQLException - thrown if there is an underlying SQL Exception

Since:

$version

getAttribute

AttributeImpl<? super Z,X> getAttribute()

Returns the attribute of the mapping

Returns:

the attribute of the mapping

Since:

$version

getMappingType

JoinedMapping.MappingType getMappingType()

Returns the type of the mapping.

Returns:

the type of the mapping

Since:

$version

getTable

JoinableTable getTable()

Returns the table for the relation.

This is, for associations the JoinTable, for element collections the CollectionTable.

Returns:

the table

Since:

$version

getType

TypeImpl<Y> getType()

Returns the bindable entity type.

Returns:

the bindable entity type

Since:

$version

initialize

void initialize(ManagedInstance<?> instance)

Initializes the mapping.

Parameters:

instance - the instance

Since:

$version

isAssociation

boolean isAssociation()

Returns if the mapping is an association.

Returns:

true if the mapping is an association, false otherwise

Since:

$version

isEager

boolean isEager()

Returns if the association should be eagerly fetched.

Returns:

true if the association should be eagerly fetched

Since:

$version

isJoined

boolean isJoined()

Returns if the mapping is a joined mapping.

Returns:

true if the mapping is a joined mapping, false otherwise

Since:

$version

isMap

boolean isMap()

Returns if the mapping is a map collection.

Returns:

true if the mapping is a map collection, false otherwise

Since:

$version

join

String join(String parentAlias,
          String alias,
          JoinType joinType)

Returns the join SQL for the mapping.

Parameters:

parentAlias - the parent table alias

alias - the primary table alias

joinType - the join type

Returns:

the join SQL for the mapping

Since:

$version