|
Servertec Persistent Object Store 1.4.1 09/04/2005 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Iterator
Interface defining methods used to transverse Indexes and IndexedObjectStores.
Method Summary | |
---|---|
boolean |
ascending()
Returns whether the current Index is sorted in ascending order. |
boolean |
atFirst()
Returns whether the key, value pair cursor is at the first key, value pair. |
boolean |
atLast()
Returns whether the key, value pair cursor is at the last key, value pair. |
boolean |
duplicates()
Returns whether the current Index supports duplicates. |
boolean |
first()
Attempt to set the cursor to the first key, value pair. |
java.lang.Object |
getCurrentKey()
Returns the current key or null if none exists. |
java.lang.Object |
getCurrentValue()
Returns the current value or null if none exists. |
boolean |
isEmpty()
Returns whether the Index is empty. |
boolean |
isOpen()
Returns whether the current IndexReference is still open. |
boolean |
isSet()
Returns whether the key, value pair cursor is set to a key, value pair. |
boolean |
last()
Attempt to set the cursor to the last key, value pair. |
boolean |
next()
Fowards the cursor and returns whether a next key, value pair exists. |
boolean |
next(IndexFilter filter)
Forwards the cursor and returns whether a next key, value pair exists that meets the specified criteria. |
java.lang.Object |
nextKey()
Returns the next key. |
java.lang.Object |
nextKey(IndexFilter filter)
Returns the next key that meets the specified criteria. |
java.lang.Object |
nextValue()
Returns the next value. |
java.lang.Object |
nextValue(boolean all_keys)
Returns the next value. |
java.lang.Object |
nextValue(IndexFilter filter)
Returns the next value that meets the specified criteria. |
java.lang.Object |
nextValue(IndexFilter filter,
boolean all_keys)
Returns the next value that meets the specified criteria. |
boolean |
previous()
Moves the cursor back and returns whether a prior key, value pair exists. |
boolean |
previous(IndexFilter filter)
Moves the cursor back and returns whether a prior key, value pair exists that meets the specified criteria. |
java.lang.Object |
previousKey()
Returns the previous key. |
java.lang.Object |
previousKey(IndexFilter filter)
Returns the previous key that meets the specified criteria. |
java.lang.Object |
previousValue()
Returns the previous value. |
java.lang.Object |
previousValue(boolean all_keys)
Returns the previous value. |
java.lang.Object |
previousValue(IndexFilter filter)
Returns the previous value that meets the specified criteria. |
java.lang.Object |
previousValue(IndexFilter filter,
boolean all_keys)
Returns the previous value that meets the specified criteria. |
boolean |
seek(java.lang.Object key)
Sets the current cursor to the specified key. |
boolean |
seek(java.lang.Object key,
java.lang.Object value)
Sets the current cursor to the specified key, value pair. |
boolean |
setCurrentKey(java.lang.Object key)
Sets the current key to the specified existing key. |
boolean |
setCurrentValue(java.lang.Object value)
Sets the current value cursor to the specified existing value. |
boolean |
setCursor(java.lang.Object key,
java.lang.Object value)
Sets the current cursor to the specified existing key, value pair. |
int |
valueCount(java.lang.Object key)
Returns the number of duplicate values associated with the specified key in the Index. |
Method Detail |
---|
boolean setCursor(java.lang.Object key, java.lang.Object value) throws java.io.IOException
Changes the key, value pair cursor if the specified key, value pair was found.
key
- the key to set as the current key.value
- the value to set as the current value.
java.io.IOException
- if an I/O exception occurred.java.lang.Object getCurrentKey() throws java.io.IOException
Uses the key cursor.
java.io.IOException
- if an I/O exception occurred.java.lang.Object getCurrentValue() throws java.io.IOException
Uses the value cursor.
java.io.IOException
- if an I/O exception occurred.boolean setCurrentKey(java.lang.Object key) throws java.io.IOException
Changes the key, value pair cursor if the specified key was found.
key
- the key to set as the current key.
java.io.IOException
- if an I/O exception occurred.boolean setCurrentValue(java.lang.Object value) throws java.io.IOException
Changes the value cursor if the specified value was found.
value
- the value to set as the current value.
java.io.IOException
- if an I/O exception occurred.boolean first() throws java.io.IOException
Changes the key, value pair cursor.
java.io.IOException
- if an I/O exception occurred.boolean last() throws java.io.IOException
Changes the key, value pair cursor.
java.io.IOException
- if an I/O exception occurred.boolean atFirst() throws java.io.IOException
Uses the key, value pair cursor.
java.io.IOException
- if an I/O exception occurred.boolean atLast() throws java.io.IOException
Uses the key, value pair cursor.
java.io.IOException
- if an I/O exception occurred.boolean isSet() throws java.io.IOException
Uses the key, value pair cursor.
java.io.IOException
- if an I/O exception occurred.boolean previous() throws java.io.IOException
Uses and updates the key, value pair cursor.
If a previous key exists then this method sets the current value to the last value of the new key.
java.io.IOException
- if an I/O exception occurred.boolean previous(IndexFilter filter) throws java.io.IOException
Uses and updates the key, value pair cursor.
If a previous key exists then this method sets the current value to the last value of the new key.
filter
- the IndexFilter that evaluates whether key, value pairs match the criteria.
java.io.IOException
- if an I/O exception occurred.java.lang.Object previousKey() throws java.io.IOException
Uses and updates the key, value pair cursor.
If a previous key exists then this method sets the current value to the last value of the new key.
java.io.IOException
- if an I/O exception occurred.java.lang.Object previousValue() throws java.io.IOException
Uses and updates the key, value pair cursor.
java.io.IOException
- if an I/O exception occurred.java.lang.Object previousValue(boolean all_keys) throws java.io.IOException
Uses and updates the key, value pair cursor.
all_keys
- whether to return the previous value for all keys or for only the current key.
java.io.IOException
- if an I/O exception occurred.java.lang.Object previousKey(IndexFilter filter) throws java.io.IOException
Uses and updates the key, value pair cursor.
If a previous key exists then this method sets the current value to the last value of the new key.
filter
- the IndexFilter that evaluates whether key, value pairs match the criteria.
java.io.IOException
- if an I/O exception occurred.java.lang.Object previousValue(IndexFilter filter) throws java.io.IOException
Uses and updates the key, value pair cursor.
filter
- the IndexFilter that evaluates whether key, value pairs match the criteria.
java.io.IOException
- if an I/O exception occurred.java.lang.Object previousValue(IndexFilter filter, boolean all_keys) throws java.io.IOException
Uses and updates the key, value pair cursor.
filter
- the IndexFilter that evaluates whether key, value pairs match the criteria.all_keys
- whether to return the previous value for all keys or for only the current key.
java.io.IOException
- if an I/O exception occurred.boolean next() throws java.io.IOException
Uses and updates the key, value pair cursor.
If a next key exists then this method sets the current value to the first value of the new key.
java.io.IOException
- if an I/O exception occurred.boolean next(IndexFilter filter) throws java.io.IOException
Uses and updates the key, value pair cursor.
If a next key exists then this method sets the current value to the first value of the new key.
filter
- the IndexFilter that evaluates whether key, value pairs match the criteria.
java.io.IOException
- if an I/O exception occurred.java.lang.Object nextKey() throws java.io.IOException
Uses and updates the key, value pair cursor.
If a next key exists then this method sets the current value to the first value of the new key.
java.io.IOException
- if an I/O exception occurred.java.lang.Object nextValue() throws java.io.IOException
Uses and updates the key, value pair cursor.
java.io.IOException
- if an I/O exception occurred.java.lang.Object nextValue(boolean all_keys) throws java.io.IOException
Uses and updates the key, value pair cursor.
all_keys
- whether to return the next value for all keys or for only the current key.
java.io.IOException
- if an I/O exception occurred.java.lang.Object nextKey(IndexFilter filter) throws java.io.IOException
Uses and updates the key, value pair cursor.
If a next key exists then this method sets the current value to the first value of the new key.
filter
- the IndexFilter that evaluates whether key, value pairs match the criteria.
java.io.IOException
- if an I/O exception occurred.java.lang.Object nextValue(IndexFilter filter) throws java.io.IOException
Uses and updates the key, value pair cursor.
filter
- the IndexFilter that evaluates whether key, value pairs match the criteria.
java.io.IOException
- if an I/O exception occurred.java.lang.Object nextValue(IndexFilter filter, boolean all_keys) throws java.io.IOException
Uses and updates the key, value pair cursor.
filter
- the IndexFilter that evaluates whether key, value pairs match the criteria.all_keys
- whether to return the next value for all keys or for only the current key.
java.io.IOException
- if an I/O exception occurred.boolean isEmpty() throws java.io.IOException
java.io.IOException
- if an I/O exception occurred.int valueCount(java.lang.Object key) throws java.io.IOException
key
- the key whose values will be counted.
java.io.IOException
- if an I/O exception occurred.boolean isOpen() throws java.io.IOException
java.io.IOException
- if an I/O exception occurred.open
,
close
boolean duplicates() throws java.io.IOException
java.io.IOException
- if an I/O exception occurred.boolean ascending() throws java.io.IOException
java.io.IOException
- if an I/O exception occurred.boolean seek(java.lang.Object key) throws java.io.IOException
Changes the key, value pair cursor.
If the specified key does not exist then calls to getCurrentKey() and getCurrentValue() will return null.
key
- the key to set as the current key.
java.io.IOException
- if an I/O exception occurred.boolean seek(java.lang.Object key, java.lang.Object value) throws java.io.IOException
Changes the key, value pair cursor.
If the specified key, value pair does not exist then calls to getCurrentKey() and getCurrentValue() will return null.
key
- the key to set as the current key.value
- the value to set as the current value.
java.io.IOException
- if an I/O exception occurred.
|
Servertec Persistent Object Store 1.4.1 09/04/2005 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2001-2005 Servertec. All rights reserved.