edu.unh.sdb.datasource
Class DSPartitionedStencilIterator

java.lang.Object
  extended by edu.unh.sdb.datasource.DataCollection
      extended by edu.unh.sdb.datasource.DataBlock
          extended by edu.unh.sdb.datasource.BasicBlock
              extended by edu.unh.sdb.datasource.DSPartitionedStencilIterator
All Implemented Interfaces:
SDBIterator, Indexable
Direct Known Subclasses:
DSThreadedPartitionedStencilIterator

public class DSPartitionedStencilIterator
extends BasicBlock
implements SDBIterator


Field Summary
 
Fields inherited from class edu.unh.sdb.datasource.BasicBlock
leastSignificantAxis, steps
 
Fields inherited from class edu.unh.sdb.datasource.DataCollection
attributeOrder, axisOrdering, axisWeights, bounds, dataOrder, dimensionality, numAttributes, pointOrder, recordDesc
 
Constructor Summary
DSPartitionedStencilIterator(DSPartitionedStencil stencil, DataSource ds)
           
 
Method Summary
 void end()
          Advance the iterator to the last valid value in the iteration.
 DSPartitionedStencil getStencil()
          Return a reference to the stencil.
 void init()
          Perform any necessary initialization, and set the iterator value to the first value in the iteration.
 boolean next()
          Advance the iterator by one step.
 boolean valid()
          Return true if the iterator currently has a valid value, false otherwise.
 
Methods inherited from class edu.unh.sdb.datasource.BasicBlock
copyData, copyData, copyData, datum, datum, datum, datum, datum, datum, datum, datum, getByte, getDouble, getDoubles, getFieldPos, getFloat, getFloats, getInt, getInts, getShort, getShorts, getValues, getValues, psubblock, setAttributeOrderRod, setBytes, setDatum, setDoubles, setField, setField, setField, setField, setField, setField, setFloats, setFloats, setInts, setRod, setRod, setShorts, setValues, setValues, subblock, subblock, subblock, subblock, subblock
 
Methods inherited from class edu.unh.sdb.datasource.DataBlock
setByAttribute, setByte, setBytes, setBytesByAttribute, setBytesByPoint, setDouble, setDoubles, setDoublesByAttribute, setDoublesByPoint, setFloat, setFloats, setFloatsByAttribute, setFloatsByPoint, setInt, setInts, setIntsByAttribute, setIntsByPoint, setShort, setShorts, setShortsByAttribute, setShortsByPoint, setValuesByAttribute, setValuesByPoint, toString
 
Methods inherited from class edu.unh.sdb.datasource.DataCollection
byteSize, computeOffset, computeOffset, copyBounds, createDataBlock, createDataBlock, createDataBlock, createDatum, createDatum, createDatum, createDatum, createDatum, createDatum, datum, dim, getAxisOrdering, getAxisWeight, getAxisWeights, getBounds, getBytes, getBytes, getBytes, getBytes, getBytes, getBytes, getBytesByAttribute, getBytesByAttribute, getBytesByPoint, getBytesByPoint, getDataOrder, getDimensionsArray, getDoubles, getDoubles, getDoubles, getDoubles, getDoubles, getDoubles, getDoublesByAttribute, getDoublesByAttribute, getDoublesByPoint, getDoublesByPoint, getFloats, getFloats, getFloats, getFloats, getFloats, getFloats, getFloatsByAttribute, getFloatsByAttribute, getFloatsByPoint, getFloatsByPoint, getInts, getInts, getInts, getInts, getInts, getInts, getIntsByAttribute, getIntsByAttribute, getIntsByPoint, getIntsByPoint, getLowerBoundsArray, getNumAttributes, getRecordDescriptor, getShorts, getShorts, getShorts, getShorts, getShorts, getShorts, getShortsByAttribute, getShortsByAttribute, getShortsByPoint, getShortsByPoint, getStorageType, getValuesByAttribute, getValuesByPoint, longVolume, setAxisOrdering, setBounds, setRecordDescriptor, size, subblock, subblock, subblock, subblock, subblock, subblock, subblock, subblock, subblock, useBytesOnly, volume
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DSPartitionedStencilIterator

public DSPartitionedStencilIterator(DSPartitionedStencil stencil,
                                    DataSource ds)
Method Detail

getStencil

public DSPartitionedStencil getStencil()
Return a reference to the stencil.


init

public void init()
Perform any necessary initialization, and set the iterator value to the first value in the iteration. If the stencil contains no elements, then the value of this iterator is undefined, but valid() will return false. However, activate() is still called on the underlying datasource.

Specified by:
init in interface SDBIterator

next

public boolean next()
Advance the iterator by one step. If the iterator cannot be advanced to produce a valid value, the value of the iterator is undefined, but the next() method will return false, as will a subsequent call to valid().

Specified by:
next in interface SDBIterator

valid

public boolean valid()
Return true if the iterator currently has a valid value, false otherwise.

Specified by:
valid in interface SDBIterator

end

public void end()
Advance the iterator to the last valid value in the iteration. (optional operation)

Specified by:
end in interface SDBIterator