ucar.nc2.ft
Interface StationProfileFeature

All Superinterfaces:
java.lang.Comparable<Station>, EarthLocation, FeatureCollection, NestedPointFeatureCollection, Station

public interface StationProfileFeature
extends Station, NestedPointFeatureCollection

Time series of ProfileFeature at named locations.

Since:
Feb 29, 2008
Author:
caron

Method Summary
 boolean hasNext()
          Use the internal iterator to check if there is another ProfileFeature in the iteration.
 ProfileFeature next()
          Use the internal iterator to get the next ProfileFeature in the iteration.
 void resetIteration()
          Reset the internal iterator for another iteration over the ProfileFeature in this Collection.
 int size()
          The number of profiles in the time series.
 StationProfileFeature subset(DateRange dateRange)
          Subset this collection by dateRange
 
Methods inherited from interface ucar.unidata.geoloc.Station
getDescription, getName, getWmoId
 
Methods inherited from interface ucar.unidata.geoloc.EarthLocation
getAltitude, getLatitude, getLatLon, getLongitude, isMissing
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface ucar.nc2.ft.NestedPointFeatureCollection
flatten, getNestedPointFeatureCollectionIterator, getPointFeatureCollectionIterator, isMultipleNested, subset
 
Methods inherited from interface ucar.nc2.ft.FeatureCollection
getCollectionFeatureType, getName
 

Method Detail

hasNext

boolean hasNext()
                throws java.io.IOException
Use the internal iterator to check if there is another ProfileFeature in the iteration.

Returns:
true is there is another ProfileFeature in the iteration.
Throws:
java.io.IOException - on read error

next

ProfileFeature next()
                    throws java.io.IOException
Use the internal iterator to get the next ProfileFeature in the iteration. You must call hasNext() before you call this.

Returns:
the next ProfileFeature in the iteration
Throws:
java.io.IOException - on read error

resetIteration

void resetIteration()
                    throws java.io.IOException
Reset the internal iterator for another iteration over the ProfileFeature in this Collection.

Throws:
java.io.IOException - on read error

size

int size()
The number of profiles in the time series. May not be known until after iterating through the collection.

Specified by:
size in interface NestedPointFeatureCollection
Returns:
number of profiles in the time series, or -1 if not known.

subset

StationProfileFeature subset(DateRange dateRange)
                             throws java.io.IOException
Subset this collection by dateRange

Parameters:
dateRange - only points in this date range. may be null.
Returns:
subsetted collection, may be null if empty
Throws:
java.io.IOException - on read error