net.windward.datasource.abstract_datasource

Class AbstractDataSourceIterator

java.lang.Object

net.windward.datasource.abstract_datasource.AbstractDataSourceIterator

All Implemented Interfaces:

java.util.Iterator, DataSourceIterator

public abstract class AbstractDataSourceIterator
extends java.lang.Object
implements DataSourceIterator

This iterates through the nodes that match a <wr:forEach tag. It will handle the tag's begin, step, and end attributes.

Constructor Summary

Constructors

Constructor and Description
AbstractDataSourceIterator(AbstractDataSource abstractDataSource, ForEachTag tag, DataSourceNode[] stack, IDataSourceResultSet resultSet) Create the iterator.

Method Summary

Modifier and Type	Method and Description
void	close() We are done with this iterator.
int	getCount() Return the count the iteration is on.
int	getIndex() Return the index the iteration is on.
DataSourceNode	getNode(int index) Returns the requested node from the set of nodes presently on.
AbstractDataSource	getParent()
java.lang.Object	getResultSet() Returns the result set this iterator presently holds.
ForEachTag	getTag() Return the forEach tag in use for this iterator.
boolean	hasNext() Returns true if the iteration has more nodes.
boolean	isFirst() Return true if on the first node returned.
boolean	isLast() Return true if on the last node returned.
abstract java.lang.Object	next() Returns the next node in the iteration.
void	remove() This will throw an UnsupportedOperationException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

AbstractDataSourceIterator

public AbstractDataSourceIterator(AbstractDataSource abstractDataSource,
                                  ForEachTag tag,
                                  DataSourceNode[] stack,
                                  IDataSourceResultSet resultSet)
                           throws DataSourceException

Create the iterator.

Parameters:

abstractDataSource - The parent datasource.

tag - The forEach tag this is iterating over.

stack - The node stack. This is the root and all outer forEach tags this iis inside.

resultSet - The result set from the DataSourceNode that is creating this iterator.

Throws:

DataSourceException

Method Detail

hasNext

public boolean hasNext()

Returns true if the iteration has more nodes. (In other words, returns true if next would return a node rather than throwing an exception.)

Specified by:

hasNext in interface java.util.Iterator

Specified by:

hasNext in interface DataSourceIterator

Returns:

true if the iterator has more elements.

next

public abstract java.lang.Object next()

Returns the next node in the iteration. This will always return an object of type DataSourceNode.

Specified by:

next in interface java.util.Iterator

Specified by:

next in interface DataSourceIterator

Returns:

the next element in the iteration.

getNode

public DataSourceNode getNode(int index)
                       throws java.util.NoSuchElementException

Returns the requested node from the set of nodes presently on. Index must be less than the step size. Unlike next() calling this method does not advance the dataset.

Specified by:

getNode in interface DataSourceIterator

Parameters:

index - The offset from the base node on. A value of 0 is identical to the value returned by next.

Returns:

The node at this offset.

Throws:

java.util.NoSuchElementException - thrown if past the end of the list.

remove

public void remove()
            throws java.util.NoSuchElementException

This will throw an UnsupportedOperationException.

Specified by:

remove in interface java.util.Iterator

Specified by:

remove in interface DataSourceIterator

Throws:

java.util.NoSuchElementException

getParent

public AbstractDataSource getParent()

isFirst

public boolean isFirst()

Return true if on the first node returned. This is undefined before the first call to next and is true after the first call to next.

Specified by:

isFirst in interface DataSourceIterator

Returns:

true if on the first node, false otherwise.

isLast

public boolean isLast()

Return true if on the last node returned. This is undefined before the first call to next and is true after the call to next which returns the last node that will be returned.

Specified by:

isLast in interface DataSourceIterator

Returns:

true if on the last node, false otherwise.

close

public void close()

We are done with this iterator. Used to close any resources opened by this object.

Specified by:

close in interface DataSourceIterator

getResultSet

public java.lang.Object getResultSet()
                              throws DataSourceException

Returns the result set this iterator presently holds. This is implementation specific.

Specified by:

getResultSet in interface DataSourceIterator

Returns:

the result set this iterator presently holds.

Throws:

DataSourceException - Could not retrieve the data. Generally wraps a SqlException or XpathException.

getIndex

public int getIndex()

Return the index the iteration is on. This is a 0-based number of the index into the node list and counts all nodes including those skipped if step > 1. This is undefined before the first call to next and is 0 after the first call to next.

Specified by:

getIndex in interface DataSourceIterator

Returns:

The index presently on.

getCount

public int getCount()

Return the count the iteration is on. This is a 1-based number of the number of nodes returned so far. It only counts nodes returned. This is undefined before the first call to next and is 1 after the first call to next.

Specified by:

getCount in interface DataSourceIterator

Returns:

The number of nodes returned so far.

getTag

public ForEachTag getTag()

Return the forEach tag in use for this iterator. This is the tag that is the start of a block in the report that this iterator is iterating through.

Specified by:

getTag in interface DataSourceIterator

Returns:

the forEach tag in use for this iterator.