ucar.nc2.dt
Interface StationCollection

All Superinterfaces:

PointCollection

All Known Subinterfaces:

StationObsDataset, StationRadialDataset

All Known Implementing Classes:

AddeStationObsDataset, DqcStationObsDataset, MadisStationObsDataset, NdbcDataset, OldUnidataStationObsDataset, SequenceObsDataset, StationObsDatasetImpl, SubsetServiceDataset, UnidataStationObsDataset, UnidataStationObsDataset2

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.

Version:

$Revision: 51 $ $Date: 2006-07-12 17:13:13Z $

Author:

caron

Method Summary

java.util.List	getData(java.util.List stations) Get all data for a list of Stations.
java.util.List	getData(java.util.List stations, CancelTask cancel) Get all data for a list of Stations, allow user to cancel.
java.util.List	getData(java.util.List stations, java.util.Date start, java.util.Date end) Get data for a list of Stations within the specified date range.
java.util.List	getData(java.util.List stations, java.util.Date start, java.util.Date end, CancelTask cancel) Get data for a list of Stations within the specified date range, allow user to cancel.
java.util.List	getData(Station s) Get all data for this Station.
java.util.List	getData(Station s, CancelTask cancel) Get all data for this Station, allow user to cancel.
java.util.List	getData(Station s, java.util.Date start, java.util.Date end) Get data for this Station within the specified date range.
java.util.List	getData(Station s, java.util.Date start, java.util.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, java.util.Date start, java.util.Date end) Get data for this Station within the specified date range.
Station	getStation(java.lang.String name) Find a Station by name
int	getStationDataCount(Station s) How many Data objects are available for this Station?
java.util.List	getStations() Get all the Stations in the collection.
java.util.List	getStations(CancelTask cancel) Get all the Stations in the collection, allow user to cancel.
java.util.List	getStations(LatLonRect boundingBox) Get all the Stations within a bounding box.
java.util.List	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

java.util.List getStations()
                           throws java.io.IOException

Get all the Stations in the collection.

Returns:

List of Station

Throws:

java.io.IOException

getStations

java.util.List getStations(CancelTask cancel)
                           throws java.io.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:

java.io.IOException

getStations

java.util.List getStations(LatLonRect boundingBox)
                           throws java.io.IOException

Get all the Stations within a bounding box.

Returns:

List of Station

Throws:

java.io.IOException

getStations

java.util.List getStations(LatLonRect boundingBox,
                           CancelTask cancel)
                           throws java.io.IOException

Get all the Stations within a bounding box, allow user to cancel.

Parameters:

cancel - allow user to cancel. Implementors should return ASAP.

Returns:

List of Station

Throws:

java.io.IOException

getStation

Station getStation(java.lang.String name)

Find a Station by name

getStationDataCount

int getStationDataCount(Station s)

How many Data objects are available for this Station?

Parameters:

s - station

Returns:

count or -1 if unknown.

getData

java.util.List getData(Station s)
                       throws java.io.IOException

Get all data for this Station.

Returns:

List of getDataClass()

Throws:

java.io.IOException

getData

java.util.List getData(Station s,
                       CancelTask cancel)
                       throws java.io.IOException

Get all data for this Station, allow user to cancel.

Parameters:

cancel - allow user to cancel. Implementors should return ASAP.

Returns:

List of getDataClass()

Throws:

java.io.IOException

getData

java.util.List getData(Station s,
                       java.util.Date start,
                       java.util.Date end)
                       throws java.io.IOException

Get data for this Station within the specified date range.

Returns:

List of getDataClass()

Throws:

java.io.IOException

getData

java.util.List getData(Station s,
                       java.util.Date start,
                       java.util.Date end,
                       CancelTask cancel)
                       throws java.io.IOException

Get data for this Station within the specified date range, allow user to cancel.

Parameters:

cancel - allow user to cancel. Implementors should return ASAP.

Returns:

List of getDataClass()

Throws:

java.io.IOException

getData

java.util.List getData(java.util.List stations)
                       throws java.io.IOException

Get all data for a list of Stations.

Returns:

List of getDataClass()

Throws:

java.io.IOException

See Also:

as a (possibly) more efficient alternative

getData

java.util.List getData(java.util.List stations,
                       CancelTask cancel)
                       throws java.io.IOException

Get all data for a list of Stations, allow user to cancel.

Parameters:

cancel - allow user to cancel. Implementors should return ASAP.

Returns:

List of getDataClass()

Throws:

java.io.IOException

See Also:

as a (possibly) more efficient alternative

getData

java.util.List getData(java.util.List stations,
                       java.util.Date start,
                       java.util.Date end)
                       throws java.io.IOException

Get data for a list of Stations within the specified date range.

Returns:

List of getDataClass()

Throws:

java.io.IOException

See Also:

as a (possibly) more efficient alternative

getData

java.util.List getData(java.util.List stations,
                       java.util.Date start,
                       java.util.Date end,
                       CancelTask cancel)
                       throws java.io.IOException

Get data for a list of Stations within the specified date range, allow user to cancel.

Parameters:

cancel - allow user to cancel. Implementors should return ASAP.

Returns:

List of getDataClass()

Throws:

java.io.IOException

See Also:

as a (possibly) more efficient alternative

getDataIterator

DataIterator getDataIterator(Station s)

Get all data for this Station.

Returns:

iterator over type getDataClass()

getDataIterator

DataIterator getDataIterator(Station s,
                             java.util.Date start,
                             java.util.Date end)

Get data for this Station within the specified date range.

Returns:

Iterator over type getDataClass()