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

Class PointFeature

java.lang.Object

uk.ac.rdg.resc.edal.feature.AbstractDiscreteFeature<GeoPosition,GeoPosition>

uk.ac.rdg.resc.edal.feature.PointFeature

All Implemented Interfaces:

Serializable, DiscreteFeature<GeoPosition,GeoPosition>, Feature<GeoPosition>

public class PointFeature
extends AbstractDiscreteFeature<GeoPosition,GeoPosition>

A measurement at a single 4D point

Author:

Guy Griffiths

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PointFeature(String id, String name, String description, GeoPosition pos4d, Map<String,Parameter> parameters, Map<String,Array1D<Number>> values)

Method Summary

Modifier and Type	Method	Description
PointDomain	getDomain()
GeoPosition	getGeoPosition()	Convenience method for returning the 4d position of this feature.
HorizontalPosition	getHorizontalPosition()	Convenience method for returning the horizontal position.
Number	getValue(String varId)	Convenience method for extracting the single value associated with a particular parameter.
Array1D<Number>	getValues(String paramId)	Gets the array of values for the given parameter.

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

PointFeature

public PointFeature(String id,
                    String name,
                    String description,
                    GeoPosition pos4d,
                    Map<String,Parameter> parameters,
                    Map<String,Array1D<Number>> values)

Method Detail

getDomain

public PointDomain getDomain()

Description copied from interface: DiscreteFeature

Specified by:

getDomain in interface DiscreteFeature<GeoPosition,GeoPosition>

Specified by:

getDomain in interface Feature<GeoPosition>

Overrides:

getDomain in class AbstractDiscreteFeature<GeoPosition,GeoPosition>

Returns:

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

getHorizontalPosition

public HorizontalPosition getHorizontalPosition()

Convenience method for returning the horizontal position. This is equivalent to calling getGeoPosition() and extracting the horizontal part of the position

Returns:

The HorizontalPosition of this feature

getGeoPosition

public GeoPosition getGeoPosition()

Convenience method for returning the 4d position of this feature. This is equivalent to calling PointDomain.getDomainObjects() and extracting the first (and only) position.

Returns:

The GeoPosition of this feature

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<GeoPosition,GeoPosition>

Overrides:

getValues in class AbstractDiscreteFeature<GeoPosition,GeoPosition>

Parameters:

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

Returns:

the list of values for the requested member

getValue

public Number getValue(String varId)

Convenience method for extracting the single value associated with a particular parameter. Equivalent to calling getValues().get(0)

Parameters:

varId - The variable ID to read

Returns:

The value