public class

PersistentSortedMap

extends PersistentMap
implements SortedMap<K, V>

java.lang.Object
↳	org.hibernate.collection.AbstractPersistentCollection
	↳	org.hibernate.collection.PersistentMap
		↳	org.hibernate.collection.PersistentSortedMap

Class Overview

A persistent wrapper for a java.util.SortedMap. Underlying collection is a TreeMap.

Summary

Fields
protected Comparator	comparator

[Expand]

Inherited Fields

From class org.hibernate.collection.PersistentMap

From class org.hibernate.collection.AbstractPersistentCollection

Public Constructors
	PersistentSortedMap(SessionImplementor session)
	PersistentSortedMap(SessionImplementor session, SortedMap map)
	PersistentSortedMap()

Public Methods
Comparator	comparator()
Object	firstKey()
SortedMap	headMap(Object toKey)
Object	lastKey()
void	setComparator(Comparator comparator)
SortedMap	subMap(Object fromKey, Object toKey)
SortedMap	tailMap(Object fromKey)

Protected Methods
Serializable	snapshot(BasicCollectionPersister persister, EntityMode entityMode)

[Expand]

Inherited Methods

From class org.hibernate.collection.PersistentMap

From class org.hibernate.collection.AbstractPersistentCollection

boolean	afterInitialize() Called after initializing from cache
void	afterRowInsert(CollectionPersister persister, 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
final void	clearDirty() Clear the dirty flag, after flushing changes to the database.
final void	dirty() Mark the collection as dirty
abstract boolean	empty() Is the initialized collection empty?
boolean	endRead() Called after reading all rows from the JDBC result set
final void	forceInitialization() To be called internally by the session, forcing immediate initialization.
int	getCachedSize()
Object	getIdentifier(Object entry, int i) Get the index of the given collection entry
final Serializable	getKey() Get the current collection key value
abstract Collection	getOrphans(Serializable snapshot, String entityName) get all "orphaned" elements
static Collection	getOrphans(Collection oldElements, Collection currentElements, String entityName, 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
Object	getOwner() Get the owning entity.
final Collection	getQueuedOrphans(String entityName) Iterate the "queued" additions
final String	getRole() Get the current role name
final SessionImplementor	getSession() Get the current session
final Serializable	getSnapshot() Get the current snapshot from the session
final Serializable	getStoredSnapshot() Get the snapshot cached by the collection instance
Object	getValue() return the user-visible collection (or array) instance
final boolean	hasQueuedOperations() Does this instance have any "queued" additions?
final void	initialize(boolean writing) Initialize the collection, if possible, wrapping any exceptions in a runtime exception
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?
final boolean	isDirty() Is the collection dirty? Note that this is only reliable during the flush cycle, after the collection elements are dirty checked against the snapshot.
boolean	isOperationQueueEnabled() Is this collection in a state that would allow us to "queue" operations?
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()
final boolean	isUnreferenced() Is the collection unreferenced?
boolean	needsRecreate(CollectionPersister persister) Do we need to completely recreate this collection when it changes?
final 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(CollectionPersister persister) Called before inserting rows, to ensure that any surrogate keys are fully generated
final void	queueOperation(Object element) Queue an addition
final Iterator	queuedAdditionIterator() Iterate the "queued" additions
final void	read() Called by any read-only method of the collection interface
Object	readElementByIndex(Object index)
Boolean	readElementExistence(Object element)
Boolean	readIndexExistence(Object index)
boolean	readSize() Called by the `size()` method
final boolean	setCurrentSession(SessionImplementor session) Associate the collection with the given session.
final void	setDirectlyAccessible(boolean directlyAccessible)
final void	setInitialized()
void	setOwner(Object owner) Set the reference to the owning entity
void	setSnapshot(Serializable key, String role, Serializable snapshot) After flushing, re-init snapshot state.
final boolean	unsetSession(SessionImplementor currentSession) Disassociate this collection from the given session.
final boolean	wasInitialized() Is this instance initialized?
final void	write() Called by any writer method of the collection interface

From class java.lang.Object

From interface java.util.Map

abstract void	clear()
abstract boolean	containsKey(Object arg0)
abstract boolean	containsValue(Object arg0)
abstract Set<Entry<K, V>>	entrySet()
abstract boolean	equals(Object arg0)
abstract V	get(Object arg0)
abstract int	hashCode()
abstract boolean	isEmpty()
abstract Set<K>	keySet()
abstract V	put(K arg0, V arg1)
abstract void	putAll(Map<? extends K, ? extends V> arg0)
abstract V	remove(Object arg0)
abstract int	size()
abstract Collection<V>	values()

From interface java.util.SortedMap

From interface org.hibernate.collection.PersistentCollection

abstract boolean	afterInitialize() Called after initializing from cache
abstract void	afterRowInsert(CollectionPersister persister, Object entry, int i) Called after inserting a row, to fetch the natively generated id
abstract void	beforeInitialize(CollectionPersister persister, int anticipatedSize) Called before any elements are read into the collection, allowing appropriate initializations to occur.
abstract void	beginRead() Called just before reading any rows from the JDBC result set
abstract void	clearDirty() Clear the dirty flag, after flushing changes to the database.
abstract void	dirty() Mark the collection as dirty
abstract Serializable	disassemble(CollectionPersister persister) Disassemble the collection, ready for the cache
abstract boolean	empty() Is the collection empty? (don't try to initialize the collection)
abstract boolean	endRead() Called after reading all rows from the JDBC result set
abstract Iterator	entries(CollectionPersister persister) Iterate all collection entries, during update of the database
abstract boolean	entryExists(Object entry, int i) Does an element exist at this entry in the collection?
abstract boolean	equalsSnapshot(CollectionPersister persister) Does the current state exactly match the snapshot?
abstract void	forceInitialization() To be called internally by the session, forcing immediate initialization.
abstract Iterator	getDeletes(CollectionPersister persister, boolean indexIsFormula) Get all the elements that need deleting
abstract Object	getElement(Object entry) Get the value of the given collection entry
abstract Object	getIdentifier(Object entry, int i) Get the index of the given collection entry
abstract Object	getIndex(Object entry, int i, CollectionPersister persister) Get the index of the given collection entry
abstract Serializable	getKey() Get the current collection key value
abstract Collection	getOrphans(Serializable snapshot, String entityName) get all "orphaned" elements
abstract Object	getOwner() Get the owning entity.
abstract Collection	getQueuedOrphans(String entityName) Get the "queued" orphans
abstract String	getRole() Get the current role name
abstract Serializable	getSnapshot(CollectionPersister persister) Return a new snapshot of the current state of the collection
abstract Object	getSnapshotElement(Object entry, int i) Get the snapshot value of the given collection entry
abstract Serializable	getStoredSnapshot() Get the snapshot cached by the collection instance
abstract Object	getValue() return the user-visible collection (or array) instance
abstract boolean	hasQueuedOperations() Does this instance have any "queued" additions?
abstract void	initializeFromCache(CollectionPersister persister, Serializable disassembled, Object owner) Read the state of the collection from a disassembled cached value
abstract boolean	isDirectlyAccessible() Could the application possibly have a direct reference to the underlying collection implementation?
abstract boolean	isDirty() Is the collection dirty? Note that this is only reliable during the flush cycle, after the collection elements are dirty checked against the snapshot.
abstract boolean	isRowUpdatePossible()
abstract boolean	isSnapshotEmpty(Serializable snapshot) Is the snapshot empty?
abstract boolean	isUnreferenced() Is the collection unreferenced?
abstract boolean	isWrapper(Object collection) Is this the wrapper for the given underlying collection instance?
abstract boolean	needsInserting(Object entry, int i, Type elemType) Do we need to insert this element?
abstract boolean	needsRecreate(CollectionPersister persister) Do we need to completely recreate this collection when it changes?
abstract boolean	needsUpdating(Object entry, int i, Type elemType) Do we need to update this element?
abstract void	postAction() After flushing, clear any "queued" additions, since the database state is now synchronized with the memory state.
abstract void	preInsert(CollectionPersister persister) Called before inserting rows, to ensure that any surrogate keys are fully generated
abstract Iterator	queuedAdditionIterator() Iterate the "queued" additions
abstract Object	readFrom(ResultSet rs, CollectionPersister role, CollectionAliases descriptor, Object owner) Read a row from the JDBC result set
abstract boolean	setCurrentSession(SessionImplementor session) Associate the collection with the given session.
abstract void	setOwner(Object entity) Set the reference to the owning entity
abstract void	setSnapshot(Serializable key, String role, Serializable snapshot) After flushing, re-init snapshot state.
abstract boolean	unsetSession(SessionImplementor currentSession) Disassociate this collection from the given session.
abstract boolean	wasInitialized() Is this instance initialized?

Fields

protected Comparator comparator

Public Constructors

public PersistentSortedMap (SessionImplementor session)

public PersistentSortedMap (SessionImplementor session, SortedMap map)

public PersistentSortedMap ()

Public Methods

public Comparator comparator ()

public Object firstKey ()

public SortedMap headMap (Object toKey)

public Object lastKey ()

public void setComparator (Comparator comparator)

public SortedMap subMap (Object fromKey, Object toKey)

public SortedMap tailMap (Object fromKey)

Protected Methods

protected Serializable snapshot (BasicCollectionPersister persister, EntityMode entityMode)

Throws

HibernateException

Interfaces

Classes

PersistentSortedMap

Class Overview

See Also

Summary

Fields

protected Comparator comparator

Public Constructors

public PersistentSortedMap (SessionImplementor session)

public PersistentSortedMap (SessionImplementor session, SortedMap map)

public PersistentSortedMap ()

Public Methods

public Comparator comparator ()

See Also

public Object firstKey ()

See Also

public SortedMap headMap (Object toKey)

See Also

public Object lastKey ()

See Also

public void setComparator (Comparator comparator)

public SortedMap subMap (Object fromKey, Object toKey)

See Also

public SortedMap tailMap (Object fromKey)

See Also

Protected Methods

protected Serializable snapshot (BasicCollectionPersister persister, EntityMode entityMode)

Throws