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

Class AssociationMappingImpl<Z,X,Y>

java.lang.Object

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

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

Type Parameters:

Z - the source type

X - the destination type

Y - the attribute type

All Implemented Interfaces:

JoinedMapping<Z,X,Y>, AssociationMapping<Z,X,Y>, Mapping<Z,X,Y>

Direct Known Subclasses:

PluralAssociationMappingImpl, SingularAssociationMappingImpl

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

AbstractMapping for associations.

Since:

2.0.0

Author:

hceylan

Constructor Summary

Constructors

Constructor and Description
AssociationMappingImpl(AbstractParentMapping<?,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
abstract void	flush(Connection connection, ManagedInstance<?> managedInstance, boolean removals, boolean force) Flushes the associates.
protected AssociationMetadata	getAssociationMetadata() Returns the effective association metadata for the attribute checking with the parent mappings and entities.
FetchStrategyType	getFetchStrategy() Returns the Fetching strategy of the association
abstract AssociationMappingImpl<?,?,?>	getInverse() Returns the inverse attribute.
abstract JoinTable	getJoinTable() Returns the join table of the mapping.
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 EntityTypeImpl<Y>	getType() Returns the associate type of the mapping.
abstract void	initialize(ManagedInstance<?> instance) Initializes the mapping.
boolean	isEager() Returns if the association should be eagerly fetched.
boolean	isOwner() Returns if the association is the owner side.
protected boolean	isOwnerSelect() Returns if the selection is owned.
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, LinkedList<ManagedInstance<?>> instances) 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(AssociationMappingImpl<?,?,?> inverse) Sets the inverse attribute.

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

equals, get, getAttribute, getJavaMember, getJavaType, getLocator, getName, getParent, getPath, getRoot, hashCode, isCollection, 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, getAttribute, getMappingType, isAssociation, isJoined, isMap

Methods inherited from interface org.batoo.jpa.jdbc.mapping.AssociationMapping

getForeignKey

Methods inherited from interface org.batoo.jpa.jdbc.mapping.Mapping

get, getJavaMember, getJavaType, getLocator, getName, getParent, getPath, getRoot, isCollection, set

Constructor Detail

AssociationMappingImpl

public AssociationMappingImpl(AbstractParentMapping<?,Z> parent,
                      AssociationAttributeMetadata metadata,
                      AttributeImpl<? super Z,X> attribute)

Parameters:

parent - the parent mapping

metadata - the metadata

attribute - the attribute

Since:

2.0.0

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:

2.0.0

cascadesMerge

public final boolean cascadesMerge()

Returns if the type cascades merge operations.

Returns:

true if the type cascades merge operations, false otherwise.

Since:

2.0.0

cascadesPersist

public final boolean cascadesPersist()

Returns if the type cascades persist operations.

Returns:

true if the type cascades persist operations, false otherwise.

Since:

2.0.0

cascadesRefresh

public final boolean cascadesRefresh()

Returns if the type cascades refresh operations.

Returns:

true if the type cascades refresh operations, false otherwise.

Since:

2.0.0

cascadesRemove

public final boolean cascadesRemove()

Returns if the type cascades remove operations.

Returns:

true if the type cascades remove operations, false otherwise.

Since:

2.0.0

checkTransient

public abstract void checkTransient(ManagedInstance<?> managedInstance)

Checks that the association references not a transient instance

Parameters:

managedInstance - the managed instance

Since:

2.0.0

flush

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

Flushes the associates.

Specified by:

flush in interface JoinedMapping<Z,X,Y>

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:

2.0.0

getAssociationMetadata

protected AssociationMetadata getAssociationMetadata()

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

Returns:

the column metadata

Since:

2.0.0

getFetchStrategy

public FetchStrategyType getFetchStrategy()

Returns the Fetching strategy of the association

Returns:

the Fetching strategy of the association

Since:

2.0.0

getInverse

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

Returns the inverse attribute.

Returns:

the inverse attribute or null

Since:

2.0.0

getJoinTable

public abstract JoinTable getJoinTable()

Returns the join table of the mapping.

Specified by:

getJoinTable in interface JoinedMapping<Z,X,Y>

Specified by:

getJoinTable in interface AssociationMapping<Z,X,Y>

Returns:

the join table of the mapping

Since:

2.0.0

getMappedBy

public String getMappedBy()

Returns the mappedBy of the mapping.

Returns:

the mappedBy of the mapping

Since:

2.0.0

getMaxFetchJoinDepth

public int getMaxFetchJoinDepth()

Returns the max allowed depth for the fetch join.

Returns:

the max allowed depth for the fetch join

Since:

2.0.0

getSelectCriteria

protected CriteriaQueryImpl<Y> getSelectCriteria()

Returns the select criteria.

Returns:

the select criteria

Since:

2.0.0

getType

public abstract EntityTypeImpl<Y> getType()

Returns the associate type of the mapping.

Specified by:

getType in interface JoinedMapping<Z,X,Y>

Returns:

the associate type of the mapping

Since:

2.0.1

initialize

public abstract void initialize(ManagedInstance<?> instance)

Initializes the mapping.

Specified by:

initialize in interface JoinedMapping<Z,X,Y>

Parameters:

instance - the instance

Since:

2.0.0

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:

2.0.0

isOwnerSelect

protected boolean isOwnerSelect()

Returns if the selection is owned.

Returns:

true if the selection is owned, false otherwise

Since:

2.0.0

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:

2.0.0

mergeWith

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

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

instances - the persisted instances

Since:

2.0.0

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:

2.0.0

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:

2.0.0

removesOrphans

public boolean removesOrphans()

Returns the if the mapping removes orphans.

Returns:

true if the mapping removes orphans, false otherwise

Since:

2.0.0

setInverse

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

Sets the inverse attribute.

Parameters:

inverse - the inverse association

Since:

2.0.0