org.hibernate.collection.internal

Class PersistentArrayHolder

java.lang.Object

org.hibernate.collection.internal.AbstractPersistentCollection

org.hibernate.collection.internal.PersistentArrayHolder

All Implemented Interfaces:

Serializable, PersistentCollection

public class PersistentArrayHolder
extends AbstractPersistentCollection

A persistent wrapper for an array. Lazy initialization is NOT supported. Use of Hibernate arrays is not really recommended.

Author:

Gavin King

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hibernate.collection.internal.AbstractPersistentCollection

AbstractPersistentCollection.AbstractValueDelayedOperation, AbstractPersistentCollection.DelayedOperation, AbstractPersistentCollection.IteratorProxy, AbstractPersistentCollection.LazyInitializationWork<T>, AbstractPersistentCollection.ListIteratorProxy, AbstractPersistentCollection.ListProxy, AbstractPersistentCollection.SetProxy, AbstractPersistentCollection.ValueDelayedOperation

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	array

Fields inherited from class org.hibernate.collection.internal.AbstractPersistentCollection

elementRemoved, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
PersistentArrayHolder(SessionImplementor session, CollectionPersister persister) Deprecated. PersistentArrayHolder(SharedSessionContractImplementor, CollectionPersister) should be used instead.
PersistentArrayHolder(SessionImplementor session, Object array) Deprecated. PersistentArrayHolder(SharedSessionContractImplementor, Object) should be used instead.
PersistentArrayHolder(SharedSessionContractImplementor session, CollectionPersister persister) Constructs a PersistentCollection instance for holding an array.
PersistentArrayHolder(SharedSessionContractImplementor session, Object array) Constructs a PersistentCollection instance for holding an array.

Method Summary

Modifier and Type	Method and Description
void	beforeInitialize(CollectionPersister persister, int anticipatedSize) Called before any elements are read into the collection, allowing appropriate initializations to occur.
void	beginRead() Called just before reading any rows from the JDBC result set
Serializable	disassemble(CollectionPersister persister) Disassemble the collection to get it ready for the cache
Iterator	elements() Get an iterator over the array elements
boolean	empty() Is the collection empty? (don't try to initialize the collection)
boolean	endRead() Called after reading all rows from the JDBC result set
Iterator	entries(CollectionPersister persister) Iterate all collection entries, during update of the database
boolean	entryExists(Object entry, int i) Does the given element/entry exist in the collection?
boolean	equalsSnapshot(CollectionPersister persister) Does the current state exactly match the snapshot?
Object	getArray()
Iterator	getDeletes(CollectionPersister persister, boolean indexIsFormula) Get all the elements that need deleting
Object	getElement(Object entry) Get the value of the given collection entry.
Object	getIndex(Object entry, int i, CollectionPersister persister) Get the index of the given collection entry
Collection	getOrphans(Serializable snapshot, String entityName) get all "orphaned" elements
Serializable	getSnapshot(CollectionPersister persister) Return a new snapshot of the current state of the collection
Object	getSnapshotElement(Object entry, int i) Get the snapshot value of the given collection entry
Object	getValue() Return the user-visible collection (or array) instance
void	initializeFromCache(CollectionPersister persister, Serializable disassembled, Object owner) Read the state of the collection from a disassembled cached value
boolean	isDirectlyAccessible() Could the application possibly have a direct reference to the underlying collection implementation?
boolean	isSnapshotEmpty(Serializable snapshot) Is the snapshot empty?
boolean	isWrapper(Object collection) Is this the wrapper for the given collection instance?
boolean	needsInserting(Object entry, int i, Type elemType) Do we need to insert this element?
boolean	needsUpdating(Object entry, int i, Type elemType) Do we need to update this element?
Object	readFrom(ResultSet rs, CollectionPersister persister, CollectionAliases descriptor, Object owner) Read a row from the JDBC result set

Methods inherited from class org.hibernate.collection.internal.AbstractPersistentCollection

afterInitialize, afterRowInsert, clearDirty, dirty, forceInitialization, getCachedSize, getIdentifier, getKey, getOrphans, getOwner, getQueuedOrphans, getRole, getSession, getSnapshot, getStoredSnapshot, hasQueuedOperations, identityRemove, identityRemove, initialize, isClearQueueEnabled, isConnectedToSession, isDirty, isElementRemoved, isInitialized, isInverseCollection, isInverseCollectionNoOrphanDelete, isInverseOneToManyOrNoOrphanDelete, isOperationQueueEnabled, isPutQueueEnabled, isRowUpdatePossible, isUnreferenced, needsRecreate, performQueuedOperations, postAction, preInsert, prepareForPossibleLoadingOutsideTransaction, queuedAdditionIterator, queueOperation, read, readElementByIndex, readElementExistence, readIndexExistence, readSize, replaceQueuedOperationValues, setCurrentSession, setDirectlyAccessible, setInitialized, setOwner, setSnapshot, unsetSession, wasInitialized, write

Methods inherited from class java.lang.Object

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

Field Detail

array

protected Object array

Constructor Detail

PersistentArrayHolder

public PersistentArrayHolder(SharedSessionContractImplementor session,
                             Object array)

Constructs a PersistentCollection instance for holding an array.

Parameters:

session - The session

array - The array (the persistent "collection").

PersistentArrayHolder

@Deprecated
public PersistentArrayHolder(SessionImplementor session,
                                         Object array)

Deprecated. PersistentArrayHolder(SharedSessionContractImplementor, Object) should be used instead.

Constructs a PersistentCollection instance for holding an array.

Parameters:

session - The session

array - The array (the persistent "collection").

PersistentArrayHolder

public PersistentArrayHolder(SharedSessionContractImplementor session,
                             CollectionPersister persister)

Constructs a PersistentCollection instance for holding an array.

Parameters:

session - The session

persister - The persister for the array

PersistentArrayHolder

@Deprecated
public PersistentArrayHolder(SessionImplementor session,
                                         CollectionPersister persister)

Deprecated. PersistentArrayHolder(SharedSessionContractImplementor, CollectionPersister) should be used instead.

Constructs a PersistentCollection instance for holding an array.

Parameters:

session - The session

persister - The persister for the array

Method Detail

getSnapshot

public Serializable getSnapshot(CollectionPersister persister)
                         throws HibernateException

Description copied from interface: PersistentCollection

Return a new snapshot of the current state of the collection

Parameters:

persister - The collection persister

Returns:

The snapshot

Throws:

HibernateException

isSnapshotEmpty

public boolean isSnapshotEmpty(Serializable snapshot)

Description copied from interface: PersistentCollection

Is the snapshot empty?

Parameters:

snapshot - The snapshot to check

Returns:

true if the given snapshot is empty

getOrphans

public Collection getOrphans(Serializable snapshot,
                             String entityName)
                      throws HibernateException

Description copied from interface: PersistentCollection

get all "orphaned" elements

Specified by:

getOrphans in interface PersistentCollection

Specified by:

getOrphans in class AbstractPersistentCollection

Parameters:

snapshot - The snapshot state

entityName - The name of the entity that are the elements of the collection

Returns:

The orphans

Throws:

HibernateException

getArray

public Object getArray()

isWrapper

public boolean isWrapper(Object collection)

Description copied from interface: PersistentCollection

Is this the wrapper for the given collection instance?

Parameters:

collection - The collection to check whether this is wrapping it

Returns:

true if this is a wrapper around that given collection instance.

equalsSnapshot

public boolean equalsSnapshot(CollectionPersister persister)
                       throws HibernateException

Description copied from interface: PersistentCollection

Does the current state exactly match the snapshot?

Parameters:

persister - The collection persister

Returns:

true if the current state and the snapshot state match.

Throws:

HibernateException

elements

public Iterator elements()

Get an iterator over the array elements

Returns:

The iterator

empty

public boolean empty()

Description copied from interface: PersistentCollection

Is the collection empty? (don't try to initialize the collection)

Specified by:

empty in interface PersistentCollection

Specified by:

empty in class AbstractPersistentCollection

Returns:

false if the collection is non-empty; true otherwise.

readFrom

public Object readFrom(ResultSet rs,
                       CollectionPersister persister,
                       CollectionAliases descriptor,
                       Object owner)
                throws HibernateException,
                       SQLException

Description copied from interface: PersistentCollection

Read a row from the JDBC result set

Parameters:

rs - The JDBC ResultSet

persister - The collection role

descriptor - The aliases used for the columns making up the collection

owner - The collection owner

Returns:

The read object

Throws:

HibernateException - Generally indicates a problem resolving data read from the ResultSet

SQLException - Indicates a problem accessing the ResultSet

entries

public Iterator entries(CollectionPersister persister)

Description copied from interface: PersistentCollection

Iterate all collection entries, during update of the database

Parameters:

persister - The collection persister.

Returns:

The iterator

beginRead

public void beginRead()

Description copied from interface: PersistentCollection

Called just before reading any rows from the JDBC result set

Specified by:

beginRead in interface PersistentCollection

Overrides:

beginRead in class AbstractPersistentCollection

endRead

public boolean endRead()

Description copied from interface: PersistentCollection

Called after reading all rows from the JDBC result set

Specified by:

endRead in interface PersistentCollection

Overrides:

endRead in class AbstractPersistentCollection

Returns:

Whether to end the read.

beforeInitialize

public void beforeInitialize(CollectionPersister persister,
                             int anticipatedSize)

Description copied from interface: PersistentCollection

Called before any elements are read into the collection, allowing appropriate initializations to occur.

Parameters:

persister - The underlying collection persister.

anticipatedSize - The anticipated size of the collection after initialization is complete.

isDirectlyAccessible

public boolean isDirectlyAccessible()

Description copied from interface: PersistentCollection

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

Specified by:

isDirectlyAccessible in interface PersistentCollection

Overrides:

isDirectlyAccessible in class AbstractPersistentCollection

Returns:

true indicates that the application might have access to the underlying collection/array.

initializeFromCache

public void initializeFromCache(CollectionPersister persister,
                                Serializable disassembled,
                                Object owner)
                         throws HibernateException

Description copied from interface: PersistentCollection

Read the state of the collection from a disassembled cached value

Parameters:

persister - The collection persister

disassembled - The disassembled cached state

owner - The collection owner

Throws:

HibernateException

disassemble

public Serializable disassemble(CollectionPersister persister)
                         throws HibernateException

Description copied from interface: PersistentCollection

Disassemble the collection to get it ready for the cache

Parameters:

persister - The collection persister

Returns:

The disassembled state

Throws:

HibernateException

getValue

public Object getValue()

Description copied from interface: PersistentCollection

Return the user-visible collection (or array) instance

Specified by:

getValue in interface PersistentCollection

Overrides:

getValue in class AbstractPersistentCollection

Returns:

The underlying collection/array

getDeletes

public Iterator getDeletes(CollectionPersister persister,
                           boolean indexIsFormula)
                    throws HibernateException

Description copied from interface: PersistentCollection

Get all the elements that need deleting

Parameters:

persister - The collection persister

indexIsFormula - For indexed collections, tells whether the index is a formula (calculated value) mapping

Returns:

An iterator over the elements to delete

Throws:

HibernateException

needsInserting

public boolean needsInserting(Object entry,
                              int i,
                              Type elemType)
                       throws HibernateException

Description copied from interface: PersistentCollection

Do we need to insert this element?

Parameters:

entry - The collection element to check

i - The index (for indexed collections)

elemType - The type for the element

Returns:

true if the element needs inserting

Throws:

HibernateException

needsUpdating

public boolean needsUpdating(Object entry,
                             int i,
                             Type elemType)
                      throws HibernateException

Description copied from interface: PersistentCollection

Do we need to update this element?

Parameters:

entry - The collection element to check

i - The index (for indexed collections)

elemType - The type for the element

Returns:

true if the element needs updating

Throws:

HibernateException

getIndex

public Object getIndex(Object entry,
                       int i,
                       CollectionPersister persister)

Description copied from interface: PersistentCollection

Get the index of the given collection entry

Parameters:

entry - The collection entry/element

i - The assumed index

persister - it was more elegant before we added this...

Returns:

The index value

getElement

public Object getElement(Object entry)

Description copied from interface: PersistentCollection

Get the value of the given collection entry. Generally the given entry parameter value will just be returned. Might get a different value for a duplicate entries in a Set.

Parameters:

entry - The object instance for which to get the collection element instance.

Returns:

The corresponding object that is part of the collection elements.

getSnapshotElement

public Object getSnapshotElement(Object entry,
                                 int i)

Description copied from interface: PersistentCollection

Get the snapshot value of the given collection entry

Parameters:

entry - The entry

i - The index

Returns:

The snapshot state for that element

entryExists

public boolean entryExists(Object entry,
                           int i)

Description copied from interface: PersistentCollection

Does the given element/entry exist in the collection?

Parameters:

entry - The object to check if it exists as a collection element

i - Unused

Returns:

true if the given entry is a collection element