ucar.nc2.ft.point

Class PointCollectionIteratorFiltered

java.lang.Object

ucar.nc2.ft.point.PointCollectionIteratorFiltered

All Implemented Interfaces:

PointFeatureCollectionIterator

public class PointCollectionIteratorFiltered
extends Object
implements PointFeatureCollectionIterator

Filter a PointFeatureCollectionIterator

Since:

Mar 20, 2008

Author:

caron

Nested Class Summary

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

PointFeatureCollectionIterator.Filter

Constructor Summary

Constructors

Constructor and Description
PointCollectionIteratorFiltered(PointFeatureCollectionIterator pfciter, PointFeatureCollectionIterator.Filter filter)

Method Summary

Methods

Modifier and Type	Method and Description
void	finish() Make sure that the iterator is complete, and recover resources.
boolean	hasNext() true if another PointFeatureCollection is available
PointFeatureCollection	next() Returns the next PointFeatureCollection You must call hasNext() before calling next(), even if you know it will return true.
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

PointCollectionIteratorFiltered

public PointCollectionIteratorFiltered(PointFeatureCollectionIterator pfciter,
                               PointFeatureCollectionIterator.Filter filter)

Method Detail

setBufferSize

public void setBufferSize(int bytes)

Description copied from interface: PointFeatureCollectionIterator

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 PointFeatureCollectionIterator

Parameters:

bytes - amount of memory in bytes

hasNext

public boolean hasNext()
                throws IOException

Description copied from interface: PointFeatureCollectionIterator

true if another PointFeatureCollection is available

Specified by:

hasNext in interface PointFeatureCollectionIterator

Returns:

true if another PointFeatureCollection is available

Throws:

IOException - on i/o error

next

public PointFeatureCollection next()
                            throws IOException

Description copied from interface: PointFeatureCollectionIterator

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

Specified by:

next in interface PointFeatureCollectionIterator

Returns:

the next PointFeatureCollection

Throws:

IOException - on i/o error

finish

public void finish()

Description copied from interface: PointFeatureCollectionIterator

Make sure that the iterator is complete, and recover resources. You must complete the iteration (until hasNext() returns false) or call finish(). may be called more than once.

Specified by:

finish in interface PointFeatureCollectionIterator