org.axiondb.engine.rowiterators
Class BaseRowIterator

java.lang.Object
  org.axiondb.engine.rowiterators.BaseRowIterator

All Implemented Interfaces:

RowIterator

Direct Known Subclasses:

AbstractFilteringRowIterator, AbstractJoinedRowIterator, ChainedRowIterator, CollatingRowIterator, JoinRowIterator, LazyRowRowIterator, ListIteratorRowIterator, ListRowIterator, ReverseSortedRowIterator, RowViewRowIterator

public abstract class BaseRowIterator
extends java.lang.Object
implements RowIterator

An abstract base implementation of RowIterator.

Version:

$Revision: 1.11 $ $Date: 2005/04/22 02:28:53 $

Constructor Summary

BaseRowIterator()

Method Summary

void	add(Row row) Not supported in the base implementation.
abstract Row	current() Returns the last Rowreturned by me (by RowIterator.next(),RowIterator.previous(), RowIterator.first(),RowIterator.last(), etc.).
abstract int	currentIndex() Returns the index of the RowIterator.current()row, if any.
Row	first() Returns the first Rowin the list, positioning the cursor to just before the first Rowin the list.
abstract boolean	hasCurrent() Returns true if I have a current Row.
abstract boolean	hasNext() Returns true if I have more Rows when traversing the list in the forward direction.
abstract boolean	hasPrevious() Returns true if I have more Rows when traversing the list in the reverse direction.
boolean	isEmpty() Returns true if there are no rows to report with this iterator.
Row	last() Returns the last Rowin the list, positioning the cursor to just after the last Rowin the list.
abstract Row	next() Returns the next Rowin the list, or throws NoSuchElementExceptionif 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.
abstract 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.
abstract Row	previous() Returns the previous Rowin the list, or throws NoSuchElementExceptionif 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.
abstract 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() Not supported in the base implementation.
abstract void	reset() Re-initialize this RowIterator to its initial state (positioned just before the first Rowin the list).
void	set(Row row) Not supported in the base implementation.
int	size() Retunrs the current size of the underlaying row collection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseRowIterator

public BaseRowIterator()

Method Detail

add

public void add(Row row)
         throws AxionException

Not supported in the base implementation.

Specified by:

add in interface RowIterator

Throws:

AxionException

current

public abstract Row current()
                     throws java.util.NoSuchElementException

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

Throws:

java.util.NoSuchElementException - when no Rowhas yet been returned

currentIndex

public abstract int currentIndex()
                          throws java.util.NoSuchElementException

Description copied from interface: RowIterator

Returns the index of the RowIterator.current()row, if any.

Specified by:

currentIndex in interface RowIterator

Throws:

java.util.NoSuchElementException - when no Rowhas yet been returned

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 abstract 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 abstract 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 abstract 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

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 abstract Row next()
                  throws java.util.NoSuchElementException,
                         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:

java.util.NoSuchElementException - when there is no next Row

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 abstract 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 abstract Row previous()
                      throws java.util.NoSuchElementException,
                             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:

java.util.NoSuchElementException - when there is no next Row

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 abstract 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

Not supported in the base implementation.

Specified by:

remove in interface RowIterator

Throws:

AxionException

reset

public abstract 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

Not supported in the base implementation.

Specified by:

set in interface RowIterator

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