ucar.nc2.ft
Interface StationTimeSeriesFeatureCollection

All Superinterfaces:
FeatureCollection, NestedPointFeatureCollection, StationCollection
All Known Implementing Classes:
CompositeStationCollection, RemoteStationCollection, StandardStationCollectionImpl, StationTimeSeriesCollectionImpl

public interface StationTimeSeriesFeatureCollection
extends StationCollection, NestedPointFeatureCollection

A collection of StationTimeSeriesFeature.

Author:
caron

Method Summary
 void finish()
          Make sure that the internal iterator is complete, and recover resources.
 PointFeatureCollection flatten(List<String> stations, DateRange dateRange, List<VariableSimpleIF> varList)
          Flatten into a PointFeatureCollection, discarding connectedness information.
 Station getStation(PointFeature feature)
          Get the station that belongs to this feature
 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 from a LatLonRect
 StationTimeSeriesFeatureCollection subset(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 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:
IOException - on read error

next

StationTimeSeriesFeature next()
                              throws 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:
IOException - on read error

finish

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

See Also:
PointFeatureIterator.finish()

resetIteration

void resetIteration()
                    throws IOException
Reset the internal iterator for another iteration over the StationTimeSeriesFeatures in this Collection.

Throws:
IOException - on read error

subset

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

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

subset

StationTimeSeriesFeatureCollection subset(LatLonRect boundingBox)
                                          throws IOException
Get a subsetted StationCollection from a LatLonRect

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

getStationFeature

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

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

getStation

Station getStation(PointFeature feature)
                   throws IOException
Get the station that belongs to this feature

Parameters:
feature - PointFeature obtained from a StationTimeSeriesFeature in this collection
Returns:
the Station is belongs to
Throws:
IOException - on i/o error

flatten

PointFeatureCollection flatten(List<String> stations,
                               DateRange dateRange,
                               List<VariableSimpleIF> varList)
                               throws IOException
Flatten into a PointFeatureCollection, discarding connectedness information.

Parameters:
stations - only contain these stations; if null or empty use all
dateRange - only points in this date range. may be null.
varList - only these member variables. may be null. currently ignored
Returns:
a PointFeatureCollection, may be null if its empty.
Throws:
IOException - on read error


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.