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

Class ElementCollectionMapping<Z,C,E>

java.lang.Object

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

org.batoo.jpa.core.impl.model.mapping.ElementCollectionMapping<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 ElementCollectionMapping<Z,C,E>
extends Mapping<Z,C,E>
implements PluralMapping<Z,C,E>

Mapping for element collections.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	attach(ConnectionImpl connection, ManagedInstance<?> instance, Object key, Object child, int index) Attaches the child.
boolean	cascadesMerge() Returns if merges are cascaded.
void	detach(ConnectionImpl connection, ManagedInstance<?> instance, Object key, Object child) detaches the child.
void	detachAll(ConnectionImpl connection, ManagedInstance<?> instance) Details all the children.
void	enhance(ManagedInstance<?> instance) Enhances the collection to the managed collection
Object	extractKey(E value) Extracts key from the value.
void	flush(ConnectionImpl connection, ManagedInstance<?> managedInstance, boolean removals, boolean force) Flushes the associates.
PluralAttributeImpl<? super Z,C,E>	getAttribute() Returns the attribute of the mapping.
CollectionTable	getCollectionTable() Returns the collection table.
SingularMapping<? super E,?>	getKeyMapping() Returns the key mapping of the element collection mapping.
String	getMapKey() Returns the map key of the element collection mapping.
TypeImpl<?>	getMapKeyClass() Returns the class of the map key.
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.
JoinableTable	getTable() Returns the table for the relation.
TypeImpl<E>	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.
void	link() Links the attribute to its collection table
void	load(ManagedInstance<?> instance) Loads the collection eagerly.
Collection<? extends E>	loadCollection(ManagedInstance<?> instance) Loads and returns the collection.
<K> Map<? extends K,? extends E>	loadMap(ManagedInstance<?> instance) Loads and returns the map
void	setCollection(ManagedInstance<?> instance, Collection<? extends E> children) Sets the collection manually for the mapping.
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.Mapping

equals, get, 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

get, getPath, getRoot

Constructor Detail

ElementCollectionMapping

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

Parameters:

parent - the parent mapping

attribute - the attribute

Since:

$version

Method Detail

attach

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

Attaches the child.

Specified by:

attach in interface PluralMapping<Z,C,E>

Parameters:

connection - the connection

instance - the instance

key - the key, may be null

child - the child

index - the index

Throws:

SQLException - thrown in case of an SQL error

cascadesMerge

public boolean cascadesMerge()

Returns if merges are cascaded.

Specified by:

cascadesMerge in interface PluralMapping<Z,C,E>

Returns:

true if merges are cascaded, false otherwise

detach

public void detach(ConnectionImpl 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(ConnectionImpl 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(E 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(ConnectionImpl 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

getCollectionTable

public CollectionTable getCollectionTable()

Returns the collection table.

Returns:

the collection table

Since:

$version

getKeyMapping

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

Returns the key mapping of the element collection mapping.

Returns:

the key mapping of the element collection mapping

Since:

$version

getMapKey

public String getMapKey()

Returns the map key of the element collection mapping.

Returns:

the map key of the element collection mapping

Since:

$version

getMapKeyClass

public TypeImpl<?> getMapKeyClass()

Returns the class of the map key.

Specified by:

getMapKeyClass in interface PluralMapping<Z,C,E>

Returns:

the class of the map key

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 JoinableTable getTable()

Returns the table for the relation.

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

Specified by:

getTable in interface JoinedMapping<Z,C,E>

Returns:

the table

getType

public TypeImpl<E> getType()

Returns the bindable entity type.

Specified by:

getType in interface JoinedMapping<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

isEager

public boolean isEager()

Returns if the association should be eagerly fetched.

Specified by:

isEager in interface JoinedMapping<Z,C,E>

Returns:

true if the association should be eagerly fetched

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

join

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

Returns the join SQL for the mapping.

Specified by:

join in interface JoinedMapping<Z,C,E>

Parameters:

parentAlias - the parent table alias

alias - the primary table alias

joinType - the join type

Returns:

the join SQL for the mapping

link

public void link()

Links the attribute to its collection table

Throws:

MappingException - thrown in case of a linkage error

Since:

$version

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<?> instance)

Loads and returns the collection.

Specified by:

loadCollection in interface PluralMapping<Z,C,E>

Parameters:

instance - 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

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

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