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

Class PluralAssociationMapping<Z,C,E>

java.lang.Object

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

org.batoo.jpa.core.impl.model.mapping.AssociationMapping<Z,C,E>

org.batoo.jpa.core.impl.model.mapping.PluralAssociationMapping<Z,C,E>

Type Parameters:

Z - the source type

E - the element type

C - the collection type

All Implemented Interfaces:

JoinedMapping<Z,C,E>, PluralMapping<Z,C,E>

public class PluralAssociationMapping<Z,C,E>
extends AssociationMapping<Z,C,E>
implements PluralMapping<Z,C,E>

Since:

2.0.0

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
PluralAssociationMapping(ParentMapping<?,Z> parent, PluralAttributeImpl<? super Z,C,E> attribute)

Method Summary

Methods

Modifier and Type	Method and Description
void	attach(Connection connection, ManagedInstance<?> instance, Joinable[] batch, int batchSize) Attaches the child.
void	checkTransient(ManagedInstance<?> managedInstance) Checks that the association references not a transient instance
void	detach(Connection connection, ManagedInstance<?> instance, Object key, Object child) detaches the child.
void	detachAll(Connection connection, ManagedInstance<?> instance) Details all the children.
void	enhance(ManagedInstance<?> instance) Enhances the collection to the managed collection
Object	extractKey(Object value) Extracts key from the value.
void	flush(Connection connection, ManagedInstance<?> managedInstance, boolean removals, boolean force) Flushes the associates.
PluralAttributeImpl<? super Z,C,E>	getAttribute() Returns the attribute of the mapping.
ForeignKey	getForeignKey() Returns the foreign key of the mapping.
AssociationMapping<?,?,?>	getInverse() Returns the inverse attribute.
SingularMapping<? super E,?>	getMapKeyIdMapping() Returns the key mapping of the association.
Pair<SingularMapping<? super E,?>,org.batoo.common.reflect.AbstractAccessor>[]	getMapKeyIdMappings() Returns the map key id mappings of the association.
Mapping<?,?,?>	getMapping(String path) Returns child mapping of the type.
JoinedMapping.MappingType	getMappingType() Returns the type of the mapping.
String	getOrderBy() Returns the order by of the association.
OrderColumn	getOrderColumn() Returns the order column.
JoinTable	getTable() Returns the join table of the mapping.
EntityTypeImpl<E>	getType() Returns the bindable entity type.
void	initialize(ManagedInstance<?> instance) Initializes the mapping.
boolean	isAssociation() Returns if the mapping is an association.
boolean	isJoined() Returns if the mapping is a joined mapping.
boolean	isMap() Returns if the mapping is a map collection.
void	link() Links the attribute to its associate entity type and inverse attribute if bidirectional.
void	load(ManagedInstance<?> instance) Loads the collection eagerly.
Collection<? extends E>	loadCollection(ManagedInstance<?> managedInstance) Loads and returns the collection.
<K> Map<? extends K,? extends E>	loadMap(ManagedInstance<?> instance) Loads and returns the map
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.
void	persistAdditions(EntityManagerImpl entityManager, ManagedInstance<?> instance) Persists the children that have been added to the managed collection
boolean	references(Object instance, Object reference)
void	refresh(ManagedInstance<?> instance, Set<Object> processed) Refreshes the association
void	removeOrphans(EntityManagerImpl entityManager, ManagedInstance<?> instance) Removes the children that have been orphaned due to removal from the managed collection
void	setCollection(ManagedInstance<?> instance, Collection<? extends E> children) Sets the collection manually for the mapping.
void	setInverse(AssociationMapping<?,?,?> inverse) Sets the inverse attribute.
void	setLazy(ManagedInstance<?> instance) Sets the lazy instance for the collection
void	sortList(Object instance) Sorts the managed list of the instance

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

cascadesDetach, cascadesMerge, cascadesPersist, cascadesRefresh, cascadesRemove, getAssociationMetadata, getFetchStrategy, getMappedBy, getMaxFetchJoinDepth, getSelectCriteria, isEager, isId, isOwner, isOwnerSelect, join, removesOrphans

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

equals, get, getIdType, 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.PluralMapping

cascadesMerge, get, getRoot

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

getPath, isEager, join

Constructor Detail

PluralAssociationMapping

public PluralAssociationMapping(ParentMapping<?,Z> parent,
                        PluralAttributeImpl<? super Z,C,E> attribute)

Parameters:

parent - the parent mapping

attribute - the attribute

Since:

2.0.0

Method Detail

attach

public void attach(Connection connection,
          ManagedInstance<?> instance,
          Joinable[] batch,
          int batchSize)
            throws SQLException

Attaches the child.

Specified by:

attach in interface PluralMapping<Z,C,E>

Parameters:

connection - the connection

instance - the instance

batch - the batch of children

batchSize - the size of the batch

Throws:

SQLException - thrown in case of an SQL error

checkTransient

public void checkTransient(ManagedInstance<?> managedInstance)

Checks that the association references not a transient instance

Specified by:

checkTransient in class AssociationMapping<Z,C,E>

Parameters:

managedInstance - the managed instance

detach

public void detach(Connection connection,
          ManagedInstance<?> instance,
          Object key,
          Object child)
            throws SQLException

detaches the child.

Specified by:

detach in interface PluralMapping<Z,C,E>

Parameters:

connection - the connection

instance - the instance

key - the key, may be null

child - the child

Throws:

SQLException - thrown in case of an SQL error

detachAll

public void detachAll(Connection connection,
             ManagedInstance<?> instance)
               throws SQLException

Details all the children.

Specified by:

detachAll in interface PluralMapping<Z,C,E>

Parameters:

connection - the connection

instance - the instance

Throws:

SQLException - thrown in case of an SQL error

enhance

public void enhance(ManagedInstance<?> instance)

Enhances the collection to the managed collection

Specified by:

enhance in interface PluralMapping<Z,C,E>

Parameters:

instance - the managed instance

extractKey

public Object extractKey(Object value)

Extracts key from the value.

Specified by:

extractKey in interface JoinedMapping<Z,C,E>

Parameters:

value - the value

Returns:

the key of the value

flush

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

Flushes the associates.

Specified by:

flush in interface JoinedMapping<Z,C,E>

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

getAttribute

public PluralAttributeImpl<? super Z,C,E> getAttribute()

Returns the attribute of the mapping.

Specified by:

getAttribute in interface JoinedMapping<Z,C,E>

Specified by:

getAttribute in class Mapping<Z,C,E>

Returns:

the attribute of the mapping

getForeignKey

public ForeignKey getForeignKey()

Returns the foreign key of the mapping.

Specified by:

getForeignKey in class AssociationMapping<Z,C,E>

Returns:

the foreign key of the mapping

getInverse

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

Returns the inverse attribute.

Specified by:

getInverse in class AssociationMapping<Z,C,E>

Returns:

the inverse attribute or null

getMapKeyIdMapping

public SingularMapping<? super E,?> getMapKeyIdMapping()

Returns the key mapping of the association.

Returns:

the key mapping of the association

Since:

2.0.0

getMapKeyIdMappings

public Pair<SingularMapping<? super E,?>,org.batoo.common.reflect.AbstractAccessor>[] getMapKeyIdMappings()

Returns the map key id mappings of the association.

Returns:

the map key id mappings of the association

Since:

2.0.0

getMapping

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

Returns child mapping of the type.

Specified by:

getMapping in interface PluralMapping<Z,C,E>

Parameters:

path - the path

Returns:

the child mapping

getMappingType

public JoinedMapping.MappingType getMappingType()

Returns the type of the mapping.

Specified by:

getMappingType in interface JoinedMapping<Z,C,E>

Returns:

the type of the mapping

getOrderBy

public String getOrderBy()

Returns the order by of the association.

Specified by:

getOrderBy in interface PluralMapping<Z,C,E>

Returns:

the order by of the association

getOrderColumn

public OrderColumn getOrderColumn()

Returns the order column.

Specified by:

getOrderColumn in interface PluralMapping<Z,C,E>

Returns:

the order column

getTable

public JoinTable getTable()

Returns the join table of the mapping.

Specified by:

getTable in interface JoinedMapping<Z,C,E>

Specified by:

getTable in class AssociationMapping<Z,C,E>

Returns:

the join table of the mapping

getType

public EntityTypeImpl<E> getType()

Returns the bindable entity type.

Specified by:

getType in interface JoinedMapping<Z,C,E>

Specified by:

getType in class AssociationMapping<Z,C,E>

Returns:

the bindable entity type

initialize

public void initialize(ManagedInstance<?> instance)

Initializes the mapping.

Specified by:

initialize in interface JoinedMapping<Z,C,E>

Parameters:

instance - the instance

isAssociation

public boolean isAssociation()

Returns if the mapping is an association.

Specified by:

isAssociation in interface JoinedMapping<Z,C,E>

Returns:

true if the mapping is an association, false otherwise

isJoined

public boolean isJoined()

Returns if the mapping is a joined mapping.

Specified by:

isJoined in interface JoinedMapping<Z,C,E>

Returns:

true if the mapping is a joined mapping, false otherwise

isMap

public boolean isMap()

Returns if the mapping is a map collection.

Specified by:

isMap in interface JoinedMapping<Z,C,E>

Returns:

true if the mapping is a map collection, false otherwise

link

public void link()
          throws MappingException

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

Specified by:

link in class AssociationMapping<Z,C,E>

Throws:

MappingException - thrown in case of a linkage error

load

public void load(ManagedInstance<?> instance)

Loads the collection eagerly.

Specified by:

load in interface PluralMapping<Z,C,E>

Parameters:

instance - the managed instance

loadCollection

public Collection<? extends E> loadCollection(ManagedInstance<?> managedInstance)

Loads and returns the collection.

Specified by:

loadCollection in interface PluralMapping<Z,C,E>

Parameters:

managedInstance - the managed instance owning the collection

Returns:

the loaded collection

loadMap

public <K> Map<? extends K,? extends E> loadMap(ManagedInstance<?> instance)

Loads and returns the map

Specified by:

loadMap in interface PluralMapping<Z,C,E>

Type Parameters:

K - the key type of the map

Returns:

the loaded map

mergeWith

public 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.

Specified by:

mergeWith in class AssociationMapping<Z,C,E>

Parameters:

entityManager - the entity manager

instance - the instance

entity - the entity

requiresFlush - if an implicit flush is required

processed - registry of processed entities

persistAdditions

public void persistAdditions(EntityManagerImpl entityManager,
                    ManagedInstance<?> instance)

Persists the children that have been added to the managed collection

Parameters:

entityManager - the entity manager

instance - the managed instance

Since:

2.0.0

references

public boolean references(Object instance,
                 Object reference)

Specified by:

references in class AssociationMapping<Z,C,E>

Parameters:

instance - the source instance

reference - the associate instance

Returns:

true if source contains reference to the associate, false otherwise

refresh

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

Refreshes the association

Specified by:

refresh in class AssociationMapping<Z,C,E>

Parameters:

instance - the instance that is the owner of the association

processed - the set of processed instances

removeOrphans

public void removeOrphans(EntityManagerImpl entityManager,
                 ManagedInstance<?> instance)

Removes the children that have been orphaned due to removal from the managed collection

Parameters:

entityManager - the entity manager

instance - the managed instance

Since:

2.0.0

setCollection

public void setCollection(ManagedInstance<?> instance,
                 Collection<? extends E> children)

Sets the collection manually for the mapping.

Specified by:

setCollection in interface PluralMapping<Z,C,E>

Parameters:

instance - the managed instance

children - the collection of children

setInverse

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

Sets the inverse attribute.

Specified by:

setInverse in class AssociationMapping<Z,C,E>

Parameters:

inverse - the inverse association

setLazy

public void setLazy(ManagedInstance<?> instance)

Sets the lazy instance for the collection

Specified by:

setLazy in interface PluralMapping<Z,C,E>

Parameters:

instance - the managed instance

sortList

public void sortList(Object instance)

Sorts the managed list of the instance

Specified by:

sortList in interface PluralMapping<Z,C,E>

Parameters:

instance - the owner instance