org.batoo.jpa.core.impl.collections

Class ManagedCollection<E>

java.lang.Object

org.batoo.jpa.core.impl.collections.ManagedCollection<E>

Type Parameters:

E - the element type of the collection

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ManagedList, ManagedMap, ManagedSet

public abstract class ManagedCollection<E>
extends Object
implements Serializable

Marker interface for managed collections.

Since:

2.0.0

Author:

hceylan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ManagedCollection()
ManagedCollection(PluralMapping<?,?,E> mapping, ManagedInstance<?> managedInstance)

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	addChild(EntryImpl<Object,ManagedInstance<?>> child) Adds the child to the managed list without initialize checks.
abstract boolean	addElement(EntryImpl<Object,?> child) Adds the child to the managed list without initialize checks.
protected void	changed() Marks the collection as changed.
abstract void	flush(Connection connection, boolean removals, boolean force) Flushes the collection
abstract Collection<E>	getDelegate() Returns the delegate collection.
protected int	getInsertBatchSize() Returns the insertBatchSize of the ManagedCollection.
ManagedInstance<?>	getManagedInstance() Returns the managed instance of the managed collection.
protected PluralMapping<?,?,E>	getMapping() Returns the mapping of the managed collection.
protected abstract Collection<E>	getSnapshot() Return the items that are added.
abstract void	initialize() Initializes the managed collection.
abstract boolean	isInitialized() Returns if the list is initialized.
void	mergeWith(EntityManagerImpl entityManager, Object instance, org.apache.commons.lang.mutable.MutableBoolean requiresFlush, IdentityHashMap<Object,Object> processed) Merges the collection with the entity
void	persistAdditions(EntityManagerImpl entityManager) Persists the entities that have been added to the collection.
abstract void	refreshChildren() Refreshes the children of the managed collection.
protected abstract void	removeChild(E child) Removes the child from the managed list without initialize checks.
protected boolean	removed(Connection connection, boolean removals)
void	removeOrphans(EntityManagerImpl entityManager) Removes the entities that have been orphaned by removal from the collection.
protected void	reset() Clears the changed status.
protected abstract void	snapshot() Makes a snapshot of the collection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManagedCollection

public ManagedCollection()

Since:

2.0.0

ManagedCollection

public ManagedCollection(PluralMapping<?,?,E> mapping,
                 ManagedInstance<?> managedInstance)

Parameters:

mapping - the mapping

managedInstance - the managed instance

Since:

2.0.0

Method Detail

addChild

public abstract boolean addChild(EntryImpl<Object,ManagedInstance<?>> child)

Adds the child to the managed list without initialize checks.

Parameters:

child - the child to add

Returns:

if the child is added

Since:

2.0.0

addElement

public abstract boolean addElement(EntryImpl<Object,?> child)

Adds the child to the managed list without initialize checks.

Parameters:

child - the child to add

Returns:

if the child is added

Since:

2.0.0

changed

protected final void changed()

Marks the collection as changed.

Since:

2.0.0

flush

public abstract void flush(Connection connection,
         boolean removals,
         boolean force)
                    throws SQLException

Flushes the collection

Parameters:

connection - the connection

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 in case of an SQL error

Since:

2.0.0

getDelegate

public abstract Collection<E> getDelegate()

Returns the delegate collection.

Returns:

the delegate collection

Since:

2.0.0

getInsertBatchSize

protected int getInsertBatchSize()

Returns the insertBatchSize of the ManagedCollection.

Returns:

the insertBatchSize of the ManagedCollection

Since:

2.0.0

getManagedInstance

public ManagedInstance<?> getManagedInstance()

Returns the managed instance of the managed collection.

Returns:

the managed instance of the managed collection

Since:

2.0.0

getMapping

protected PluralMapping<?,?,E> getMapping()

Returns the mapping of the managed collection.

Returns:

the mapping of the managed collection

Since:

2.0.0

getSnapshot

protected abstract Collection<E> getSnapshot()

Return the items that are added.

Returns:

the items that are added

Since:

2.0.0

initialize

public abstract void initialize()

Initializes the managed collection.

Since:

2.0.0

isInitialized

public abstract boolean isInitialized()

Returns if the list is initialized.

Returns:

true if the list is initialized, false otherwise

Since:

2.0.0

mergeWith

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

Merges the collection with the entity

Parameters:

entityManager - the entity manager

instance - the new entity

requiresFlush - if an implicit flush is required

processed - registry of processed entities

Since:

2.0.0

persistAdditions

public void persistAdditions(EntityManagerImpl entityManager)

Persists the entities that have been added to the collection.

Parameters:

entityManager - the entity manager

Since:

2.0.0

refreshChildren

public abstract void refreshChildren()

Refreshes the children of the managed collection.

Since:

2.0.0

removeChild

protected abstract void removeChild(E child)

Removes the child from the managed list without initialize checks.

Parameters:

child - the child to add

Since:

2.0.0

removed

protected boolean removed(Connection connection,
              boolean removals)
                   throws SQLException

Parameters:

connection - the connection

removals - true if the removals should be flushed and false for the additions

Returns:

returns true if the instance has been removed

Throws:

SQLException - thrown in case of an SQL error

Since:

2.0.0

removeOrphans

public void removeOrphans(EntityManagerImpl entityManager)

Removes the entities that have been orphaned by removal from the collection.

Parameters:

entityManager - the entity manager

Since:

2.0.0

reset

protected void reset()

Clears the changed status.

Since:

2.0.0

snapshot

protected abstract void snapshot()

Makes a snapshot of the collection

Since:

2.0.0