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

Class AssociationMapping<Z,X,Y>

java.lang.Object

org.batoo.jpa.core.impl.model.mapping.Mapping<Z,X,Y>

org.batoo.jpa.core.impl.model.mapping.AssociationMapping<Z,X,Y>

Type Parameters:

Z - the source type

X - the destination type

Y - the attribute type

All Implemented Interfaces:

JoinedMapping<Z,X,Y>

Direct Known Subclasses:

PluralAssociationMapping, SingularAssociationMapping

public abstract class AssociationMapping<Z,X,Y>
extends Mapping<Z,X,Y>
implements JoinedMapping<Z,X,Y>

Mapping for associations.

Since:

$version

Author:

hceylan

Nested Class Summary

Nested classes/interfaces inherited from interface org.batoo.jpa.core.impl.model.mapping.JoinedMapping

JoinedMapping.MappingType

Constructor Summary

Constructors

Constructor and Description
AssociationMapping(ParentMapping<?,Z> parent, AssociationAttributeMetadata metadata, AttributeImpl<? super Z,X> attribute)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cascadesDetach() Returns if the type cascades detach operations.
boolean	cascadesMerge() Returns if the type cascades merge operations.
boolean	cascadesPersist() Returns if the type cascades persist operations.
boolean	cascadesRefresh() Returns if the type cascades refresh operations.
boolean	cascadesRemove() Returns if the type cascades remove operations.
abstract void	checkTransient(ManagedInstance<?> managedInstance) Checks that the association references not a transient instance
protected AssociationMetadata	getAssociationMetadata() Returns the effective association metadata for the attribute checking with the parent mappings and entities.
abstract ForeignKey	getForeignKey() Returns the foreign key of the mapping.
abstract AssociationMapping<?,?,?>	getInverse() Returns the inverse attribute.
String	getMappedBy() Returns the mappedBy of the mapping.
int	getMaxFetchJoinDepth() Returns the max allowed depth for the fetch join.
protected CriteriaQueryImpl<Y>	getSelectCriteria() Returns the select criteria.
abstract JoinTable	getTable() Returns the join table of the mapping.
abstract EntityTypeImpl<Y>	getType() Returns the bindable entity type.
boolean	isEager() Returns if the association should be eagerly fetched.
boolean	isOwner() Returns if the association is the owner side.
String	join(String parentAlias, String alias, javax.persistence.criteria.JoinType joinType) Returns the join SQL for the mapping.
abstract void	link() Links the attribute to its associate entity type and inverse attribute if bidirectional.
abstract void	mergeWith(EntityManagerImpl entityManager, ManagedInstance<?> instance, Object entity, org.apache.commons.lang.mutable.MutableBoolean requiresFlush, IdentityHashMap<Object,Object> processed) Merges the association of the instance with the entity.
abstract boolean	references(Object instance, Object reference)
abstract void	refresh(ManagedInstance<?> instance, Set<Object> processed) Refreshes the association
boolean	removesOrphans() Returns the if the mapping removes orphans.
abstract void	setInverse(AssociationMapping<?,?,?> inverse) Sets the inverse attribute.

Methods inherited from class org.batoo.jpa.core.impl.model.mapping.Mapping

equals, get, getAttribute, getJavaType, getName, getParent, getPath, getRoot, hashCode, set, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.batoo.jpa.core.impl.model.mapping.JoinedMapping

extractKey, flush, getAttribute, getMappingType, getPath, initialize, isAssociation, isJoined, isMap

Constructor Detail

AssociationMapping

public AssociationMapping(ParentMapping<?,Z> parent,
                  AssociationAttributeMetadata metadata,
                  AttributeImpl<? super Z,X> attribute)

Parameters:

parent - the parent mapping

metadata - the metadata

attribute - the attribute

Since:

$version

Method Detail

cascadesDetach

public final boolean cascadesDetach()

Returns if the type cascades detach operations.

Returns:

true if the type cascades detach operations, false otherwise.

Since:

$version

cascadesMerge

public final boolean cascadesMerge()

Returns if the type cascades merge operations.

Returns:

true if the type cascades merge operations, false otherwise.

Since:

$version

cascadesPersist

public final boolean cascadesPersist()

Returns if the type cascades persist operations.

Returns:

true if the type cascades persist operations, false otherwise.

Since:

$version

cascadesRefresh

public final boolean cascadesRefresh()

Returns if the type cascades refresh operations.

Returns:

true if the type cascades refresh operations, false otherwise.

Since:

$version

cascadesRemove

public final boolean cascadesRemove()

Returns if the type cascades remove operations.

Returns:

true if the type cascades remove operations, false otherwise.

Since:

$version

checkTransient

public abstract void checkTransient(ManagedInstance<?> managedInstance)

Checks that the association references not a transient instance

Parameters:

managedInstance - the managed instance

Since:

$version

getAssociationMetadata

protected AssociationMetadata getAssociationMetadata()

Returns the effective association metadata for the attribute checking with the parent mappings and entities.

Returns:

the column metadata

Since:

$version

getForeignKey

public abstract ForeignKey getForeignKey()

Returns the foreign key of the mapping.

Returns:

the foreign key of the mapping

Since:

$version

getInverse

public abstract AssociationMapping<?,?,?> getInverse()

Returns the inverse attribute.

Returns:

the inverse attribute or null

Since:

$version

getMappedBy

public String getMappedBy()

Returns the mappedBy of the mapping.

Returns:

the mappedBy of the mapping

Since:

$version

getMaxFetchJoinDepth

public int getMaxFetchJoinDepth()

Returns the max allowed depth for the fetch join.

Returns:

the max allowed depth for the fetch join

Since:

$version

getSelectCriteria

protected CriteriaQueryImpl<Y> getSelectCriteria()

Returns the select criteria.

Returns:

the select criteria

Since:

$version

getTable

public abstract JoinTable getTable()

Returns the join table of the mapping.

Specified by:

getTable in interface JoinedMapping<Z,X,Y>

Returns:

the join table of the mapping

Since:

$version

getType

public abstract EntityTypeImpl<Y> getType()

Returns the bindable entity type.

Specified by:

getType in interface JoinedMapping<Z,X,Y>

Returns:

the bindable entity type

isEager

public final boolean isEager()

Returns if the association should be eagerly fetched.

Specified by:

isEager in interface JoinedMapping<Z,X,Y>

Returns:

true if the association should be eagerly fetched

isOwner

public final boolean isOwner()

Returns if the association is the owner side.

Returns:

true if the association is the owner side

Since:

$version

join

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

Returns the join SQL for the mapping.

Specified by:

join in interface JoinedMapping<Z,X,Y>

Parameters:

parentAlias - the parent table alias

alias - the primary table alias

joinType - the join type

Returns:

the join SQL for the mapping

link

public abstract void link()
                   throws MappingException

Links the attribute to its associate entity type and inverse attribute if bidirectional.

Throws:

MappingException - thrown in case of a linkage error

Since:

$version

mergeWith

public abstract void mergeWith(EntityManagerImpl entityManager,
             ManagedInstance<?> instance,
             Object entity,
             org.apache.commons.lang.mutable.MutableBoolean requiresFlush,
             IdentityHashMap<Object,Object> processed)

Merges the association of the instance with the entity.

Parameters:

entityManager - the entity manager

instance - the instance

entity - the entity

requiresFlush - if an implicit flush is required

processed - registry of processed entities

Since:

$version

references

public abstract boolean references(Object instance,
                 Object reference)

Parameters:

instance - the source instance

reference - the associate instance

Returns:

true if source contains reference to the associate, false otherwise

Since:

$version

refresh

public abstract void refresh(ManagedInstance<?> instance,
           Set<Object> processed)

Refreshes the association

Parameters:

instance - the instance that is the owner of the association

processed - the set of processed instances

Since:

$version

removesOrphans

public boolean removesOrphans()

Returns the if the mapping removes orphans.

Returns:

true if the mapping removes orphans, false otherwise

Since:

$version

setInverse

public abstract void setInverse(AssociationMapping<?,?,?> inverse)

Sets the inverse attribute.

Parameters:

inverse - the inverse association

Since:

$version