Package uk.ac.rdg.resc.edal.feature

Class PointSeriesFeature

java.lang.Object

uk.ac.rdg.resc.edal.feature.AbstractDiscreteFeature<org.joda.time.DateTime,Extent<org.joda.time.DateTime>>

uk.ac.rdg.resc.edal.feature.PointSeriesFeature

All Implemented Interfaces:

Serializable, DiscreteFeature<org.joda.time.DateTime,Extent<org.joda.time.DateTime>>, Feature<org.joda.time.DateTime>

public class PointSeriesFeature
extends AbstractDiscreteFeature<org.joda.time.DateTime,Extent<org.joda.time.DateTime>>

A measurement of a time series at a point

Author:

Guy Griffiths, Jon Blower

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PointSeriesFeature(String id, String name, String description, TimeAxis domain, HorizontalPosition hPos, VerticalPosition zPos, Map<String,Parameter> parameters, Map<String,Array1D<Number>> values)

Method Summary

Modifier and Type	Method	Description
TimeAxis	getDomain()	Gets the TimeAxis which makes up this domain
HorizontalPosition	getHorizontalPosition()	Gets the horizontal location of this point series feature.
Array1D<Number>	getValues(String paramId)	Gets the array of values for the given parameter.
VerticalPosition	getVerticalPosition()	Gets the vertical location of this point series feature.
PointSeriesFeature	subsetPointSeriesFeature(Set<String> varIds, Extent<org.joda.time.DateTime> timeExtent)

Methods inherited from class uk.ac.rdg.resc.edal.feature.AbstractDiscreteFeature

getDescription, getFeatureProperties, getId, getName, getParameter, getParameterMap, getVariableIds

Methods inherited from class java.lang.Object

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

Constructor Detail

PointSeriesFeature

public PointSeriesFeature(String id,
                          String name,
                          String description,
                          TimeAxis domain,
                          HorizontalPosition hPos,
                          VerticalPosition zPos,
                          Map<String,Parameter> parameters,
                          Map<String,Array1D<Number>> values)

Method Detail

subsetPointSeriesFeature

public PointSeriesFeature subsetPointSeriesFeature(Set<String> varIds,
                                                   Extent<org.joda.time.DateTime> timeExtent)

getHorizontalPosition

public HorizontalPosition getHorizontalPosition()

Gets the horizontal location of this point series feature.

getVerticalPosition

public VerticalPosition getVerticalPosition()

Gets the vertical location of this point series feature.

getDomain

public TimeAxis getDomain()

Gets the TimeAxis which makes up this domain

Specified by:

getDomain in interface DiscreteFeature<org.joda.time.DateTime,Extent<org.joda.time.DateTime>>

Specified by:

getDomain in interface Feature<org.joda.time.DateTime>

Overrides:

getDomain in class AbstractDiscreteFeature<org.joda.time.DateTime,Extent<org.joda.time.DateTime>>

Returns:

the domain of the values contained with the feature. May not return null

getValues

public Array1D<Number> getValues(String paramId)

Description copied from interface: DiscreteFeature

Gets the array of values for the given parameter. The shape of this array must match the shape of the array of domain objects (from DiscreteDomain.getDomainObjects()).

Specified by:

getValues in interface DiscreteFeature<org.joda.time.DateTime,Extent<org.joda.time.DateTime>>

Overrides:

getValues in class AbstractDiscreteFeature<org.joda.time.DateTime,Extent<org.joda.time.DateTime>>

Parameters:

paramId - The identifier from the Feature.getVariableIds() set of parameter IDs.

Returns:

the list of values for the requested member