ucar.nc2.ft

Interface PointFeatureCollection

All Superinterfaces:

DsgFeatureCollection, java.lang.Iterable<PointFeature>

All Known Subinterfaces:

ProfileFeature, StationTimeSeriesFeature, TrajectoryFeature

All Known Implementing Classes:

CompositePointCollection, CompositeStationCollectionFlattened, FlattenedDatasetPointCollection, PointCollectionImpl, PointCollectionImpl.PointCollectionSubset, PointCollectionStreamAbstract, PointCollectionStreamLocal, PointCollectionStreamRemote, ProfileFeatureImpl, StandardPointCollectionImpl, StationTimeSeriesCollectionFlattened, StationTimeSeriesFeatureImpl, StationTimeSeriesFeatureImpl.StationFeatureSubset, TrajectoryFeatureImpl

public interface PointFeatureCollection
extends DsgFeatureCollection, java.lang.Iterable<PointFeature>

A collection of PointFeatures.

Since:

Mar 1, 2008

Method Summary

Modifier and Type	Method and Description
void	finish() Deprecated. use foreach
PointFeatureIterator	getPointFeatureIterator() Deprecated. use foreach
boolean	hasNext() Deprecated. use foreach
PointFeature	next() Deprecated. use foreach
void	resetIteration() Deprecated. use foreach
PointFeatureCollection	subset(LatLonRect boundingBox, CalendarDateRange dateRange) Subset this collection by boundingBox and/or dateRange

Methods inherited from interface ucar.nc2.ft.DsgFeatureCollection

getAltName, getAltUnits, getBoundingBox, getCalendarDateRange, getCollectionFeatureType, getCoordinateVariables, getExtraVariables, getName, getTimeName, getTimeUnit, size

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

subset

@Nullable
PointFeatureCollection subset(LatLonRect boundingBox,
                                        CalendarDateRange dateRange)

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

hasNext

boolean hasNext()
         throws java.io.IOException

Deprecated. use foreach

Use the internal iterator to check if there is another PointFeature in the iteration. Note that this is not thread-safe; use getPointFeatureIterator() for a threadsafe iterator.

Returns:

true is there is another PointFeature in the iteration.

Throws:

java.io.IOException - on read error

See Also:

PointFeatureIterator.hasNext()

next

PointFeature next()
           throws java.io.IOException

Deprecated. use foreach

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

See Also:

PointFeatureIterator.next()

resetIteration

void resetIteration()
             throws java.io.IOException

Deprecated. use foreach

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

Throws:

java.io.IOException - on read error

finish

void finish()

Deprecated. use foreach

Make sure that the internal iterator is complete, and recover resources. You must complete the iteration (until hasNext() returns false) or call finish().

getPointFeatureIterator

PointFeatureIterator getPointFeatureIterator()
                                      throws java.io.IOException

Deprecated. use foreach

Get an iterator over the PointFeatures of this collection. call PointFeatureIterator.finish() when done

Returns:

iterator over the PointFeatures of this collection

Throws:

java.io.IOException - on read error