com::sleepycat::collections::StoredSortedValueSet Class Reference

Inheritance diagram for com::sleepycat::collections::StoredSortedValueSet:

Public Member Functions
	StoredSortedValueSet (Database database, EntityBinding valueEntityBinding, boolean writeAllowed)
Comparator	comparator ()
Object	first ()
Object	last ()
SortedSet	headSet (Object toValue)
SortedSet	headSet (Object toValue, boolean toInclusive)
SortedSet	tailSet (Object fromValue)
SortedSet	tailSet (Object fromValue, boolean fromInclusive)
SortedSet	subSet (Object fromValue, Object toValue)
SortedSet	subSet (Object fromValue, boolean fromInclusive, Object toValue, boolean toInclusive)

---

Detailed Description

The SortedSet returned by Map.values() and which can also be constructed directly if a Map is not needed. Although this collection is a set it may contain duplicate values. Only if an entity value binding is used are all elements guaranteed to be unique.

Note that this class does not conform to the standard Java collections interface in the following ways:

• The size method always throws UnsupportedOperationException because, for performance reasons, databases do not maintain their total record count.
• All iterators must be explicitly closed using StoredIterator#close() or StoredIterator#close(java.util.Iterator) to release the underlying database cursor resources.

In addition to the standard SortedSet methods, this class provides the following methods for stored sorted value sets only. Note that the use of these methods is not compatible with the standard Java collections interface.

• headSet(Object, boolean)
• tailSet(Object, boolean)
• subSet(Object, boolean, Object, boolean)

Author:

Mark Hayes

Definition at line 47 of file StoredSortedValueSet.java.

---

Constructor & Destructor Documentation

com::sleepycat::collections::StoredSortedValueSet::StoredSortedValueSet (  Database  database, EntityBinding  valueEntityBinding, boolean  writeAllowed )  [inline]

Creates a sorted value set entity view of a Database. Parameters: database  is the Database underlying the new collection. valueEntityBinding  is the binding used to translate between key/value buffers and entity value objects. writeAllowed  is true to create a read-write collection or false to create a read-only collection. Exceptions: IllegalArgumentException  if formats are not consistently defined or a parameter is invalid. RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 70 of file StoredSortedValueSet.java. Referenced by subSet().

---

Member Function Documentation

Comparator com::sleepycat::collections::StoredSortedValueSet::comparator (   )  [inline]

Returns null since comparators are not supported. The natural ordering of a stored collection is data byte order, whether the data classes implement the java.lang.Comparable interface or not. This method does not conform to the SortedSet#comparator interface. Returns: null. Definition at line 101 of file StoredSortedValueSet.java.

Object com::sleepycat::collections::StoredSortedValueSet::first (   )  [inline]

Returns the first (lowest) element currently in this sorted set. This method conforms to the SortedSet#first interface. Returns: the first element. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 115 of file StoredSortedValueSet.java.

SortedSet com::sleepycat::collections::StoredSortedValueSet::headSet (  Object  toValue, boolean  toInclusive )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly less than toValue, optionally including toValue. This method does not exist in the standard SortedSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: toValue  is the upper bound. toInclusive  is true to include toValue. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 171 of file StoredSortedValueSet.java. References subSet().

SortedSet com::sleepycat::collections::StoredSortedValueSet::headSet (  Object  toValue  )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly less than toValue. This method conforms to the SortedSet#headSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: toValue  the upper bound. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 149 of file StoredSortedValueSet.java. References subSet().

Object com::sleepycat::collections::StoredSortedValueSet::last (   )  [inline]

Returns the last (highest) element currently in this sorted set. This method conforms to the SortedSet#last interface. Returns: the last element. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 129 of file StoredSortedValueSet.java.

SortedSet com::sleepycat::collections::StoredSortedValueSet::subSet (  Object  fromValue, boolean  fromInclusive, Object  toValue, boolean  toInclusive )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly greater than fromValue and strictly less than toValue, optionally including fromValue and toValue. This method does not exist in the standard SortedSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: fromValue  is the lower bound. fromInclusive  is true to include fromValue. toValue  is the upper bound. toInclusive  is true to include toValue. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 262 of file StoredSortedValueSet.java. References StoredSortedValueSet(), and com::sleepycat::collections::DataView::subView().

SortedSet com::sleepycat::collections::StoredSortedValueSet::subSet (  Object  fromValue, Object  toValue )  [inline]

Returns a view of the portion of this sorted set whose elements range from fromValue, inclusive, to toValue, exclusive. This method conforms to the SortedSet#subSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: fromValue  is the lower bound. toValue  is the upper bound. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 235 of file StoredSortedValueSet.java. Referenced by headSet(), and tailSet().

SortedSet com::sleepycat::collections::StoredSortedValueSet::tailSet (  Object  fromValue, boolean  fromInclusive )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly greater than fromValue, optionally including fromValue. This method does not exist in the standard SortedSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: fromValue  is the lower bound. fromInclusive  is true to include fromValue. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 213 of file StoredSortedValueSet.java. References subSet().

SortedSet com::sleepycat::collections::StoredSortedValueSet::tailSet (  Object  fromValue  )  [inline]

Returns a view of the portion of this sorted set whose elements are greater than or equal to fromValue. This method conforms to the SortedSet#tailSet interface. Note that the return value is a StoredCollection and must be treated as such; for example, its iterators must be explicitly closed. Parameters: fromValue  is the lower bound. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 191 of file StoredSortedValueSet.java. References subSet().

---

The documentation for this class was generated from the following file:

• /home/huihoo/src/db/db-4.4.16/java/src/com/sleepycat/collections/StoredSortedValueSet.java

---