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

Interface PluralMapping<Z,C,E>

Type Parameters:

Z - the source type

C - the collection type

E - the destination type

All Superinterfaces:

JoinedMapping<Z,C,E>

All Known Implementing Classes:

ElementCollectionMapping, PluralAssociationMapping

public interface PluralMapping<Z,C,E>
extends JoinedMapping<Z,C,E>

The base class for EmbeddedMapping and BasicMapping.

Since:

$version

Author:

hceylan

Nested Class Summary

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

JoinedMapping.MappingType

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	get(Object instance) Returns the values of the mapping.
TypeImpl<?>	getMapKeyClass() Returns the class of the map key.
Mapping<?,?,?>	getMapping(String path) Returns child mapping of the type.
String	getOrderBy() Returns the order by of the association.
OrderColumn	getOrderColumn() Returns the order column.
String	getPath() Returns the path of the mapping.
RootMapping<?>	getRoot() Returns the root mapping.
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 interface org.batoo.jpa.core.impl.model.mapping.JoinedMapping

extractKey, flush, getAttribute, getMappingType, getTable, getType, initialize, isAssociation, isEager, isJoined, isMap, join

Method Detail

attach

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

Attaches the child.

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

Since:

$version

cascadesMerge

boolean cascadesMerge()

Returns if merges are cascaded.

Returns:

true if merges are cascaded, false otherwise

Since:

$version

detach

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

detaches the child.

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

Since:

$version

detachAll

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

Details all the children.

Parameters:

connection - the connection

instance - the instance

Throws:

SQLException - thrown in case of an SQL error

Since:

$version

enhance

void enhance(ManagedInstance<?> instance)

Enhances the collection to the managed collection

Parameters:

instance - the managed instance

Since:

$version

get

Object get(Object instance)

Returns the values of the mapping.

Parameters:

instance -

Returns:

the value of the instance

Since:

$version

getMapKeyClass

TypeImpl<?> getMapKeyClass()

Returns the class of the map key.

Returns:

the class of the map key

Since:

$version

getMapping

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

Returns child mapping of the type.

Parameters:

path - the path

Returns:

the child mapping

Since:

$version

getOrderBy

String getOrderBy()

Returns the order by of the association.

Returns:

the order by of the association

Since:

$versionpublic RootMapping getRoot()

getOrderColumn

OrderColumn getOrderColumn()

Returns the order column.

Returns:

the order column

Since:

$version

getPath

String getPath()

Returns the path of the mapping.

Returns:

the path of the mapping

Since:

$version

getRoot

RootMapping<?> getRoot()

Returns the root mapping.

Returns:

the root mapping

Since:

$version

load

void load(ManagedInstance<?> instance)

Loads the collection eagerly.

Parameters:

instance - the managed instance

Since:

$version

loadCollection

Collection<? extends E> loadCollection(ManagedInstance<?> instance)

Loads and returns the collection.

Parameters:

instance - the managed instance owning the collection

Returns:

the loaded collection

Since:

$version

loadMap

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

Loads and returns the map

Type Parameters:

K - the key type of the map

Parameters:

instance -

Returns:

the loaded map

Since:

$version

setCollection

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

Sets the collection manually for the mapping.

Parameters:

instance - the managed instance

children - the collection of children

Since:

$version

setLazy

void setLazy(ManagedInstance<?> instance)

Sets the lazy instance for the collection

Parameters:

instance - the managed instance

Since:

$version

sortList

void sortList(Object instance)

Sorts the managed list of the instance

Parameters:

instance - the owner instance

Since:

$version