org.hibernate.collection

Class PersistentMap

java.lang.Object

org.hibernate.collection.AbstractPersistentCollection

org.hibernate.collection.PersistentMap

All Implemented Interfaces:

java.io.Serializable, java.util.Map, PersistentCollection

Direct Known Subclasses:

PersistentSortedMap

public class PersistentMap
extends AbstractPersistentCollection
implements java.util.Map

A persistent wrapper for a java.util.Map. Underlying collection is a HashMap.

Author:

Gavin King

See Also:

HashMap, Serialized Form

Nested Class Summary

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

AbstractPersistentCollection.DelayedOperation

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map	map

Fields inherited from class org.hibernate.collection.AbstractPersistentCollection

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
PersistentMap() Empty constructor.
PersistentMap(SessionImplementor session) Instantiates a lazy map (the underlying map is un-initialized).
PersistentMap(SessionImplementor session, java.util.Map map) Instantiates a non-lazy map (the underlying map is constructed from the incoming map reference).

Method Summary

Methods

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	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.io.Serializable	disassemble(CollectionPersister persister) Disassemble the collection, ready for the cache
boolean	empty() Is the initialized collection empty?
java.util.Iterator	entries(CollectionPersister persister) Iterate all collection entries, during update of the database
boolean	entryExists(java.lang.Object entry, int i) Does an element exist at this entry in the collection?
java.util.Set	entrySet()
boolean	equals(java.lang.Object other)
boolean	equalsSnapshot(CollectionPersister persister) Does the current state exactly match the snapshot?
java.lang.Object	get(java.lang.Object key)
java.util.Iterator	getDeletes(CollectionPersister persister, boolean indexIsFormula) Get all the elements that need deleting
java.lang.Object	getElement(java.lang.Object entry) Get the value of the given collection entry
java.lang.Object	getIndex(java.lang.Object entry, int i, CollectionPersister persister) Get the index of the given collection entry
java.util.Collection	getOrphans(java.io.Serializable snapshot, java.lang.String entityName) get all "orphaned" elements
java.io.Serializable	getSnapshot(CollectionPersister persister) Return a new snapshot of the current state of the collection
java.lang.Object	getSnapshotElement(java.lang.Object entry, int i) Get the snapshot value of the given collection entry
int	hashCode()
void	initializeFromCache(CollectionPersister persister, java.io.Serializable disassembled, java.lang.Object owner) Read the state of the collection from a disassembled cached value
boolean	isEmpty()
boolean	isSnapshotEmpty(java.io.Serializable snapshot) Is the snapshot empty?
boolean	isWrapper(java.lang.Object collection) Is this the wrapper for the given underlying collection instance?
java.util.Set	keySet()
boolean	needsInserting(java.lang.Object entry, int i, Type elemType) Do we need to insert this element?
boolean	needsUpdating(java.lang.Object entry, int i, Type elemType) Do we need to update this element?
java.lang.Object	put(java.lang.Object key, java.lang.Object value)
void	putAll(java.util.Map puts)
java.lang.Object	readFrom(java.sql.ResultSet rs, CollectionPersister persister, CollectionAliases descriptor, java.lang.Object owner) Read a row from the JDBC result set
java.lang.Object	remove(java.lang.Object key)
int	size()
java.lang.String	toString()
java.util.Collection	values()

Methods inherited from class org.hibernate.collection.AbstractPersistentCollection

afterInitialize, afterRowInsert, beginRead, clearDirty, dirty, endRead, forceInitialization, getCachedSize, getIdentifier, getKey, getOrphans, getOwner, getQueuedOrphans, getRole, getSession, getSnapshot, getStoredSnapshot, getValue, hasQueuedOperations, initialize, isClearQueueEnabled, isDirectlyAccessible, isDirty, isOperationQueueEnabled, isPutQueueEnabled, isRowUpdatePossible, isUnreferenced, needsRecreate, performQueuedOperations, postAction, preInsert, queuedAdditionIterator, queueOperation, read, readElementByIndex, readElementExistence, readIndexExistence, readSize, setCurrentSession, setDirectlyAccessible, setInitialized, setOwner, setSnapshot, unsetSession, wasInitialized, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

map

protected java.util.Map map

Constructor Detail

PersistentMap

public PersistentMap()

Empty constructor.

Note: this form is not ever ever ever used by Hibernate; it is, however, needed for SOAP libraries and other such marshalling code.

PersistentMap

public PersistentMap(SessionImplementor session)

Instantiates a lazy map (the underlying map is un-initialized).

Parameters:

session - The session to which this map will belong.

PersistentMap

public PersistentMap(SessionImplementor session,
             java.util.Map map)

Instantiates a non-lazy map (the underlying map is constructed from the incoming map reference).

Parameters:

session - The session to which this map will belong.

map - The underlying map data.

Method Detail

getSnapshot

public java.io.Serializable getSnapshot(CollectionPersister persister)
                                 throws HibernateException

Description copied from interface: PersistentCollection

Return a new snapshot of the current state of the collection

Specified by:

getSnapshot in interface PersistentCollection

Throws:

HibernateException

getOrphans

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

Description copied from class: AbstractPersistentCollection

get all "orphaned" elements

Specified by:

getOrphans in interface PersistentCollection

Specified by:

getOrphans in class AbstractPersistentCollection

Throws:

HibernateException

equalsSnapshot

public boolean equalsSnapshot(CollectionPersister persister)
                       throws HibernateException

Description copied from interface: PersistentCollection

Does the current state exactly match the snapshot?

Specified by:

equalsSnapshot in interface PersistentCollection

Throws:

HibernateException

isSnapshotEmpty

public boolean isSnapshotEmpty(java.io.Serializable snapshot)

Description copied from interface: PersistentCollection

Is the snapshot empty?

Specified by:

isSnapshotEmpty in interface PersistentCollection

isWrapper

public boolean isWrapper(java.lang.Object collection)

Description copied from interface: PersistentCollection

Is this the wrapper for the given underlying collection instance?

Specified by:

isWrapper in interface PersistentCollection

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.

Specified by:

beforeInitialize in interface PersistentCollection

Parameters:

persister - The underlying collection persister.

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

size

public int size()

Specified by:

size in interface java.util.Map

See Also:

Map.size()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map

See Also:

Map.isEmpty()

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map

See Also:

Map.containsValue(Object)

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map

See Also:

Map.get(Object)

put

public java.lang.Object put(java.lang.Object key,
                   java.lang.Object value)

Specified by:

put in interface java.util.Map

See Also:

Map.put(Object, Object)

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map

See Also:

Map.remove(Object)

putAll

public void putAll(java.util.Map puts)

Specified by:

putAll in interface java.util.Map

See Also:

Map.putAll(java.util.Map puts)

clear

public void clear()

Specified by:

clear in interface java.util.Map

See Also:

Map.clear()

keySet

public java.util.Set keySet()

Specified by:

keySet in interface java.util.Map

See Also:

Map.keySet()

values

public java.util.Collection values()

Specified by:

values in interface java.util.Map

See Also:

Map.values()

entrySet

public java.util.Set entrySet()

Specified by:

entrySet in interface java.util.Map

See Also:

Map.entrySet()

empty

public boolean empty()

Description copied from class: AbstractPersistentCollection

Is the initialized collection empty?

Specified by:

empty in interface PersistentCollection

Specified by:

empty in class AbstractPersistentCollection

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

readFrom

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

Description copied from interface: PersistentCollection

Read a row from the JDBC result set

Specified by:

readFrom in interface PersistentCollection

Throws:

HibernateException

java.sql.SQLException

entries

public java.util.Iterator entries(CollectionPersister persister)

Description copied from interface: PersistentCollection

Iterate all collection entries, during update of the database

Specified by:

entries in interface PersistentCollection

initializeFromCache

public void initializeFromCache(CollectionPersister persister,
                       java.io.Serializable disassembled,
                       java.lang.Object owner)
                         throws HibernateException

Description copied from interface: PersistentCollection

Read the state of the collection from a disassembled cached value

Specified by:

initializeFromCache in interface PersistentCollection

Throws:

HibernateException

disassemble

public java.io.Serializable disassemble(CollectionPersister persister)
                                 throws HibernateException

Description copied from interface: PersistentCollection

Disassemble the collection, ready for the cache

Specified by:

disassemble in interface PersistentCollection

Throws:

HibernateException

getDeletes

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

Description copied from interface: PersistentCollection

Get all the elements that need deleting

Specified by:

getDeletes in interface PersistentCollection

Throws:

HibernateException

needsInserting

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

Description copied from interface: PersistentCollection

Do we need to insert this element?

Specified by:

needsInserting in interface PersistentCollection

Throws:

HibernateException

needsUpdating

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

Description copied from interface: PersistentCollection

Do we need to update this element?

Specified by:

needsUpdating in interface PersistentCollection

Throws:

HibernateException

getIndex

public java.lang.Object getIndex(java.lang.Object entry,
                        int i,
                        CollectionPersister persister)

Description copied from interface: PersistentCollection

Get the index of the given collection entry

Specified by:

getIndex in interface PersistentCollection

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

getElement

public java.lang.Object getElement(java.lang.Object entry)

Description copied from interface: PersistentCollection

Get the value of the given collection entry

Specified by:

getElement in interface PersistentCollection

getSnapshotElement

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

Description copied from interface: PersistentCollection

Get the snapshot value of the given collection entry

Specified by:

getSnapshotElement in interface PersistentCollection

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface java.util.Map

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map

Overrides:

hashCode in class java.lang.Object

entryExists

public boolean entryExists(java.lang.Object entry,
                  int i)

Description copied from interface: PersistentCollection

Does an element exist at this entry in the collection?

Specified by:

entryExists in interface PersistentCollection