ucar.nc2.ft
Interface StationProfileFeature

All Superinterfaces:
Comparable<Station>, EarthLocation, FeatureCollection, NestedPointFeatureCollection, Station
All Known Implementing Classes:
StationProfileFeatureImpl

public interface StationProfileFeature
extends Station, NestedPointFeatureCollection

Time series of ProfileFeature at named locations.

Since:
Feb 29, 2008
Author:
caron

Method Summary
 ProfileFeature getProfileByDate(Date date)
          Get a particular profile by date.
 List<Date> getTimes()
          Get the list of times in the time series of profiles.
 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 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:
IOException - on read error

next

ProfileFeature next()
                    throws 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:
IOException - on read error

resetIteration

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

Throws:
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 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:
IOException - on read error

getTimes

List<Date> getTimes()
                    throws IOException
Get the list of times in the time series of profiles. Note that this may be as costly as iterating over the collection.

Returns:
list of times in the time series of profiles.
Throws:
IOException - on read error

getProfileByDate

ProfileFeature getProfileByDate(Date date)
                                throws IOException
Get a particular profile by date. Note that this may be as costly as iterating over the collection.

Parameters:
date - get profile matching this date.
Returns:
profile whose date matches the given date
Throws:
IOException - on read error


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