com::sleepycat::collections::StoredSortedMap Class Reference

Inheritance diagram for com::sleepycat::collections::StoredSortedMap:

Public Member Functions
	StoredSortedMap (Database database, EntryBinding keyBinding, EntryBinding valueBinding, boolean writeAllowed)
	StoredSortedMap (Database database, EntryBinding keyBinding, EntryBinding valueBinding, PrimaryKeyAssigner keyAssigner)
	StoredSortedMap (Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, boolean writeAllowed)
	StoredSortedMap (Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, PrimaryKeyAssigner keyAssigner)
Comparator	comparator ()
Object	firstKey ()
Object	lastKey ()
SortedMap	headMap (Object toKey)
SortedMap	headMap (Object toKey, boolean toInclusive)
SortedMap	tailMap (Object fromKey)
SortedMap	tailMap (Object fromKey, boolean fromInclusive)
SortedMap	subMap (Object fromKey, Object toKey)
SortedMap	subMap (Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)

---

Detailed Description

A SortedMap view of a Database.

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 SortedMap methods, this class provides the following methods for stored sorted maps only. Note that the use of these methods is not compatible with the standard Java collections interface.

• duplicates(Object)
• headMap(Object, boolean)
• tailMap(Object, boolean)
• subMap(Object, boolean, Object, boolean)

Author:

Mark Hayes

Definition at line 46 of file StoredSortedMap.java.

---

Constructor & Destructor Documentation

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

Creates a sorted map 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. valueBinding  is the binding used to translate between value buffers and 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 68 of file StoredSortedMap.java. Referenced by subMap().

com::sleepycat::collections::StoredSortedMap::StoredSortedMap (  Database  database, EntryBinding  keyBinding, EntryBinding  valueBinding, PrimaryKeyAssigner  keyAssigner )  [inline]

Creates a sorted map view of a Database with a PrimaryKeyAssigner. Writing is allowed for the created map. Parameters: database  is the Database underlying the new collection. keyBinding  is the binding used to translate between key buffers and key objects. valueBinding  is the binding used to translate between value buffers and value objects. keyAssigner  is used by the append method to assign primary keys. 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 96 of file StoredSortedMap.java.

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

Creates a sorted map entity 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. 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 124 of file StoredSortedMap.java.

com::sleepycat::collections::StoredSortedMap::StoredSortedMap (  Database  database, EntryBinding  keyBinding, EntityBinding  valueEntityBinding, PrimaryKeyAssigner  keyAssigner )  [inline]

Creates a sorted map entity view of a Database with a PrimaryKeyAssigner. Writing is allowed for the created map. Parameters: database  is the Database underlying the new collection. keyBinding  is the binding used to translate between key buffers and key objects. valueEntityBinding  is the binding used to translate between key/value buffers and entity value objects. keyAssigner  is used by the append method to assign primary keys. 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 153 of file StoredSortedMap.java.

---

Member Function Documentation

Comparator com::sleepycat::collections::StoredSortedMap::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 SortedMap#comparator interface. Returns: null. Definition at line 175 of file StoredSortedMap.java.

Object com::sleepycat::collections::StoredSortedMap::firstKey (   )  [inline]

Returns the first (lowest) key currently in this sorted map. This method conforms to the SortedMap#firstKey interface. Returns: the first key. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 189 of file StoredSortedMap.java.

SortedMap com::sleepycat::collections::StoredSortedMap::headMap (  Object  toKey, boolean  toInclusive )  [inline]

Returns a view of the portion of this sorted map whose elements are strictly less than toKey, optionally including toKey. This method does not exist in the standard SortedMap interface. Note that the return value is a StoredStoredMap 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 submap. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 265 of file StoredSortedMap.java. References subMap().

SortedMap com::sleepycat::collections::StoredSortedMap::headMap (  Object  toKey  )  [inline]

Returns a view of the portion of this sorted set whose keys are strictly less than toKey. This method conforms to the SortedMap#headMap interface. Note that the return value is a StoredStoredMap and must be treated as such; for example, its iterators must be explicitly closed. Parameters: toKey  is the upper bound. Returns: the submap. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 243 of file StoredSortedMap.java. References subMap().

Object com::sleepycat::collections::StoredSortedMap::lastKey (   )  [inline]

Returns the last (highest) element currently in this sorted map. This method conforms to the SortedMap#lastKey interface. Returns: the last key. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 203 of file StoredSortedMap.java.

SortedMap com::sleepycat::collections::StoredSortedMap::subMap (  Object  fromKey, boolean  fromInclusive, Object  toKey, boolean  toInclusive )  [inline]

Returns a view of the portion of this sorted map 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 SortedMap interface. Note that the return value is a StoredStoredMap 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 submap. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 356 of file StoredSortedMap.java. References StoredSortedMap(), and com::sleepycat::collections::DataView::subView().

SortedMap com::sleepycat::collections::StoredSortedMap::subMap (  Object  fromKey, Object  toKey )  [inline]

Returns a view of the portion of this sorted map whose elements range from fromKey, inclusive, to toKey, exclusive. This method conforms to the SortedMap#subMap interface. Note that the return value is a StoredStoredMap 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 submap. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 329 of file StoredSortedMap.java. Referenced by headMap(), and tailMap().

SortedMap com::sleepycat::collections::StoredSortedMap::tailMap (  Object  fromKey, boolean  fromInclusive )  [inline]

Returns a view of the portion of this sorted map whose elements are strictly greater than fromKey, optionally including fromKey. This method does not exist in the standard SortedMap interface. Note that the return value is a StoredStoredMap 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 submap. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 307 of file StoredSortedMap.java. References subMap().

SortedMap com::sleepycat::collections::StoredSortedMap::tailMap (  Object  fromKey  )  [inline]

Returns a view of the portion of this sorted map whose elements are greater than or equal to fromKey. This method conforms to the SortedMap#tailMap interface. Note that the return value is a StoredStoredMap and must be treated as such; for example, its iterators must be explicitly closed. Parameters: fromKey  is the lower bound. Returns: the submap. Exceptions: RuntimeExceptionWrapper  if a com.sleepycat.db.DatabaseException is thrown. Definition at line 285 of file StoredSortedMap.java. References subMap().

---

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

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

---