ucar.nc2.ft
Interface PointFeatureCollection

All Superinterfaces:

FeatureCollection

All Known Subinterfaces:

ProfileFeature, StationTimeSeriesFeature, TrajectoryFeature

All Known Implementing Classes:

PointCollectionImpl, ProfileFeatureImpl, StandardPointCollectionImpl, StationFeatureImpl, TrajectoryFeatureImpl

public interface PointFeatureCollection
extends FeatureCollection

A collection of PointFeatures.

Since:

Mar 1, 2008

Author:

caron

Method Summary

PointFeatureIterator	getPointFeatureIterator(int bufferSize) Get an iterator over the PointFeatures of this collection
boolean	hasNext() Use the internal iterator to check if there is another PointFeature in the iteration.
PointFeature	next() Use the internal iterator to get the next PointFeature in the iteration.
void	resetIteration() Reset the internal iterator for another iteration over the PointFeatures in this Collection.
int	size() The number of points in the collection.
PointFeatureCollection	subset(LatLonRect boundingBox, DateRange dateRange) Subset this collection by boundingBox and/or dateRange

Methods inherited from interface ucar.nc2.ft.FeatureCollection

getCollectionFeatureType, getName

Method Detail

hasNext

boolean hasNext()
                throws java.io.IOException

Use the internal iterator to check if there is another PointFeature in the iteration.

Returns:

true is there is another PointFeature in the iteration.

Throws:

java.io.IOException - on read error

next

PointFeature next()
                  throws java.io.IOException

Use the internal iterator to get the next PointFeature in the iteration. You must call hasNext() before you call this.

Returns:

the next PointFeature in the iteration

Throws:

java.io.IOException - on read error

resetIteration

void resetIteration()
                    throws java.io.IOException

Reset the internal iterator for another iteration over the PointFeatures in this Collection.

Throws:

java.io.IOException - on read error

size

int size()

The number of points in the collection. May not be known until after iterating through the collection.

Returns:

number of points in the collection, or -1 if not known.

getPointFeatureIterator

PointFeatureIterator getPointFeatureIterator(int bufferSize)
                                             throws java.io.IOException

Get an iterator over the PointFeatures of this collection

Parameters:

bufferSize - how many bytes can be used to buffer data, use -1 to use default.

Returns:

iterator over the PointFeatures of this collection

Throws:

java.io.IOException - on read error

subset

PointFeatureCollection subset(LatLonRect boundingBox,
                              DateRange dateRange)
                              throws java.io.IOException

Subset this collection by boundingBox and/or dateRange

Parameters:

boundingBox - only points in this lat/lon bounding box. may be null.

dateRange - only points in this date range. may be null.

Returns:

subsetted collection, may be null if empty

Throws:

java.io.IOException - on read error