Interface COM.odi.util.IndexIterator

public interface IndexIterator
extends Iterator, Enumeration

Interface for iteration over index or map structures, which yield a key and a value on each iteration.

This class is included in PSE Pro, but not in PSE.

advance(): Advances the iterator to the next entry in the IndexMap.
compareKey(Object): Compares the specified key with the current key.
currentKey(): Gets the current key.
currentValue(): Gets the current value.

  public abstract Object currentKey()

Gets the current key.

Returns:: The current key.
Throws: ConcurrentModificationException: If the associated IndexMap has been modified other than by a call to remove() on this iterator.
Throws: NoSuchElementException: If the iteration has no current element because neither next() or advance() have been called or because the current element has been removed.
Throws: StaleEnumeratorException: If the iterator was used in a transaction that was aborted.

compareKey

  public abstract int compareKey(Object key)

Compares the specified key with the current key. Returns 0 if they are equal, otherwise a non-zero value. If the index is ordered, then returns a value less than 0 if the specified key is smaller than the current key, and a value greater than 0 if the specified key is larger than the current key.

Parameters:: key - The key to compare with the current key.
Returns:: 0 if the key equals to current key, otherwise a non-zero value. If the index is ordered, returns less than than 0 if key is smaller than the current key, and greater than 0 if it is larger.
Throws: ConcurrentModificationException: If the associated B-tree has been modified other than by a call to remove() on this iterator.
Throws: NoSuchElementException: If the iteration has no current element because neither next() or advance() have been called or because the current element has been removed.
Throws: StaleEnumeratorException: If the iterator was used in a transaction that was aborted.

currentValue

  public abstract Object currentValue()

Gets the current value.

Returns:: The current value.
Throws: ConcurrentModificationException: If the associated IndexMap has been modified other than by a call to remove() on this iterator.
Throws: NoSuchElementException: If the iteration has no current element because neither next() or advance() have been called or because the current element has been removed.
Throws: StaleEnumeratorException: If the iterator was used in a transaction that was aborted.

advance

  public abstract void advance()

Advances the iterator to the next entry in the IndexMap.

Throws: ConcurrentModificationException: If the associated IndexMap has been modified other than by a call to remove() on this iterator.
Throws: NoSuchElementException: If the iteration has no more elements.
Throws: StaleEnumeratorException: If the iterator was used in a transaction that was aborted.