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

Class AbstractDiscreteFeature<P,DO>

java.lang.Object

uk.ac.rdg.resc.edal.feature.AbstractDiscreteFeature<P,DO>

Type Parameters:

P - The type of object used to identify positions within the feature's domain. This may be a spatial, temporal, or combined spatiotemporal position.

DO - The type of domain object

All Implemented Interfaces:

Serializable, DiscreteFeature<P,DO>, Feature<P>

Direct Known Subclasses:

GridFeature, MapFeature, PointCollectionFeature, PointFeature, PointSeriesFeature, ProfileFeature, TrajectoryFeature

public abstract class AbstractDiscreteFeature<P,DO>
extends Object
implements DiscreteFeature<P,DO>, Serializable

A partial implementation of a Feature containing common functionality

Author:

Guy

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractDiscreteFeature(String id, String name, String description, DiscreteDomain<P,DO> domain, Map<String,Parameter> parameters, Map<String,? extends Array<Number>> values)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
DiscreteDomain<P,DO>	getDomain()
Properties	getFeatureProperties()
String	getId()
String	getName()
Parameter	getParameter(String parameterId)	Gets a Parameter associated with a variable in this Feature
Map<String,Parameter>	getParameterMap()
Array<Number>	getValues(String paramId)	Gets the array of values for the given parameter.
Set<String>	getVariableIds()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDiscreteFeature

public AbstractDiscreteFeature(String id,
                               String name,
                               String description,
                               DiscreteDomain<P,DO> domain,
                               Map<String,Parameter> parameters,
                               Map<String,? extends Array<Number>> values)

Method Detail

getId

public String getId()

Specified by:

getId in interface Feature<P>

Returns:

an identifier that is unique within the Dataset to which this feature belongs. Must never be null.

getName

public String getName()

Specified by:

getName in interface Feature<P>

Returns:

a human-readable short string that identifies this feature. Not enforced to be unique.

getDescription

public String getDescription()

Specified by:

getDescription in interface Feature<P>

Returns:

a (perhaps lengthy) human-readable description of this feature.

getVariableIds

public Set<String> getVariableIds()

Specified by:

getVariableIds in interface Feature<P>

Returns:

the set of identifiers of the variables recorded in this Feature

getParameter

public Parameter getParameter(String parameterId)

Description copied from interface: Feature

Gets a Parameter associated with a variable in this Feature

Specified by:

getParameter in interface Feature<P>

Parameters:

parameterId - The ID of the desired Parameter

Returns:

the desired Parameter

getParameterMap

public Map<String,Parameter> getParameterMap()

Specified by:

getParameterMap in interface Feature<P>

Returns:

the set of identifiers of the variables in this Feature mapped to the Parameters themselves

getValues

public Array<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<P,DO>

Parameters:

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

Returns:

the list of values for the requested member

getDomain

public DiscreteDomain<P,DO> getDomain()

Description copied from interface: DiscreteFeature

Specified by:

getDomain in interface DiscreteFeature<P,DO>

Specified by:

getDomain in interface Feature<P>

Returns:

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

getFeatureProperties

public Properties getFeatureProperties()

Specified by:

getFeatureProperties in interface Feature<P>

Returns:

a Properties object containing an arbitrary list of String properties associated with this Feature. This can be used to attach any additional information to the Feature which doesn't fit elsewhere. Will not return null, but may be empty.