ucar.nc2.ft.point

Class StationProfileFeatureImpl

java.lang.Object

ucar.nc2.ft.point.DsgCollectionImpl

ucar.nc2.ft.point.PointFeatureCCImpl

ucar.nc2.ft.point.StationProfileFeatureImpl

All Implemented Interfaces:

Comparable<Station>, Iterable<ProfileFeature>, DsgFeatureCollection, StationFeature, PointFeatureCC, StationProfileFeature, EarthLocation, Station

Direct Known Subclasses:

StationProfileFeatureImpl.StationProfileFeatureSubset

public abstract class StationProfileFeatureImpl
extends PointFeatureCCImpl
implements StationProfileFeature

Abstract superclass for implementations of StationProfileFeature. Subclass must implement getPointFeatureCollectionIterator();

Since:

Feb 29, 2008

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StationProfileFeatureImpl.StationProfileFeatureSubset

Field Summary

Fields

Modifier and Type	Field and Description
protected PointFeatureCollectionIterator	localIterator
protected Station	station
protected int	timeSeriesNpts

Fields inherited from class ucar.nc2.ft.point.PointFeatureCCImpl

collectionFeatureType

Fields inherited from class ucar.nc2.ft.point.DsgCollectionImpl

altUnits, extras, info, name, timeUnit

Constructor Summary

Constructors

Constructor and Description
StationProfileFeatureImpl(Station s, CalendarDateUnit timeUnit, String altUnits, int npts)
StationProfileFeatureImpl(String name, String desc, String wmoId, double lat, double lon, double alt, CalendarDateUnit timeUnit, String altUnits, int npts)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Station so)
double	getAltitude() Returns the altitude in some unit.
String	getDescription() Station description
double	getLatitude() Returns the latitude in some unit.
LatLonPoint	getLatLon() Get the lat/lon location
double	getLongitude() Returns the longitude in some unit.
String	getName() Get the name of this feature collection.
int	getNobs() get Number of obs at this station
String	getWmoId() WMO station id.
boolean	hasNext() Use the internal iterator to check if there is another ProfileFeature in the iteration.
boolean	isMissing() Are either lat or lon missing?
Iterator<ProfileFeature>	iterator()
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 Features in the collection.
StationProfileFeature	subset(CalendarDateRange dateRange) Subset this collection by dateRange
StationProfileFeature	subset(LatLonRect boundingBox)

Methods inherited from class ucar.nc2.ft.point.PointFeatureCCImpl

getCollectionFeatureType

Methods inherited from class ucar.nc2.ft.point.DsgCollectionImpl

getAltUnits, getBoundingBox, getCalendarDateRange, getExtraVariables, getInfo, getTimeUnit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ucar.nc2.ft.StationProfileFeature

getFeatureData, getPointFeatureCollectionIterator, getProfileByDate, getTimes

Methods inherited from interface ucar.nc2.ft.PointFeatureCC

getCollectionIterator

Methods inherited from interface ucar.nc2.ft.DsgFeatureCollection

getAltUnits, getBoundingBox, getCalendarDateRange, getCollectionFeatureType, getExtraVariables, getTimeUnit

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

timeSeriesNpts

protected int timeSeriesNpts

station

protected Station station

localIterator

protected PointFeatureCollectionIterator localIterator

Constructor Detail

StationProfileFeatureImpl

public StationProfileFeatureImpl(String name,
                                 String desc,
                                 String wmoId,
                                 double lat,
                                 double lon,
                                 double alt,
                                 CalendarDateUnit timeUnit,
                                 String altUnits,
                                 int npts)

StationProfileFeatureImpl

public StationProfileFeatureImpl(Station s,
                                 CalendarDateUnit timeUnit,
                                 String altUnits,
                                 int npts)

Method Detail

getNobs

public int getNobs()

Description copied from interface: Station

get Number of obs at this station

Specified by:

getNobs in interface Station

Overrides:

getNobs in class DsgCollectionImpl

Returns:

Number of obs or -1 if unknown

getWmoId

public String getWmoId()

Description copied from interface: Station

WMO station id.

Specified by:

getWmoId in interface Station

Returns:

WMO station id, or null.

size

public int size()

Description copied from interface: DsgFeatureCollection

The number of Features in the collection. May not be known until after iterating through the collection.

Specified by:

size in interface DsgFeatureCollection

Specified by:

size in interface StationProfileFeature

Overrides:

size in class DsgCollectionImpl

Returns:

number of elements in the collection, or -1 if not known.

getName

@Nonnull
public String getName()

Description copied from interface: DsgFeatureCollection

Get the name of this feature collection.

Specified by:

getName in interface DsgFeatureCollection

Specified by:

getName in interface Station

Overrides:

getName in class DsgCollectionImpl

Returns:

the name of this feature collection

getDescription

public String getDescription()

Description copied from interface: Station

Station description

Specified by:

getDescription in interface Station

Returns:

station description or null

getLatitude

public double getLatitude()

Description copied from interface: EarthLocation

Returns the latitude in some unit. The unit is very likely decimal degrees north, but we don't enforce that anywhere.

Specified by:

getLatitude in interface EarthLocation

Returns:

the latitude in some unit.

getLongitude

public double getLongitude()

Description copied from interface: EarthLocation

Returns the longitude in some unit. The unit is very likely decimal degrees east, but we don't enforce that anywhere.

Specified by:

getLongitude in interface EarthLocation

Returns:

the longitude in some unit.

getAltitude

public double getAltitude()

Description copied from interface: EarthLocation

Returns the altitude in some unit. If this EarthLocation was retrieved from a PointFeature (via PointFeature.getLocation()), then the unit can be obtained by calling pointFeature.getFeatureCollection().getAltUnits().

Specified by:

getAltitude in interface EarthLocation

Returns:

the altitude in some unit. A value of Double.NaN indicates "no altitude".

getLatLon

public LatLonPoint getLatLon()

Description copied from interface: EarthLocation

Get the lat/lon location

Specified by:

getLatLon in interface EarthLocation

Returns:

lat/lon location

isMissing

public boolean isMissing()

Description copied from interface: EarthLocation

Are either lat or lon missing?

Specified by:

isMissing in interface EarthLocation

Returns:

true if lat or lon is missing

compareTo

public int compareTo(@Nonnull
                     Station so)

Specified by:

compareTo in interface Comparable<Station>

subset

public StationProfileFeature subset(LatLonRect boundingBox)
                             throws IOException

Throws:

IOException

subset

public StationProfileFeature subset(CalendarDateRange dateRange)
                             throws IOException

Description copied from interface: StationProfileFeature

Subset this collection by dateRange

Specified by:

subset in interface StationProfileFeature

Parameters:

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

Returns:

subsetted collection, may be null if empty

Throws:

IOException - on read error

iterator

public Iterator<ProfileFeature> iterator()

Specified by:

iterator in interface Iterable<ProfileFeature>

hasNext

public boolean hasNext()
                throws IOException

Description copied from interface: StationProfileFeature

Use the internal iterator to check if there is another ProfileFeature in the iteration.

Specified by:

hasNext in interface StationProfileFeature

Returns:

true is there is another ProfileFeature in the iteration.

Throws:

IOException - on read error

next

public ProfileFeature next()
                    throws IOException

Description copied from interface: StationProfileFeature

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

Specified by:

next in interface StationProfileFeature

Returns:

the next ProfileFeature in the iteration

Throws:

IOException - on read error

resetIteration

public void resetIteration()
                    throws IOException

Description copied from interface: StationProfileFeature

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

Specified by:

resetIteration in interface StationProfileFeature

Throws:

IOException - on read error