ucar.nc2.ft.StationTimeSeriesFeatureCollection Maven / Gradle / Ivy

Go to download
/*
 * 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.nc2.ft.point.StationFeature;
import ucar.nc2.time.CalendarDateRange;
import ucar.unidata.geoloc.Station;
import ucar.nc2.units.DateRange;
import ucar.nc2.VariableSimpleIF;

import java.io.IOException;
import java.util.List;

/**
 * A collection of StationTimeSeriesFeature.
 *
 * @author caron
 */
public interface StationTimeSeriesFeatureCollection extends StationCollection, NestedPointFeatureCollection {

  /**
   * Use the internal iterator to check if there is another StationTimeSeriesFeature in the iteration.
   * @return true is there is another StationTimeSeriesFeature in the iteration.
   * @throws java.io.IOException on read error
   */
  public boolean hasNext() throws java.io.IOException;

  /**
   * Use the internal iterator to get the next StationTimeSeriesFeature in the iteration.
   * You must call hasNext() before you call this.
   * @return the next StationTimeSeriesFeature in the iteration
   * @throws java.io.IOException on read error
   */
  public StationTimeSeriesFeature next() throws java.io.IOException;

  /**
   * Make sure that the internal iterator is complete, and recover resources.
   * You must complete the iteration (until hasNext() returns false)
   *  or call finish().
   * @see PointFeatureIterator#finish
   */
  public void finish();

  /**
   * Reset the internal iterator for another iteration over the StationTimeSeriesFeatures in this Collection.
   * @throws java.io.IOException on read error
   */
  public void resetIteration() throws IOException;

  /**
   * Get a subsetted StationCollection based on a list of Stations.
   *
   * @param stations only contain these stations
   * @return subsetted collection
   * @throws java.io.IOException on i/o error
   */
  public StationTimeSeriesFeatureCollection subset(List stations) throws IOException;

  /**
    * Get a subsetted StationCollection based on a list of Stations.
    *
    * @param stations only contain these stations
    * @return subsetted collection
    * @throws java.io.IOException on i/o error
    */
   public StationTimeSeriesFeatureCollection subsetFeatures(List stations) throws IOException;

   /**
   * Get a subsetted StationCollection from a LatLonRect
   *
   * @param boundingBox spatial subset. may be null
   * @return subsetted collection
   * @throws java.io.IOException on i/o error
   */
  public StationTimeSeriesFeatureCollection subset(ucar.unidata.geoloc.LatLonRect boundingBox) throws IOException;

  /**
   * Get the collection of data for a particular Station.
   *
   * @param s get data for this station, must have come from this Collection
   * @return collection of data for this Station.
   * @throws java.io.IOException on i/o error
   */
  public StationTimeSeriesFeature getStationFeature(Station s) throws IOException;

  /**
   * Get the station that belongs to this feature
   *
   * @param feature PointFeature obtained from a StationTimeSeriesFeature in this collection
   * @return the Station is belongs to
   * @throws java.io.IOException on i/o error
   */
  public Station getStation(PointFeature feature) throws IOException;

  /**
   * Get list of stations as StationFeatures
   *
   * @return list of stations as StationFeatures
   * @throws java.io.IOException on i/o error
   */
  public List getStationFeatures() throws IOException;

  public List getStationFeatures( List stnNames)  throws IOException;

  public List getStationFeatures( ucar.unidata.geoloc.LatLonRect boundingBox) throws IOException;


  /**
    * Flatten into a PointFeatureCollection, discarding connectedness information.
    *
    * @param stations only contain these stations; if null or empty use all
    * @param dateRange only points in this date range. may be null.
    * @param varList only these member variables. may be null. currently ignored
    * @return a PointFeatureCollection, may be null if its empty.
    * @throws IOException on read error
    */
   public PointFeatureCollection flatten(List stations, CalendarDateRange dateRange, List varList) throws IOException;

  /**
    * Flatten into a PointFeatureCollection, discarding connectedness information.
    *
    * @param stations only contain these stations; if null or empty use all
    * @param dateRange only points in this date range. may be null.
    * @param varList only these member variables. may be null. currently ignored
    * @return a PointFeatureCollection, may be null if its empty.
    * @throws IOException on read error
   * @deprecated use  CalendarDateRange
    */
   public PointFeatureCollection flatten(List stations, DateRange dateRange, List varList) throws IOException;


}