com::sleepycat::collections::StoredSortedKeySet Class Reference

Inheritance diagram for com::sleepycat::collections::StoredSortedKeySet:

Public Member Functions
	StoredSortedKeySet (Database database, EntryBinding keyBinding, boolean writeAllowed)
Comparator	comparator ()
Object	first ()
Object	last ()
SortedSet	headSet (Object toKey)
SortedSet	headSet (Object toKey, boolean toInclusive)
SortedSet	tailSet (Object fromKey)
SortedSet	tailSet (Object fromKey, boolean fromInclusive)
SortedSet	subSet (Object fromKey, Object toKey)
SortedSet	subSet (Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)

---

Detailed Description

The SortedSet returned by Map.keySet() and which can also be constructed directly if a Map is not needed. Since this collection is a set it only contains one element for each key, even when duplicates are allowed. Key set iterators are therefore particularly useful for enumerating the unique keys of a store or index that allows duplicates.

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 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 48 of file StoredSortedKeySet.java.

---

Constructor & Destructor Documentation

com::sleepycat::collections::StoredSortedKeySet::StoredSortedKeySet (  Database  database, EntryBinding  keyBinding, boolean  writeAllowed )  [inline]

Creates a sorted key set view of a Database. Parameters: database  is the Database underlying the new collection. keyBinding  is the binding used to translate between key buffers and key 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 67 of file StoredSortedKeySet.java. Referenced by subSet().

---

Member Function Documentation

Comparator com::sleepycat::collections::StoredSortedKeySet::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 88 of file StoredSortedKeySet.java.

Object com::sleepycat::collections::StoredSortedKeySet::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 102 of file StoredSortedKeySet.java.

SortedSet com::sleepycat::collections::StoredSortedKeySet::headSet (  Object  toKey, boolean  toInclusive )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly less than toKey, optionally including toKey. 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: toKey  is the upper bound. toInclusive  is true to include toKey. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 158 of file StoredSortedKeySet.java. References subSet().

SortedSet com::sleepycat::collections::StoredSortedKeySet::headSet (  Object  toKey  )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly less than toKey. 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: toKey  is the upper bound. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 136 of file StoredSortedKeySet.java. References subSet().

Object com::sleepycat::collections::StoredSortedKeySet::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 116 of file StoredSortedKeySet.java.

SortedSet com::sleepycat::collections::StoredSortedKeySet::subSet (  Object  fromKey, boolean  fromInclusive, Object  toKey, boolean  toInclusive )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly greater than fromKey and strictly less than toKey, optionally including fromKey and toKey. 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: fromKey  is the lower bound. fromInclusive  is true to include fromKey. toKey  is the upper bound. toInclusive  is true to include toKey. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 249 of file StoredSortedKeySet.java. References StoredSortedKeySet(), and com::sleepycat::collections::DataView::subView().

SortedSet com::sleepycat::collections::StoredSortedKeySet::subSet (  Object  fromKey, Object  toKey )  [inline]

Returns a view of the portion of this sorted set whose elements range from fromKey, inclusive, to toKey, 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: fromKey  is the lower bound. toKey  is the upper bound. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 222 of file StoredSortedKeySet.java. Referenced by headSet(), and tailSet().

SortedSet com::sleepycat::collections::StoredSortedKeySet::tailSet (  Object  fromKey, boolean  fromInclusive )  [inline]

Returns a view of the portion of this sorted set whose elements are strictly greater than fromKey, optionally including fromKey. 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: fromKey  is the lower bound. fromInclusive  is true to include fromKey. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 200 of file StoredSortedKeySet.java. References subSet().

SortedSet com::sleepycat::collections::StoredSortedKeySet::tailSet (  Object  fromKey  )  [inline]

Returns a view of the portion of this sorted set whose elements are greater than or equal to fromKey. 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: fromKey  is the lower bound. Returns: the subset. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 178 of file StoredSortedKeySet.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/StoredSortedKeySet.java

---