org.hibernate.collection.internal

Class AbstractPersistentCollection

java.lang.Object

org.hibernate.collection.internal.AbstractPersistentCollection

All Implemented Interfaces:

java.io.Serializable, org.hibernate.collection.spi.PersistentCollection

public abstract class AbstractPersistentCollection
extends java.lang.Object
implements java.io.Serializable, org.hibernate.collection.spi.PersistentCollection

Base class implementing PersistentCollection This a extended copy of the original class from hibernate. It has been extended to allow making remote service calls to spring httpinvoker services (see section at the bottom of this class).

Author:

Gavin King, Cherian Mathew

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractPersistentCollection.DelayedOperation Contract for operations which are part of a collection's operation queue.
protected class	AbstractPersistentCollection.IteratorProxy
static interface	AbstractPersistentCollection.LazyInitializationWork<T>
protected class	AbstractPersistentCollection.ListIteratorProxy
protected class	AbstractPersistentCollection.ListProxy
protected class	AbstractPersistentCollection.SetProxy

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object	UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractPersistentCollection() Not called by Hibernate, but used by non-JDK serialization, eg.
protected	AbstractPersistentCollection(org.hibernate.engine.spi.SessionImplementor session)

Method Summary

Modifier and Type	Method and Description
boolean	afterInitialize()
void	afterRowInsert(org.hibernate.persister.collection.CollectionPersister persister, java.lang.Object entry, int i) Called after inserting a row, to fetch the natively generated id
void	beginRead() Called just before reading any rows from the JDBC result set
void	clearDirty()
void	dirty()
abstract boolean	empty() Is the initialized collection empty?
boolean	endRead() Called after reading all rows from the JDBC result set
void	forceInitialization() To be called internally by the session, forcing immediate initialization.
protected int	getCachedSize()
java.lang.Object	getIdentifier(java.lang.Object entry, int i)
java.io.Serializable	getKey()
protected static java.util.Collection	getOrphans(java.util.Collection oldElements, java.util.Collection currentElements, java.lang.String entityName, org.hibernate.engine.spi.SessionImplementor session) Given a collection of entity instances that used to belong to the collection, and a collection of instances that currently belong, return a collection of orphans
abstract java.util.Collection	getOrphans(java.io.Serializable snapshot, java.lang.String entityName) get all "orphaned" elements
java.lang.Object	getOwner()
java.util.Collection	getQueuedOrphans(java.lang.String entityName) Iterate the "queued" additions
java.lang.String	getRole()
org.hibernate.engine.spi.SessionImplementor	getSession() Get the current session
protected java.io.Serializable	getSnapshot() Get the current snapshot from the session
java.io.Serializable	getStoredSnapshot()
java.lang.Object	getValue() return the user-visible collection (or array) instance
boolean	hasQueuedOperations() Does this instance have any "queued" additions?
static void	identityRemove(java.util.Collection list, java.lang.Object object, java.lang.String entityName, org.hibernate.engine.spi.SessionImplementor session)
protected void	initialize(boolean writing) Initialize the collection, if possible, wrapping any exceptions in a runtime exception
protected boolean	isClearQueueEnabled() Is this collection in a state that would allow us to "queue" clear? This is a special case, because of orphan delete.
boolean	isDirectlyAccessible() Could the application possibly have a direct reference to the underlying collection implementation?
boolean	isDirty()
protected boolean	isOperationQueueEnabled() Is this collection in a state that would allow us to "queue" operations?
protected boolean	isPutQueueEnabled() Is this collection in a state that would allow us to "queue" puts? This is a special case, because of orphan delete.
boolean	isRowUpdatePossible()
boolean	isUnreferenced()
boolean	needsRecreate(org.hibernate.persister.collection.CollectionPersister persister) Do we need to completely recreate this collection when it changes?
protected void	performQueuedOperations() After reading all existing elements from the database, add the queued elements to the underlying collection.
void	postAction() After flushing, clear any "queued" additions, since the database state is now synchronized with the memory state.
void	preInsert(org.hibernate.persister.collection.CollectionPersister persister) Called before inserting rows, to ensure that any surrogate keys are fully generated
protected void	prepareForPossibleSpecialSpecjInitialization()
java.util.Iterator	queuedAdditionIterator() Iterate the "queued" additions
protected void	queueOperation(AbstractPersistentCollection.DelayedOperation operation) Queue an addition
protected void	read() Called by any read-only method of the collection interface
protected java.lang.Object	readElementByIndex(java.lang.Object index)
protected java.lang.Boolean	readElementExistence(java.lang.Object element)
protected java.lang.Boolean	readIndexExistence(java.lang.Object index)
protected boolean	readSize() Called by the Collection.size() method
static void	setConfiguration(CdmApplicationRemoteConfiguration conf)
boolean	setCurrentSession(org.hibernate.engine.spi.SessionImplementor session) Associate the collection with the given session.
protected void	setDirectlyAccessible(boolean directlyAccessible)
protected void	setInitialized()
void	setOwner(java.lang.Object owner)
void	setSnapshot(java.io.Serializable key, java.lang.String role, java.io.Serializable snapshot) After flushing, re-init snapshot state.
boolean	unsetSession(org.hibernate.engine.spi.SessionImplementor currentSession) Disassociate this collection from the given session.
boolean	wasInitialized() Is this instance initialized?
protected void	write() Called by any writer method of the collection interface

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.collection.spi.PersistentCollection

beforeInitialize, disassemble, entries, entryExists, equalsSnapshot, getDeletes, getElement, getIndex, getSnapshot, getSnapshotElement, initializeFromCache, isSnapshotEmpty, isWrapper, needsInserting, needsUpdating, readFrom

Field Detail

UNKNOWN

protected static final java.lang.Object UNKNOWN

Constructor Detail

AbstractPersistentCollection

public AbstractPersistentCollection()

Not called by Hibernate, but used by non-JDK serialization, eg. SOAP libraries.

AbstractPersistentCollection

protected AbstractPersistentCollection(org.hibernate.engine.spi.SessionImplementor session)

Method Detail

getRole

public final java.lang.String getRole()

Specified by:

getRole in interface org.hibernate.collection.spi.PersistentCollection

getKey

public final java.io.Serializable getKey()

Specified by:

getKey in interface org.hibernate.collection.spi.PersistentCollection

isUnreferenced

public final boolean isUnreferenced()

Specified by:

isUnreferenced in interface org.hibernate.collection.spi.PersistentCollection

isDirty

public final boolean isDirty()

Specified by:

isDirty in interface org.hibernate.collection.spi.PersistentCollection

clearDirty

public final void clearDirty()

Specified by:

clearDirty in interface org.hibernate.collection.spi.PersistentCollection

dirty

public final void dirty()

Specified by:

dirty in interface org.hibernate.collection.spi.PersistentCollection

getStoredSnapshot

public final java.io.Serializable getStoredSnapshot()

Specified by:

getStoredSnapshot in interface org.hibernate.collection.spi.PersistentCollection

empty

public abstract boolean empty()

Is the initialized collection empty?

Specified by:

empty in interface org.hibernate.collection.spi.PersistentCollection

read

protected final void read()

Called by any read-only method of the collection interface

readSize

protected boolean readSize()

Called by the Collection.size() method

readIndexExistence

protected java.lang.Boolean readIndexExistence(java.lang.Object index)

readElementExistence

protected java.lang.Boolean readElementExistence(java.lang.Object element)

readElementByIndex

protected java.lang.Object readElementByIndex(java.lang.Object index)

getCachedSize

protected int getCachedSize()

write

protected final void write()

Called by any writer method of the collection interface

isOperationQueueEnabled

protected boolean isOperationQueueEnabled()

Is this collection in a state that would allow us to "queue" operations?

isPutQueueEnabled

protected boolean isPutQueueEnabled()

Is this collection in a state that would allow us to "queue" puts? This is a special case, because of orphan delete.

isClearQueueEnabled

protected boolean isClearQueueEnabled()

Is this collection in a state that would allow us to "queue" clear? This is a special case, because of orphan delete.

queueOperation

protected final void queueOperation(AbstractPersistentCollection.DelayedOperation operation)

Queue an addition

performQueuedOperations

protected final void performQueuedOperations()

After reading all existing elements from the database, add the queued elements to the underlying collection.

setSnapshot

public void setSnapshot(java.io.Serializable key,
                        java.lang.String role,
                        java.io.Serializable snapshot)

After flushing, re-init snapshot state.

Specified by:

setSnapshot in interface org.hibernate.collection.spi.PersistentCollection

postAction

public void postAction()

After flushing, clear any "queued" additions, since the database state is now synchronized with the memory state.

Specified by:

postAction in interface org.hibernate.collection.spi.PersistentCollection

getValue

public java.lang.Object getValue()

return the user-visible collection (or array) instance

Specified by:

getValue in interface org.hibernate.collection.spi.PersistentCollection

beginRead

public void beginRead()

Called just before reading any rows from the JDBC result set

Specified by:

beginRead in interface org.hibernate.collection.spi.PersistentCollection

endRead

public boolean endRead()

Called after reading all rows from the JDBC result set

Specified by:

endRead in interface org.hibernate.collection.spi.PersistentCollection

afterInitialize

public boolean afterInitialize()

Specified by:

afterInitialize in interface org.hibernate.collection.spi.PersistentCollection

initialize

protected final void initialize(boolean writing)

Initialize the collection, if possible, wrapping any exceptions in a runtime exception

Parameters:

writing - currently obsolete

Throws:

org.hibernate.LazyInitializationException - if we cannot initialize

setInitialized

protected final void setInitialized()

setDirectlyAccessible

protected final void setDirectlyAccessible(boolean directlyAccessible)

isDirectlyAccessible

public boolean isDirectlyAccessible()

Could the application possibly have a direct reference to the underlying collection implementation?

Specified by:

isDirectlyAccessible in interface org.hibernate.collection.spi.PersistentCollection

unsetSession

public final boolean unsetSession(org.hibernate.engine.spi.SessionImplementor currentSession)

Disassociate this collection from the given session.

Specified by:

unsetSession in interface org.hibernate.collection.spi.PersistentCollection

Returns:

true if this was currently associated with the given session

prepareForPossibleSpecialSpecjInitialization

protected void prepareForPossibleSpecialSpecjInitialization()

setCurrentSession

public final boolean setCurrentSession(org.hibernate.engine.spi.SessionImplementor session)
                                throws org.hibernate.HibernateException

Associate the collection with the given session.

Specified by:

setCurrentSession in interface org.hibernate.collection.spi.PersistentCollection

Returns:

false if the collection was already associated with the session

Throws:

org.hibernate.HibernateException - if the collection was already associated with another open session

needsRecreate

public boolean needsRecreate(org.hibernate.persister.collection.CollectionPersister persister)

Do we need to completely recreate this collection when it changes?

Specified by:

needsRecreate in interface org.hibernate.collection.spi.PersistentCollection

forceInitialization

public final void forceInitialization()
                               throws org.hibernate.HibernateException

To be called internally by the session, forcing immediate initialization.

Specified by:

forceInitialization in interface org.hibernate.collection.spi.PersistentCollection

Throws:

org.hibernate.HibernateException

getSnapshot

protected final java.io.Serializable getSnapshot()

Get the current snapshot from the session

wasInitialized

public final boolean wasInitialized()

Is this instance initialized?

Specified by:

wasInitialized in interface org.hibernate.collection.spi.PersistentCollection

isRowUpdatePossible

public boolean isRowUpdatePossible()

Specified by:

isRowUpdatePossible in interface org.hibernate.collection.spi.PersistentCollection

hasQueuedOperations

public final boolean hasQueuedOperations()

Does this instance have any "queued" additions?

Specified by:

hasQueuedOperations in interface org.hibernate.collection.spi.PersistentCollection

queuedAdditionIterator

public final java.util.Iterator queuedAdditionIterator()

Iterate the "queued" additions

Specified by:

queuedAdditionIterator in interface org.hibernate.collection.spi.PersistentCollection

getQueuedOrphans

public final java.util.Collection getQueuedOrphans(java.lang.String entityName)

Iterate the "queued" additions

Specified by:

getQueuedOrphans in interface org.hibernate.collection.spi.PersistentCollection

preInsert

public void preInsert(org.hibernate.persister.collection.CollectionPersister persister)
               throws org.hibernate.HibernateException

Called before inserting rows, to ensure that any surrogate keys are fully generated

Specified by:

preInsert in interface org.hibernate.collection.spi.PersistentCollection

Throws:

org.hibernate.HibernateException

afterRowInsert

public void afterRowInsert(org.hibernate.persister.collection.CollectionPersister persister,
                           java.lang.Object entry,
                           int i)
                    throws org.hibernate.HibernateException

Called after inserting a row, to fetch the natively generated id

Specified by:

afterRowInsert in interface org.hibernate.collection.spi.PersistentCollection

Throws:

org.hibernate.HibernateException

getOrphans

public abstract java.util.Collection getOrphans(java.io.Serializable snapshot,
                                                java.lang.String entityName)
                                         throws org.hibernate.HibernateException

get all "orphaned" elements

Specified by:

getOrphans in interface org.hibernate.collection.spi.PersistentCollection

Throws:

org.hibernate.HibernateException

getSession

public final org.hibernate.engine.spi.SessionImplementor getSession()

Get the current session

getOrphans

protected static java.util.Collection getOrphans(java.util.Collection oldElements,
                                                 java.util.Collection currentElements,
                                                 java.lang.String entityName,
                                                 org.hibernate.engine.spi.SessionImplementor session)
                                          throws org.hibernate.HibernateException

Given a collection of entity instances that used to belong to the collection, and a collection of instances that currently belong, return a collection of orphans

Throws:

org.hibernate.HibernateException

identityRemove

public static void identityRemove(java.util.Collection list,
                                  java.lang.Object object,
                                  java.lang.String entityName,
                                  org.hibernate.engine.spi.SessionImplementor session)
                           throws org.hibernate.HibernateException

Throws:

org.hibernate.HibernateException

getIdentifier

public java.lang.Object getIdentifier(java.lang.Object entry,
                                      int i)

Specified by:

getIdentifier in interface org.hibernate.collection.spi.PersistentCollection

getOwner

public java.lang.Object getOwner()

Specified by:

getOwner in interface org.hibernate.collection.spi.PersistentCollection

setOwner

public void setOwner(java.lang.Object owner)

Specified by:

setOwner in interface org.hibernate.collection.spi.PersistentCollection

setConfiguration

public static void setConfiguration(CdmApplicationRemoteConfiguration conf)