/*
* Copyright 1998-2014 University Corporation for Atmospheric Research/Unidata
*
* Portions of this software were developed by the Unidata Program at the
* University Corporation for Atmospheric Research.
*
* Access and use of this software shall impose the following obligations
* and understandings on the user. The user is granted the right, without
* any fee or cost, to use, copy, modify, alter, enhance and distribute
* this software, and any derivative works thereof, and its supporting
* documentation for any purpose whatsoever, provided that this entire
* notice appears in all copies of the software, derivative works and
* supporting documentation. Further, UCAR requests that the user credit
* UCAR/Unidata in any publications that result from the use of this
* software or in any product that includes this software. The names UCAR
* and/or Unidata, however, may not be used in any advertising or publicity
* to endorse or promote any products or commercial entity unless specific
* written permission is obtained from UCAR/Unidata. The user also
* understands that UCAR/Unidata is not obligated to provide the user with
* any support, consulting, training or assistance of any kind with regard
* to the use, operation and performance of this software nor to provide
* the user with any updates, revisions, new versions or "bug fixes."
*
* THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
* FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
* NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
* WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
*/
package ucar.nc2.ft;
import ucar.unidata.geoloc.LatLonRect;
import ucar.unidata.geoloc.Station;
import java.io.IOException;
import java.util.List;
/**
* A collection of data at named locations called Stations.
* User can subset by bounding box .
*
* @author caron
*/
public interface StationCollection {
/**
* Get all the Stations in the collection.
*
* @return List of Station
* @throws java.io.IOException on i/o error
*/
public List<Station> getStations() throws IOException;
/**
* Get all the Stations within a bounding box.
*
* @param boundingBox spatial subset
* @return List of Station
* @throws java.io.IOException on i/o error
*/
public List<Station> getStations(ucar.unidata.geoloc.LatLonRect boundingBox) throws IOException;
/**
* Translate list of station names to list of Stations. Skip any not found
*
* @param stnNames list of stnNames
* @return corresponding list of Stations
*/
public List<Station> getStations( List<String> stnNames);
/**
* Find a Station by name.
*
* @param name name/id of the station
* @return Station or null if not found
*/
public Station getStation(String name);
/**
* Get the bounding box including all the stations.
* @return bounding box as a LatLonRect
*/
public LatLonRect getBoundingBox();
}