ucar.nc2.ft.point
Class PointIteratorMultidim

java.lang.Object
  ucar.nc2.ft.point.PointIteratorMultidim

All Implemented Interfaces:

PointFeatureIterator

public abstract class PointIteratorMultidim
extends java.lang.Object
implements PointFeatureIterator

A PointFeatureIterator using the "multidimensional representation".

Since:

Mar 26, 2008

Author:

caron

Nested Class Summary

Nested classes/interfaces inherited from interface ucar.nc2.ft.PointFeatureIterator

PointFeatureIterator.Filter

Constructor Summary

PointIteratorMultidim(java.lang.String name, java.util.List<Variable> vars, int outerIndex, PointFeatureIterator.Filter filter)

Method Summary

boolean	hasNext() Check if another PointFeature is available
protected abstract PointFeature	makeFeature(int recnum, StructureData sdata)
PointFeature	next() Returns the next PointFeature.
void	setBufferSize(int bytes) Hint to use this much memory in buffering the iteration.

Methods inherited from class java.lang.Object

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

Constructor Detail

PointIteratorMultidim

public PointIteratorMultidim(java.lang.String name,
                             java.util.List<Variable> vars,
                             int outerIndex,
                             PointFeatureIterator.Filter filter)

Method Detail

makeFeature

protected abstract PointFeature makeFeature(int recnum,
                                            StructureData sdata)
                                     throws java.io.IOException

Throws:

java.io.IOException

hasNext

public boolean hasNext()
                throws java.io.IOException

Description copied from interface: PointFeatureIterator

Check if another PointFeature is available

Specified by:

hasNext in interface PointFeatureIterator

Returns:

true if another PointFeature is available

Throws:

java.io.IOException - on i/o error

next

public PointFeature next()
                  throws java.io.IOException

Description copied from interface: PointFeatureIterator

Returns the next PointFeature. You must call hasNext() before calling next(), even if you know it will return true.

Specified by:

next in interface PointFeatureIterator

Returns:

the next PointFeature

Throws:

java.io.IOException - on i/o error

setBufferSize

public void setBufferSize(int bytes)

Description copied from interface: PointFeatureIterator

Hint to use this much memory in buffering the iteration. No guarentee that it will be used by the implementation.

Specified by:

setBufferSize in interface PointFeatureIterator

Parameters:

bytes - amount of memory in bytes