|
Berkeley DB XML version 2.0.7 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.sleepycat.collections.StoredContainer
com.sleepycat.collections.StoredMap
com.sleepycat.collections.StoredSortedMap
A SortedMap view of a Database.
Note that this class does not conform to the standard Java collections interface in the following ways:
StoredContainer.size() method always throws
UnsupportedOperationException because, for performance reasons,
databases do not maintain their total record count.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.
StoredMap.duplicates(Object)headMap(Object, boolean)tailMap(Object, boolean)subMap(Object, boolean, Object, boolean)
| Nested Class Summary |
| Nested classes inherited from class java.util.Map |
Map.Entry |
| Constructor Summary | |
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. |
|
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. |
|
| Method Summary | |
Comparator |
comparator()
Returns null since comparators are not supported. |
Object |
firstKey()
Returns the first (lowest) key currently in this sorted map. |
SortedMap |
headMap(Object toKey)
Returns a view of the portion of this sorted set whose keys are strictly less than toKey. |
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. |
Object |
lastKey()
Returns the last (highest) element currently in this sorted map. |
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. |
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. |
SortedMap |
tailMap(Object fromKey)
Returns a view of the portion of this sorted map whose elements are greater than or equal to fromKey. |
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. |
| Methods inherited from class com.sleepycat.collections.StoredMap |
append, containsKey, containsValue, duplicates, entrySet, equals, get, hashCode, keySet, put, putAll, remove, toString, values |
| Methods inherited from class com.sleepycat.collections.StoredContainer |
areDuplicatesAllowed, areDuplicatesOrdered, areKeysRenumbered, clear, isDirtyRead, isDirtyReadAllowed, isEmpty, isOrdered, isSecondary, isTransactional, isWriteAllowed, size |
| Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.util.Map |
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
| Constructor Detail |
public StoredSortedMap(Database database,
EntryBinding keyBinding,
EntryBinding valueBinding,
boolean writeAllowed)
Database.
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.
IllegalArgumentException - if formats are not consistently
defined or a parameter is invalid.
RuntimeExceptionWrapper - if a DatabaseException is thrown.
public StoredSortedMap(Database database,
EntryBinding keyBinding,
EntryBinding valueBinding,
PrimaryKeyAssigner keyAssigner)
Database with a PrimaryKeyAssigner. Writing is allowed for the created map.
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 StoredMap.append(java.lang.Object) method to assign
primary keys.
IllegalArgumentException - if formats are not consistently
defined or a parameter is invalid.
RuntimeExceptionWrapper - if a DatabaseException is thrown.
public StoredSortedMap(Database database,
EntryBinding keyBinding,
EntityBinding valueEntityBinding,
boolean writeAllowed)
Database.
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.
IllegalArgumentException - if formats are not consistently
defined or a parameter is invalid.
RuntimeExceptionWrapper - if a DatabaseException is thrown.
public StoredSortedMap(Database database,
EntryBinding keyBinding,
EntityBinding valueEntityBinding,
PrimaryKeyAssigner keyAssigner)
Database with a PrimaryKeyAssigner. Writing is allowed for the created map.
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 StoredMap.append(java.lang.Object) method to assign
primary keys.
IllegalArgumentException - if formats are not consistently
defined or a parameter is invalid.
RuntimeExceptionWrapper - if a DatabaseException is thrown.| Method Detail |
public Comparator comparator()
Comparable interface or not.
This method does not conform to the SortedMap.comparator()
interface.
comparator in interface SortedMappublic Object firstKey()
SortedMap.firstKey() interface.
firstKey in interface SortedMapRuntimeExceptionWrapper - if a DatabaseException is thrown.public Object lastKey()
SortedMap.lastKey() interface.
lastKey in interface SortedMapRuntimeExceptionWrapper - if a DatabaseException is thrown.public SortedMap headMap(Object toKey)
SortedMap.headMap(java.lang.Object) interface.
headMap in interface SortedMaptoKey - is the upper bound.
RuntimeExceptionWrapper - if a DatabaseException is thrown.
public SortedMap headMap(Object toKey,
boolean toInclusive)
SortedMap interface.
toKey - is the upper bound.toInclusive - is true to include toKey.
RuntimeExceptionWrapper - if a DatabaseException is thrown.public SortedMap tailMap(Object fromKey)
SortedMap.tailMap(java.lang.Object) interface.
tailMap in interface SortedMapfromKey - is the lower bound.
RuntimeExceptionWrapper - if a DatabaseException is thrown.
public SortedMap tailMap(Object fromKey,
boolean fromInclusive)
SortedMap interface.
fromKey - is the lower bound.fromInclusive - is true to include fromKey.
RuntimeExceptionWrapper - if a DatabaseException is thrown.
public SortedMap subMap(Object fromKey,
Object toKey)
SortedMap.subMap(java.lang.Object, java.lang.Object) interface.
subMap in interface SortedMapfromKey - is the lower bound.toKey - is the upper bound.
RuntimeExceptionWrapper - if a DatabaseException is thrown.
public SortedMap subMap(Object fromKey,
boolean fromInclusive,
Object toKey,
boolean toInclusive)
SortedMap interface.
fromKey - is the lower bound.fromInclusive - is true to include fromKey.toKey - is the upper bound.toInclusive - is true to include toKey.
RuntimeExceptionWrapper - if a DatabaseException is thrown.
|
Berkeley DB XML version 2.0.7 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||