ucar.nc2.ft
Interface StationTimeSeriesFeatureCollection

All Superinterfaces:
FeatureCollection, NestedPointFeatureCollection, StationCollection

public interface StationTimeSeriesFeatureCollection
extends StationCollection, NestedPointFeatureCollection

A collection of StationTimeSeriesFeature.

Author:
caron

Method Summary
 StationTimeSeriesFeature getStationFeature(Station s)
          Get the collection of data for a particular Station.
 boolean hasNext()
          Use the internal iterator to check if there is another StationTimeSeriesFeature in the iteration.
 StationTimeSeriesFeature next()
          Use the internal iterator to get the next StationTimeSeriesFeature in the iteration.
 void resetIteration()
          Reset the internal iterator for another iteration over the StationTimeSeriesFeatures in this Collection.
 StationTimeSeriesFeatureCollection subset(LatLonRect boundingBox)
          Get a subsetted StationCollection based on a LatLonRect
 StationTimeSeriesFeatureCollection subset(java.util.List<Station> stations)
          Get a subsetted StationCollection based on a list of Stations.
 
Methods inherited from interface ucar.nc2.ft.StationCollection
getBoundingBox, getStation, getStations, getStations, getStations
 
Methods inherited from interface ucar.nc2.ft.NestedPointFeatureCollection
flatten, getNestedPointFeatureCollectionIterator, getPointFeatureCollectionIterator, isMultipleNested, size
 
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 StationTimeSeriesFeature in the iteration.

Returns:
true is there is another StationTimeSeriesFeature in the iteration.
Throws:
java.io.IOException - on read error

next

StationTimeSeriesFeature next()
                              throws java.io.IOException
Use the internal iterator to get the next StationTimeSeriesFeature in the iteration. You must call hasNext() before you call this.

Returns:
the next StationTimeSeriesFeature 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 StationTimeSeriesFeatures in this Collection.

Throws:
java.io.IOException - on read error

subset

StationTimeSeriesFeatureCollection subset(java.util.List<Station> stations)
                                          throws java.io.IOException
Get a subsetted StationCollection based on a list of Stations.

Parameters:
stations - only contain these stations
Returns:
subsetted collection
Throws:
java.io.IOException - on i/o error

subset

StationTimeSeriesFeatureCollection subset(LatLonRect boundingBox)
                                          throws java.io.IOException
Get a subsetted StationCollection based on a LatLonRect

Specified by:
subset in interface NestedPointFeatureCollection
Parameters:
boundingBox - spatial subset
Returns:
subsetted collection
Throws:
java.io.IOException - on i/o error

getStationFeature

StationTimeSeriesFeature getStationFeature(Station s)
                                           throws java.io.IOException
Get the collection of data for a particular Station.

Parameters:
s - get data for this station, must have come from
Returns:
collection of data for this Station.
Throws:
java.io.IOException - on i/o error