ucar.nc2.ft.point.collection
Class CompositeStationCollection

java.lang.Object
  extended by ucar.nc2.ft.point.OneNestedPointCollectionImpl
      extended by ucar.nc2.ft.point.StationTimeSeriesCollectionImpl
          extended by ucar.nc2.ft.point.collection.CompositeStationCollection
All Implemented Interfaces:
FeatureCollection, NestedPointFeatureCollection, UpdateableCollection, StationCollection, StationTimeSeriesFeatureCollection

public class CompositeStationCollection
extends StationTimeSeriesCollectionImpl
implements UpdateableCollection

StationTimeSeries composed of a collection of individual StationTimeSeries. "Composite" pattern.

Since:
May 19, 2009
Author:
caron

Field Summary
protected  List<VariableSimpleIF> dataVariables
           
 
Fields inherited from class ucar.nc2.ft.point.StationTimeSeriesCollectionImpl
localIterator, stationHelper
 
Fields inherited from class ucar.nc2.ft.point.OneNestedPointCollectionImpl
npts
 
Constructor Summary
protected CompositeStationCollection(String name, TimedCollection dataCollection, List<Station> stns, List<VariableSimpleIF> dataVariables)
           
 
Method Summary
 PointFeatureCollection flatten(LatLonRect boundingBox, DateRange dateRange)
          Flatten into a PointFeatureCollection, discarding connectedness information.
 PointFeatureCollection flatten(List<String> stations, DateRange dateRange, List<VariableSimpleIF> varList)
          Flatten into a PointFeatureCollection, discarding connectedness information.
 List<VariableSimpleIF> getDataVariables()
           
 PointFeatureCollectionIterator getPointFeatureCollectionIterator(int bufferSize)
          Iterate through the collection, composed of PointFeatureCollection.
 StationTimeSeriesFeature getStationFeature(Station s)
          Get the collection of data for a particular Station.
protected  void initStationHelper()
           
 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.
 void update()
           
 
Methods inherited from class ucar.nc2.ft.point.StationTimeSeriesCollectionImpl
finish, getBoundingBox, getNestedPointFeatureCollectionIterator, getStation, getStation, getStations, getStations, getStations, hasNext, next, resetIteration
 
Methods inherited from class ucar.nc2.ft.point.OneNestedPointCollectionImpl
getCollectionFeatureType, getName, isMultipleNested, setSize, size
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface ucar.nc2.ft.NestedPointFeatureCollection
isMultipleNested, size
 
Methods inherited from interface ucar.nc2.ft.FeatureCollection
getCollectionFeatureType, getName
 

Field Detail

dataVariables

protected List<VariableSimpleIF> dataVariables
Constructor Detail

CompositeStationCollection

protected CompositeStationCollection(String name,
                                     TimedCollection dataCollection,
                                     List<Station> stns,
                                     List<VariableSimpleIF> dataVariables)
                              throws IOException
Throws:
IOException
Method Detail

initStationHelper

protected void initStationHelper()
Specified by:
initStationHelper in class StationTimeSeriesCollectionImpl

getDataVariables

public List<VariableSimpleIF> getDataVariables()

update

public void update()
Specified by:
update in interface UpdateableCollection

subset

public StationTimeSeriesFeatureCollection subset(List<Station> stations)
                                          throws IOException
Description copied from interface: StationTimeSeriesFeatureCollection
Get a subsetted StationCollection based on a list of Stations.

Specified by:
subset in interface StationTimeSeriesFeatureCollection
Overrides:
subset in class StationTimeSeriesCollectionImpl
Parameters:
stations - only contain these stations
Returns:
subsetted collection
Throws:
IOException - on i/o error

subset

public StationTimeSeriesFeatureCollection subset(LatLonRect boundingBox)
                                          throws IOException
Description copied from interface: StationTimeSeriesFeatureCollection
Get a subsetted StationCollection from a LatLonRect

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

getStationFeature

public StationTimeSeriesFeature getStationFeature(Station s)
                                           throws IOException
Description copied from interface: StationTimeSeriesFeatureCollection
Get the collection of data for a particular Station.

Specified by:
getStationFeature in interface StationTimeSeriesFeatureCollection
Overrides:
getStationFeature in class StationTimeSeriesCollectionImpl
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

flatten

public PointFeatureCollection flatten(LatLonRect boundingBox,
                                      DateRange dateRange)
                               throws IOException
Description copied from interface: NestedPointFeatureCollection
Flatten into a PointFeatureCollection, discarding connectedness information. Optionally subset.

Specified by:
flatten in interface NestedPointFeatureCollection
Overrides:
flatten in class StationTimeSeriesCollectionImpl
Parameters:
boundingBox - only points in this lat/lon bounding box. may be null.
dateRange - only points in this date range. may be null.
Returns:
a PointFeatureCollection, may be null if its empty.
Throws:
IOException - on read error

flatten

public PointFeatureCollection flatten(List<String> stations,
                                      DateRange dateRange,
                                      List<VariableSimpleIF> varList)
                               throws IOException
Description copied from interface: StationTimeSeriesFeatureCollection
Flatten into a PointFeatureCollection, discarding connectedness information.

Specified by:
flatten in interface StationTimeSeriesFeatureCollection
Overrides:
flatten in class StationTimeSeriesCollectionImpl
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

getPointFeatureCollectionIterator

public PointFeatureCollectionIterator getPointFeatureCollectionIterator(int bufferSize)
                                                                 throws IOException
Description copied from interface: NestedPointFeatureCollection
Iterate through the collection, composed of PointFeatureCollection. Use this only if isMultipleNested() = false.

Specified by:
getPointFeatureCollectionIterator in interface NestedPointFeatureCollection
Overrides:
getPointFeatureCollectionIterator in class StationTimeSeriesCollectionImpl
Parameters:
bufferSize - how many bytes can be used to buffer data, use -1 to use default.
Returns:
an iterator through PointFeatureCollection objects.
Throws:
IOException - on read error


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