ucar.nc2.dt
Interface StationCollection

All Superinterfaces:
PointCollection
All Known Subinterfaces:
StationObsDataset, StationRadialDataset
All Known Implementing Classes:
AddeStationObsDataset, CFstationObsDataset, DqcStationObsDataset, MadisStationObsDataset, NdbcDataset, OldUnidataStationObsDataset, SequenceObsDataset, StationObsDatasetImpl, UnidataStationObsDataset, UnidataStationObsDataset2, UnidataStationObsMultidimDataset

public interface StationCollection
extends PointCollection

A collection of data at unconnected station locations, typically time series. User can subset by stations, bounding box and by date range. Underlying data can be of any type, but all points have the same type.

Author:
caron

Method Summary
 List getData(List<Station> stations)
          Get all data for a list of Stations.
 List getData(List<Station> stations, CancelTask cancel)
          Get all data for a list of Stations, allow user to cancel.
 List getData(List<Station> stations, Date start, Date end)
          Get data for a list of Stations within the specified date range.
 List getData(List<Station> stations, Date start, Date end, CancelTask cancel)
          Get data for a list of Stations within the specified date range, allow user to cancel.
 List getData(Station s)
          Get all data for this Station.
 List getData(Station s, CancelTask cancel)
          Get all data for this Station, allow user to cancel.
 List getData(Station s, Date start, Date end)
          Get data for this Station within the specified date range.
 List getData(Station s, Date start, Date end, CancelTask cancel)
          Get data for this Station within the specified date range, allow user to cancel.
 DataIterator getDataIterator(Station s)
          Get all data for this Station.
 DataIterator getDataIterator(Station s, Date start, Date end)
          Get data for this Station within the specified date range.
 Station getStation(String name)
          Find a Station by name
 int getStationDataCount(Station s)
          How many Data objects are available for this Station?
 List<Station> getStations()
          Get all the Stations in the collection.
 List<Station> getStations(CancelTask cancel)
          Get all the Stations in the collection, allow user to cancel.
 List<Station> getStations(LatLonRect boundingBox)
          Get all the Stations within a bounding box.
 List<Station> getStations(LatLonRect boundingBox, CancelTask cancel)
          Get all the Stations within a bounding box, allow user to cancel.
 
Methods inherited from interface ucar.nc2.dt.PointCollection
getData, getData, getData, getData, getData, getData, getDataClass, getDataCount, getDataIterator, getTimeUnits
 

Method Detail

getStations

List<Station> getStations()
                          throws IOException
Get all the Stations in the collection.

Returns:
List of Station
Throws:
IOException - on io error

getStations

List<Station> getStations(CancelTask cancel)
                          throws IOException
Get all the Stations in the collection, allow user to cancel.

Parameters:
cancel - allow user to cancel. Implementors should return ASAP.
Returns:
List of Station
Throws:
IOException - on io error

getStations

List<Station> getStations(LatLonRect boundingBox)
                          throws IOException
Get all the Stations within a bounding box.

Parameters:
boundingBox - restrict data to this bounding nox
Returns:
List of Station
Throws:
IOException - on io error

getStations

List<Station> getStations(LatLonRect boundingBox,
                          CancelTask cancel)
                          throws IOException
Get all the Stations within a bounding box, allow user to cancel.

Parameters:
boundingBox - restrict data to this bounding nox
cancel - allow user to cancel. Implementors should return ASAP.
Returns:
List of Station
Throws:
IOException - on io error

getStation

Station getStation(String name)
Find a Station by name

Parameters:
name - find this name
Returns:
Station, or null

getStationDataCount

int getStationDataCount(Station s)
How many Data objects are available for this Station?

Parameters:
s - station
Returns:
count or -1 if unknown.

getData

List getData(Station s)
             throws IOException
Get all data for this Station.

Parameters:
s - for this Station
Returns:
List of getDataClass()
Throws:
IOException - on io error

getData

List getData(Station s,
             CancelTask cancel)
             throws IOException
Get all data for this Station, allow user to cancel.

Parameters:
s - for this Station
cancel - allow user to cancel. Implementors should return ASAP.
Returns:
List of getDataClass()
Throws:
IOException - on io error

getData

List getData(Station s,
             Date start,
             Date end)
             throws IOException
Get data for this Station within the specified date range.

Parameters:
s - for this Station
start - restrict data to after this time
end - restrict data to before this time
Returns:
List of getDataClass()
Throws:
IOException - on io error

getData

List getData(Station s,
             Date start,
             Date end,
             CancelTask cancel)
             throws IOException
Get data for this Station within the specified date range, allow user to cancel.

Parameters:
s - for this Station
start - restrict data to after this time
end - restrict data to before this time
cancel - allow user to cancel. Implementors should return ASAP.
Returns:
List of getDataClass()
Throws:
IOException - on io error

getData

List getData(List<Station> stations)
             throws IOException
Get all data for a list of Stations.

Parameters:
stations - for these Stations
Returns:
List of getDataClass()
Throws:
IOException - on io error
See Also:
as a (possibly) more efficient alternative

getData

List getData(List<Station> stations,
             CancelTask cancel)
             throws IOException
Get all data for a list of Stations, allow user to cancel.

Parameters:
stations - for these Stations
cancel - allow user to cancel. Implementors should return ASAP.
Returns:
List of getDataClass()
Throws:
IOException - on io error
See Also:
as a (possibly) more efficient alternative

getData

List getData(List<Station> stations,
             Date start,
             Date end)
             throws IOException
Get data for a list of Stations within the specified date range.

Parameters:
stations - for these Stations
start - restrict data to after this time
end - restrict data to before this time
Returns:
List of getDataClass()
Throws:
IOException - on io error
See Also:
as a (possibly) more efficient alternative

getData

List getData(List<Station> stations,
             Date start,
             Date end,
             CancelTask cancel)
             throws IOException
Get data for a list of Stations within the specified date range, allow user to cancel.

Parameters:
stations - for these Stations
start - restrict data to after this time
end - restrict data to before this time
cancel - allow user to cancel. Implementors should return ASAP.
Returns:
List of getDataClass()
Throws:
IOException - on io error
See Also:
as a (possibly) more efficient alternative

getDataIterator

DataIterator getDataIterator(Station s)
Get all data for this Station.

Parameters:
s - for this Station
Returns:
iterator over type getDataClass()

getDataIterator

DataIterator getDataIterator(Station s,
                             Date start,
                             Date end)
Get data for this Station within the specified date range.

Parameters:
s - for this Station
start - restrict data to after this time
end - restrict data to before this time
Returns:
Iterator over type getDataClass()


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