ChangingIndexedRowIterator (AxionDB 1.0-M3-dev API)

java.lang.Object
- org.axiondb.engine.rowiterators.ChangingIndexedRowIterator

All Implemented Interfaces:

MutableIndexedRowIterator, RowIterator
```
public class ChangingIndexedRowIterator
extends java.lang.Object
implements MutableIndexedRowIterator
```
A DelegatingRowIteratorthat is wraps a RowIteratorfrom some Index, and that can be resetto recreate the iterator for a new bound value.

Version:

$Revision: 1.16 $ $Date: 2005/12/20 18:32:41 $

Constructor Summary

Constructors
Constructor and Description

ChangingIndexedRowIterator(Index index, Table table, Function fn)

Constructors
Constructor and Description
`ChangingIndexedRowIterator(Index index, Table table, Function fn)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Row row)` Add a `Row`at the current position in my underlying collection, or throw `UnsupportedOperationException`.
`Row`	`current()` Returns the last `Row`returned by me (by `RowIterator.next()`,`RowIterator.previous()`, `RowIterator.first()`,`RowIterator.last()`, etc.).
`int`	`currentIndex()` Returns the index of the `RowIterator.current()`row, if any.
`Row`	`first()` Returns the first `Row`in the list, positioning the cursor to just before the first `Row`in the list.
`boolean`	`hasCurrent()` Returns `true` if I have a current `Row`.
`boolean`	`hasNext()` Returns `true` if I have more `Row`s when traversing the list in the forward direction.
`boolean`	`hasPrevious()` Returns `true` if I have more `Row`s when traversing the list in the reverse direction.
`boolean`	`indexSet()`
`boolean`	`isEmpty()` Returns `true` if there are no rows to report with this iterator.
`Row`	`last()` Returns the last `Row`in the list, positioning the cursor to just after the last `Row`in the list.
`Row`	`next()` Returns the next `Row`in the list, or throws `NoSuchElementException`if no next `Row` exists.
`int`	`next(int count)` Sets the current iterator position to currentIndex() + count; this will not set the current row, peekPrevious() may be used to return the current row.
`int`	`nextIndex()` Returns the index of the `RowIterator.next()`row, if any, or the number of elements is the iterator if we've reached the end.
`Row`	`peekNext()` Return the value that would be returned by a call to `RowIterator.next()`, if any, but don't update my position.
`Row`	`peekPrevious()` Return the value that would be returned by a call to `RowIterator.previous()`, if any, but don't update my position.
`Row`	`previous()` Returns the previous `Row`in the list, or throws `NoSuchElementException`if no next `Row` exists.
`int`	`previous(int count)` Sets the current iterator position to currentIndex() - count; this will not set the current row, peekNext() may be used to return the current row.
`int`	`previousIndex()` Returns the index of the `RowIterator.previous()`row, if any, or -1 if we're add the beginning of the list.
`void`	`remove()` Set the `Row`at the current position in my underlying collection, or throw `UnsupportedOperationException`.
`void`	`removeIndexKey()`
`void`	`reset()` Re-initialize this `RowIterator` to its initial state (positioned just before the first `Row`in the list).
`void`	`set(Row row)` Set the `Row`at the current position in my underlying collection, or throw `UnsupportedOperationException`.
`void`	`setIndexKey(java.lang.Object value)`
`int`	`size()` Retunrs the current size of the underlaying row collection
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ChangingIndexedRowIterator
```
public ChangingIndexedRowIterator(Index index,
                                  Table table,
                                  Function fn)
                           throws AxionException
```
    Throws:
    
    AxionException
- Method Detail
  - add
```
public void add(Row row)
         throws AxionException
```
    Description copied from interface: RowIterator
    
    Add a Rowat the current position in my underlying collection, or throw UnsupportedOperationException. (Optional operation.)
    
    Specified by:
    
    add in interface RowIterator
    
    Throws:
    
    AxionException
  - current
```
public Row current()
```
    Description copied from interface: RowIterator
    
    Returns the last Rowreturned by me (by RowIterator.next(),RowIterator.previous(), RowIterator.first(),RowIterator.last(), etc.).
    
    Specified by:
    
    current in interface RowIterator
  - currentIndex
```
public int currentIndex()
```
    Description copied from interface: RowIterator
    
    Returns the index of the RowIterator.current()row, if any.
    
    Specified by:
    
    currentIndex in interface RowIterator
  - first
```
public Row first()
          throws AxionException
```
    Description copied from interface: RowIterator
    
    Returns the first Rowin the list, positioning the cursor to just before the first Rowin the list. (In other words, after first is called both RowIterator.next()and RowIterator.current()will return the first row in the list.)
    
    Specified by:
    
    first in interface RowIterator
    
    Throws:
    
    AxionException - when a problem occurs accessing the Row
  - hasCurrent
```
public boolean hasCurrent()
```
    Description copied from interface: RowIterator
    
    Returns true if I have a current Row. (In other words, returns true iff RowIterator.current()would return a Rowrather than throwing an exception.)
    
    Specified by:
    
    hasCurrent in interface RowIterator
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: RowIterator
    
    Returns true if I have more Rows when traversing the list in the forward direction. (In other words, returns true iff RowIterator.next()would return a Rowrather than throwing an exception.)
    
    Specified by:
    
    hasNext in interface RowIterator
  - hasPrevious
```
public boolean hasPrevious()
```
    Description copied from interface: RowIterator
    
    Returns true if I have more Rows when traversing the list in the reverse direction. (In other words, returns true iff RowIterator.previous()would return a Rowrather than throwing an exception.)
    
    Specified by:
    
    hasPrevious in interface RowIterator
  - indexSet
```
public final boolean indexSet()
```
    Specified by:
    
    indexSet in interface MutableIndexedRowIterator
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: RowIterator
    
    Returns true if there are no rows to report with this iterator.
    
    Specified by:
    
    isEmpty in interface RowIterator
  - last
```
public Row last()
         throws AxionException
```
    Description copied from interface: RowIterator
    
    Returns the last Rowin the list, positioning the cursor to just after the last Rowin the list. (In other words, after last is called both RowIterator.previous()and RowIterator.current()will return the last row in the list.)
    
    Specified by:
    
    last in interface RowIterator
    
    Throws:
    
    AxionException - when a problem occurs accessing the Row
  - next
```
public Row next()
         throws AxionException
```
    Description copied from interface: RowIterator
    
    Returns the next Rowin the list, or throws NoSuchElementExceptionif no next Row exists.
    
    Specified by:
    
    next in interface RowIterator
    
    Throws:
    
    AxionException - when a problem occurs accessing the Row
  - next
```
public int next(int count)
         throws AxionException
```
    Description copied from interface: RowIterator
    
    Sets the current iterator position to currentIndex() + count; this will not set the current row, peekPrevious() may be used to return the current row. This will provide random access e.g one can postion the cursor before the desired row and then call next().
    
    Specified by:
    
    next in interface RowIterator
    
    Throws:
    
    AxionException
  - nextIndex
```
public int nextIndex()
```
    Description copied from interface: RowIterator
    
    Returns the index of the RowIterator.next()row, if any, or the number of elements is the iterator if we've reached the end.
    
    Specified by:
    
    nextIndex in interface RowIterator
  - peekNext
```
public Row peekNext()
             throws AxionException
```
    Description copied from interface: RowIterator
    
    Return the value that would be returned by a call to RowIterator.next(), if any, but don't update my position.
    
    Specified by:
    
    peekNext in interface RowIterator
    
    Throws:
    
    AxionException - when a problem occurs accessing the Row
  - peekPrevious
```
public Row peekPrevious()
                 throws AxionException
```
    Description copied from interface: RowIterator
    
    Return the value that would be returned by a call to RowIterator.previous(), if any, but don't update my position.
    
    Specified by:
    
    peekPrevious in interface RowIterator
    
    Throws:
    
    AxionException - when a problem occurs accessing the Row
  - previous
```
public Row previous()
             throws AxionException
```
    Description copied from interface: RowIterator
    
    Returns the previous Rowin the list, or throws NoSuchElementExceptionif no next Row exists.
    
    Specified by:
    
    previous in interface RowIterator
    
    Throws:
    
    AxionException - when a problem occurs accessing the Row
  - previous
```
public int previous(int count)
             throws AxionException
```
    Description copied from interface: RowIterator
    
    Sets the current iterator position to currentIndex() - count; this will not set the current row, peekNext() may be used to return the current row. This will provide random access e.g one can postion the cursor after the desired row and then call previous().
    
    Specified by:
    
    previous in interface RowIterator
    
    Throws:
    
    AxionException
  - previousIndex
```
public int previousIndex()
```
    Description copied from interface: RowIterator
    
    Returns the index of the RowIterator.previous()row, if any, or -1 if we're add the beginning of the list.
    
    Specified by:
    
    previousIndex in interface RowIterator
  - remove
```
public void remove()
            throws AxionException
```
    Description copied from interface: RowIterator
    
    Set the Rowat the current position in my underlying collection, or throw UnsupportedOperationException. (Optional operation.)
    
    Specified by:
    
    remove in interface RowIterator
    
    Throws:
    
    AxionException
  - removeIndexKey
```
public void removeIndexKey()
                    throws AxionException
```
    Specified by:
    
    removeIndexKey in interface MutableIndexedRowIterator
    
    Throws:
    
    AxionException
  - reset
```
public void reset()
           throws AxionException
```
    Description copied from interface: RowIterator
    
    Re-initialize this RowIterator to its initial state (positioned just before the first Rowin the list).
    
    Specified by:
    
    reset in interface RowIterator
    
    Throws:
    
    AxionException
  - set
```
public void set(Row row)
         throws AxionException
```
    Description copied from interface: RowIterator
    
    Set the Rowat the current position in my underlying collection, or throw UnsupportedOperationException. (Optional operation.)
    
    Specified by:
    
    set in interface RowIterator
    
    Throws:
    
    AxionException
  - setIndexKey
```
public void setIndexKey(java.lang.Object value)
                 throws AxionException
```
    Specified by:
    
    setIndexKey in interface MutableIndexedRowIterator
    
    Throws:
    
    AxionException
  - size
```
public int size()
         throws AxionException
```
    Description copied from interface: RowIterator
    
    Retunrs the current size of the underlaying row collection
    
    Specified by:
    
    size in interface RowIterator
    
    Throws:
    
    AxionException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ChangingIndexedRowIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChangingIndexedRowIterator

Method Detail

add

current

currentIndex

first

hasCurrent

hasNext

hasPrevious

indexSet

isEmpty

last

next

next

nextIndex

peekNext

peekPrevious

previous

previous

previousIndex

remove

removeIndexKey

reset

set

setIndexKey

size

toString