com.sleepycat.collections

Class StoredSortedMap

public class StoredSortedMap extends StoredMap implements SortedMap

A SortedMap view of a Database.

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.

Constructor Summary
StoredSortedMap(Database database, EntryBinding keyBinding, EntryBinding valueBinding, boolean writeAllowed)
Creates a sorted map view of a Database.
StoredSortedMap(Database database, EntryBinding keyBinding, EntryBinding valueBinding, PrimaryKeyAssigner keyAssigner)
Creates a sorted map view of a Database with a PrimaryKeyAssigner.
StoredSortedMap(Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, boolean writeAllowed)
Creates a sorted map entity view of a Database.
StoredSortedMap(Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, PrimaryKeyAssigner keyAssigner)
Creates a sorted map entity view of a Database with a PrimaryKeyAssigner.
Method Summary
Comparatorcomparator()
Returns null since comparators are not supported.
ObjectfirstKey()
Returns the first (lowest) key currently in this sorted map.
SortedMapheadMap(Object toKey)
Returns a view of the portion of this sorted set whose keys are strictly less than toKey.
SortedMapheadMap(Object toKey, boolean toInclusive)
Returns a view of the portion of this sorted map whose elements are strictly less than toKey, optionally including toKey.
ObjectlastKey()
Returns the last (highest) element currently in this sorted map.
SortedMapsubMap(Object fromKey, Object toKey)
Returns a view of the portion of this sorted map whose elements range from fromKey, inclusive, to toKey, exclusive.
SortedMapsubMap(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)
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.
SortedMaptailMap(Object fromKey)
Returns a view of the portion of this sorted map whose elements are greater than or equal to fromKey.
SortedMaptailMap(Object fromKey, boolean fromInclusive)
Returns a view of the portion of this sorted map whose elements are strictly greater than fromKey, optionally including fromKey.

Constructor Detail

StoredSortedMap

public StoredSortedMap(Database database, EntryBinding keyBinding, EntryBinding valueBinding, boolean writeAllowed)
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.

Throws: IllegalArgumentException if formats are not consistently defined or a parameter is invalid. RuntimeExceptionWrapper if a DatabaseException is thrown.

StoredSortedMap

public StoredSortedMap(Database database, EntryBinding keyBinding, EntryBinding valueBinding, PrimaryKeyAssigner keyAssigner)
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 StoredSortedMap method to assign primary keys.

Throws: IllegalArgumentException if formats are not consistently defined or a parameter is invalid. RuntimeExceptionWrapper if a DatabaseException is thrown.

StoredSortedMap

public StoredSortedMap(Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, boolean writeAllowed)
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.

Throws: IllegalArgumentException if formats are not consistently defined or a parameter is invalid. RuntimeExceptionWrapper if a DatabaseException is thrown.

StoredSortedMap

public StoredSortedMap(Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, PrimaryKeyAssigner keyAssigner)
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 StoredSortedMap method to assign primary keys.

Throws: IllegalArgumentException if formats are not consistently defined or a parameter is invalid. RuntimeExceptionWrapper if a DatabaseException is thrown.

Method Detail

comparator

public Comparator comparator()
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.

firstKey

public Object firstKey()
Returns the first (lowest) key currently in this sorted map. This method conforms to the SortedMap#firstKey interface.

Returns: the first key.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

headMap

public SortedMap headMap(Object toKey)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

headMap

public SortedMap headMap(Object toKey, boolean toInclusive)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

lastKey

public Object lastKey()
Returns the last (highest) element currently in this sorted map. This method conforms to the SortedMap#lastKey interface.

Returns: the last key.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

subMap

public SortedMap subMap(Object fromKey, Object toKey)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

subMap

public SortedMap subMap(Object fromKey, boolean fromInclusive, Object toKey, boolean toInclusive)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

tailMap

public SortedMap tailMap(Object fromKey)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.

tailMap

public SortedMap tailMap(Object fromKey, boolean fromInclusive)
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.

Throws: RuntimeExceptionWrapper if a DatabaseException is thrown.