StoredSortedValueSet (Sleepycat Software, Inc.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Berkeley DB
version 4.4.20

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sleepycat.collections
Class StoredSortedValueSet

java.lang.Object
  com.sleepycat.collections.StoredContainer
      com.sleepycat.collections.StoredCollection
          com.sleepycat.collections.StoredValueSet
              com.sleepycat.collections.StoredSortedValueSet

All Implemented Interfaces:: Cloneable, Collection, Set, SortedSet

public class StoredSortedValueSet
extends StoredValueSet
implements SortedSet

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 StoredValueSet.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.

Constructor Summary
`StoredSortedValueSet(Database database, EntityBinding valueEntityBinding, boolean writeAllowed)` Creates a sorted value set entity view of a `Database`.

Method Summary
`Comparator`	`comparator()` Returns null since comparators are not supported.
`Object`	`first()` Returns the first (lowest) element currently in this sorted set.
`SortedSet`	`headSet(Object toValue)` Returns a view of the portion of this sorted set whose elements are strictly less than toValue.
`SortedSet`	`headSet(Object toValue, boolean toInclusive)` Returns a view of the portion of this sorted set whose elements are strictly less than toValue, optionally including toValue.
`Object`	`last()` Returns the last (highest) element currently in this sorted set.
`SortedSet`	`subSet(Object fromValue, boolean fromInclusive, Object toValue, boolean toInclusive)` 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.
`SortedSet`	`subSet(Object fromValue, Object toValue)` Returns a view of the portion of this sorted set whose elements range from fromValue, inclusive, to toValue, exclusive.
`SortedSet`	`tailSet(Object fromValue)` Returns a view of the portion of this sorted set whose elements are greater than or equal to fromValue.
`SortedSet`	`tailSet(Object fromValue, boolean fromInclusive)` Returns a view of the portion of this sorted set whose elements are strictly greater than fromValue, optionally including fromValue.

Methods inherited from class com.sleepycat.collections.StoredValueSet

add, contains, remove, size

Methods inherited from class com.sleepycat.collections.StoredCollection

addAll, containsAll, equals, hashCode, iterator, iterator, join, removeAll, retainAll, toArray, toArray, toList, toString

Methods inherited from class com.sleepycat.collections.StoredContainer

areDuplicatesAllowed, areDuplicatesOrdered, areKeysRenumbered, clear, getCursorConfig, isDirtyRead, isDirtyReadAllowed, isEmpty, isOrdered, isSecondary, isTransactional, isWriteAllowed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Constructor Detail

StoredSortedValueSet

public StoredSortedValueSet(Database database,
                            EntityBinding valueEntityBinding,
                            boolean writeAllowed)

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.
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 Comparable interface or not. This method does not conform to the SortedSet.comparator() interface.

Specified by:: comparator in interface SortedSet

Returns:: null.

first

public Object first()

Returns the first (lowest) element currently in this sorted set. This method conforms to the SortedSet.first() interface.

Specified by:: first in interface SortedSet

Returns:: the first element.
Throws:: RuntimeExceptionWrapper - if a DatabaseException is thrown.

last

public Object last()

Returns the last (highest) element currently in this sorted set. This method conforms to the SortedSet.last() interface.

Specified by:: last in interface SortedSet

Returns:: the last element.
Throws:: RuntimeExceptionWrapper - if a DatabaseException is thrown.

headSet

public SortedSet headSet(Object toValue)

Returns a view of the portion of this sorted set whose elements are strictly less than toValue. This method conforms to the SortedSet.headSet(java.lang.Object) interface.