ucar.nc2.ft

Interface StationProfileFeature

All Superinterfaces:

java.lang.Comparable<Station>, DsgFeatureCollection, EarthLocation, java.lang.Iterable<ProfileFeature>, PointFeatureCC, Station, StationFeature

All Known Implementing Classes:

StationProfileFeatureImpl, StationProfileFeatureImpl.StationProfileFeatureSubset

public interface StationProfileFeature
extends StationFeature, PointFeatureCC, java.lang.Iterable<ProfileFeature>

Time series of ProfileFeature at named locations.

Since:

Feb 29, 2008

Method Summary

Modifier and Type	Method and Description
StructureData	getFeatureData() The data associated with the StationProfile feature.
PointFeatureCollectionIterator	getPointFeatureCollectionIterator() Deprecated. use foreach
ProfileFeature	getProfileByDate(CalendarDate date) Get a particular profile by date.
java.util.List<CalendarDate>	getTimes() Get the list of times in the time series of profiles.
boolean	hasNext() Deprecated. use foreach
ProfileFeature	next() Deprecated. use foreach
void	resetIteration() Deprecated. use foreach
int	size() The number of profiles in the time series.
StationProfileFeature	subset(CalendarDateRange dateRange) Subset this collection by dateRange

Methods inherited from interface ucar.unidata.geoloc.Station

getDescription, getName, getNobs, getWmoId

Methods inherited from interface ucar.unidata.geoloc.EarthLocation

create, getAltitude, getLatitude, getLatLon, getLongitude, isMissing

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface ucar.nc2.ft.PointFeatureCC

getCollectionIterator

Methods inherited from interface ucar.nc2.ft.DsgFeatureCollection

getAltName, getAltUnits, getBoundingBox, getCalendarDateRange, getCollectionFeatureType, getCoordinateVariables, getExtraVariables, getName, getTimeName, getTimeUnit

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

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 DsgFeatureCollection

Returns:

number of profiles in the time series, or -1 if not known.

subset

StationProfileFeature subset(CalendarDateRange dateRange)

Subset this collection by dateRange

Parameters:

dateRange - only points in this date range. may be null.

Returns:

subsetted collection, may be null if empty

getTimes

java.util.List<CalendarDate> getTimes()

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.

getProfileByDate

ProfileFeature getProfileByDate(CalendarDate date)
                         throws java.io.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:

java.io.IOException - on read error

getFeatureData

@Nonnull
StructureData getFeatureData()
                               throws java.io.IOException

The data associated with the StationProfile feature.

Specified by:

getFeatureData in interface StationFeature

Returns:

the actual data of this section. may be empty, not null.

Throws:

java.io.IOException - on i/o error

hasNext

boolean hasNext()
         throws java.io.IOException

Deprecated. use foreach

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

Deprecated. use foreach

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

Deprecated. use foreach

Reset the internal iterator for another iteration over the ProfileFeature in this Collection.

Throws:

java.io.IOException - on read error

getPointFeatureCollectionIterator

PointFeatureCollectionIterator getPointFeatureCollectionIterator()
                                                          throws java.io.IOException

Deprecated. use foreach

Throws:

java.io.IOException