| java.lang.Object
 com.sleepycat.collections.StoredContainer
com.sleepycat.collections.StoredMap
All known Subclasses: com.sleepycat.collections.StoredSortedMap,
| StoredMap | | public class StoredMap extends StoredContainer implements Map(Code) | | A Map view of a
Database .
In addition to the standard Map methods, this class provides the
following methods for stored maps only. Note that the use of these methods
is not compatible with the standard Java collections interface.
author:
Mark Hayes |
| Constructor Summary | |
| public | StoredMap(Database database, EntryBinding keyBinding, EntryBinding valueBinding, boolean writeAllowed)
Creates a map view of a
Database . | | public | StoredMap(Database database, EntryBinding keyBinding, EntryBinding valueBinding, PrimaryKeyAssigner keyAssigner)
Creates a map view of a
Database with a
PrimaryKeyAssigner . | | public | StoredMap(Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, boolean writeAllowed)
Creates a map entity view of a
Database . | | public | StoredMap(Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, PrimaryKeyAssigner keyAssigner)
Creates a map entity view of a
Database with a
PrimaryKeyAssigner . | | | StoredMap(DataView view)
|
| Method Summary | |
| public Object | append(Object value)
Appends a given value returning the newly assigned key. | | public boolean | containsKey(Object key)
Returns true if this map contains the specified key. | | public boolean | containsValue(Object value)
Returns true if this map contains the specified value. | | public Collection | duplicates(Object key)
Returns a new collection containing the values mapped to the given key
in this map. | | public Map | duplicatesMap(Object secondaryKey, EntryBinding primaryKeyBinding)
Returns a new map from primary key to value for the subset of records
having a given secondary key (duplicates). | | public Set | entrySet()
Returns a set view of the mappings contained in this map. | | public boolean | equals(Object other)
Compares the specified object with this map for equality. | | public Object | get(Object key)
Returns the value to which this map maps the specified key. | | public int | hashCode()
| | void | initAfterClone()
Override this method to initialize view-dependent fields. | | public Set | keySet()
Returns a set view of the keys contained in this map. | | public Object | put(Object key, Object value)
Associates the specified value with the specified key in this map
(optional operation). | | public void | putAll(Map map)
Copies all of the mappings from the specified map to this map (optional
operation). | | public Object | remove(Object key)
Removes the mapping for this key from this map if present (optional
operation). | | public int | size()
| | public String | toString()
Converts the map to a string representation for debugging. | | public Collection | values()
Returns a collection view of the values contained in this map. |
| StoredMap | | public StoredMap(Database database, EntryBinding keyBinding, EntryBinding valueBinding, boolean writeAllowed)(Code) | | Creates a map view of a
Database .
Parameters:
database - is the Database underlying the new collection.
Parameters:
keyBinding - is the binding used to translate between key buffersand key objects.
Parameters:
valueBinding - is the binding used to translate between valuebuffers and value objects.
Parameters:
writeAllowed - is true to create a read-write collection or falseto create a read-only collection.
throws:
IllegalArgumentException - if formats are not consistentlydefined or a parameter is invalid.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| StoredMap | | public StoredMap(Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, boolean writeAllowed)(Code) | | Creates a map entity view of a
Database .
Parameters:
database - is the Database underlying the new collection.
Parameters:
keyBinding - is the binding used to translate between key buffersand key objects.
Parameters:
valueEntityBinding - is the binding used to translate betweenkey/value buffers and entity value objects.
Parameters:
writeAllowed - is true to create a read-write collection or falseto create a read-only collection.
throws:
IllegalArgumentException - if formats are not consistentlydefined or a parameter is invalid.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| StoredMap | | public StoredMap(Database database, EntryBinding keyBinding, EntityBinding valueEntityBinding, PrimaryKeyAssigner keyAssigner)(Code) | | Creates a 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.
Parameters:
keyBinding - is the binding used to translate between key buffersand key objects.
Parameters:
valueEntityBinding - is the binding used to translate betweenkey/value buffers and entity value objects.
Parameters:
keyAssigner - is used by the StoredMap.append method to assignprimary keys.
throws:
IllegalArgumentException - if formats are not consistentlydefined or a parameter is invalid.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| append | | public Object append(Object value)(Code) | | Appends a given value returning the newly assigned key. If a
PrimaryKeyAssigner is associated with Store for this map, it will be
used to assigned the returned key. Otherwise the Store must be a QUEUE
or RECNO database and the next available record number is assigned as
the key. This method does not exist in the standard
Map interface.
Note that for the JE product, QUEUE and RECNO databases are not
supported, and therefore a PrimaryKeyAssigner must be associated with
the map in order to call this method.
Parameters:
value - the value to be appended. the assigned key.
throws:
UnsupportedOperationException - if the collection is indexed, orif the collection is read-only, or if the Store has no PrimaryKeyAssigner and is not a QUEUE or RECNO database.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| containsValue | | public boolean containsValue(Object value)(Code) | | Returns true if this map contains the specified value. When an entity
binding is used, this method returns whether the map contains the
primary key and value mapping of the entity. This method conforms to
the
Map.containsValue interface.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| duplicates | | public Collection duplicates(Object key)(Code) | | Returns a new collection containing the values mapped to the given key
in this map. This collection's iterator() method is particularly useful
for iterating over the duplicates for a given key, since this is not
supported by the standard Map interface. This method does not exist in
the standard
Map interface.
If no mapping for the given key is present, an empty collection is
returned. If duplicates are not allowed, at most a single value will be
in the collection returned. If duplicates are allowed, the returned
collection's add() method may be used to add values for the given
key.
Parameters:
key - is the key for which values are to be returned.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| duplicatesMap | | public Map duplicatesMap(Object secondaryKey, EntryBinding primaryKeyBinding)(Code) | | Returns a new map from primary key to value for the subset of records
having a given secondary key (duplicates). This method does not exist
in the standard
Map interface.
If no mapping for the given key is present, an empty collection is
returned. If duplicates are not allowed, at most a single value will be
in the collection returned. If duplicates are allowed, the returned
collection's add() method may be used to add values for the given
key.
Parameters:
secondaryKey - is the secondary key for which duplicates valueswill be represented by the returned map.
Parameters:
primaryKeyBinding - is the binding used for keys in the returnedmap.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| equals | | public boolean equals(Object other)(Code) | | Compares the specified object with this map for equality. A value
comparison is performed by this method and the stored values are
compared rather than calling the equals() method of each element. This
method conforms to the
Map.equals interface.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| get | | public Object get(Object key)(Code) | | Returns the value to which this map maps the specified key. If
duplicates are allowed, this method returns the first duplicate, in the
order in which duplicates are configured, that maps to the specified
key.
This method conforms to the
Map.get interface.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| hashCode | | public int hashCode()(Code) | | |
| initAfterClone | | void initAfterClone()(Code) | | Override this method to initialize view-dependent fields.
|
| put | | public Object put(Object key, Object value)(Code) | | Associates the specified value with the specified key in this map
(optional operation). If duplicates are allowed and the specified key
is already mapped to a value, this method appends the new duplicate
after the existing duplicates. This method conforms to the
Map.put interface.
The key parameter may be null if an entity binding is used and the
key will be derived from the value (entity) parameter. If an entity
binding is used and the key parameter is non-null, then the key
parameter must be equal to the key derived from the value parameter.
the previous value associated with specified key, or null ifthere was no mapping for the key or if duplicates are allowed.
throws:
UnsupportedOperationException - if the collection is indexed, orif the collection is read-only.
throws:
IllegalArgumentException - if an entity value binding is used andthe primary key of the value given is different than the existing storedprimary key.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| putAll | | public void putAll(Map map)(Code) | | Copies all of the mappings from the specified map to this map (optional
operation). When duplicates are allowed, the mappings in the specified
map are effectively appended to the existing mappings in this map, that
is no previously existing mappings in this map are replaced. This
method conforms to the
Map.putAll interface.
throws:
UnsupportedOperationException - if the collection is read-only, orif the collection is indexed.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
| toString | | public String toString()(Code) | | Converts the map to a string representation for debugging. WARNING: All
mappings will be converted to strings and returned and therefore the
returned string may be very large.
the string representation.
throws:
RuntimeExceptionWrapper - if a com.sleepycat.je.DatabaseException is thrown. |
|
|