Package uk.ac.rdg.resc.edal.dataset

Class PointDataset<F extends DiscreteFeature<?,?>>

java.lang.Object

uk.ac.rdg.resc.edal.dataset.AbstractDataset

uk.ac.rdg.resc.edal.dataset.AbstractContinuousDomainDataset

uk.ac.rdg.resc.edal.dataset.PointDataset<F>

Type Parameters:

F - The type of DiscreteFeature which this PointDataset reads natively (i.e. the same type of DiscreteFeature which is returned by the DiscreteFeatureReader associated with this PointDataset).

All Implemented Interfaces:

Serializable, ContinuousDomainDataset, Dataset

public abstract class PointDataset<F extends DiscreteFeature<?,?>>
extends AbstractContinuousDomainDataset

An AbstractContinuousDomainDataset whose map features are PointFeatures. Subclasses must provide a method to convert from their underlying feature type to a PointFeature, given a set of parameters.

Author:

Guy Griffiths

See Also:

Serialized Form

Field Summary

Fields inherited from class uk.ac.rdg.resc.edal.dataset.AbstractContinuousDomainDataset

featureIndexer

Fields inherited from class uk.ac.rdg.resc.edal.dataset.AbstractDataset

id, plugins, vars

Constructor Summary

Constructors

Constructor	Description
PointDataset(String id, Collection<? extends VariableMetadata> vars, FeatureIndexer featureIndexer)
PointDataset(String id, Collection<? extends VariableMetadata> vars, FeatureIndexer featureIndexer, BoundingBox bbox, Extent<Double> zExtent, Extent<org.joda.time.DateTime> tExtent)

Method Summary

Modifier and Type	Method	Description
protected abstract PointFeature	convertFeature(F feature, BoundingBox hExtent, Extent<Double> zExtent, Extent<org.joda.time.DateTime> tExtent, Double targetZ, org.joda.time.DateTime targetT)	Convert a DiscreteFeature of type F to a PointFeature
static PointFeature	convertPointSeriesFeature(PointSeriesFeature feature, org.joda.time.DateTime targetT)	Convenience method to convert a PointSeriesFeature to a PointFeature.
static PointFeature	convertProfileFeature(ProfileFeature feature, Double targetZ)	Convenience method to convert a ProfileFeature to a PointFeature.
List<PointFeature>	extractMapFeatures(Set<String> varIds, BoundingBox hExtent, Extent<Double> zExtent, Double targetZ, Extent<org.joda.time.DateTime> tExtent, org.joda.time.DateTime targetT)	Extracts features to be plotted on a map.
protected BoundingBox	getDatasetBoundingBox()
protected Extent<org.joda.time.DateTime>	getDatasetTimeExtent()
protected Extent<Double>	getDatasetVerticalExtent()
abstract DiscreteFeatureReader<F>	getFeatureReader()
Class<PointFeature>	getMapFeatureType(String variableId)	Determines the type of feature returned by the extractMapFeatures() methods (defined in subclasses) for a particular variable

Methods inherited from class uk.ac.rdg.resc.edal.dataset.AbstractContinuousDomainDataset

extractProfileFeatures, extractTimeseriesFeatures, getFeatureIds, readFeature

Methods inherited from class uk.ac.rdg.resc.edal.dataset.AbstractDataset

addVariablePlugin, getId, getTopLevelVariables, getVariableIds, getVariableMetadata, isDerivedVariable

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.rdg.resc.edal.dataset.Dataset

getFeatureType, supportsProfileFeatureExtraction, supportsTimeseriesExtraction

Constructor Detail

PointDataset

public PointDataset(String id,
                    Collection<? extends VariableMetadata> vars,
                    FeatureIndexer featureIndexer,
                    BoundingBox bbox,
                    Extent<Double> zExtent,
                    Extent<org.joda.time.DateTime> tExtent)

PointDataset

public PointDataset(String id,
                    Collection<? extends VariableMetadata> vars,
                    FeatureIndexer featureIndexer)

Method Detail

extractMapFeatures

public List<PointFeature> extractMapFeatures(Set<String> varIds,
                                             BoundingBox hExtent,
                                             Extent<Double> zExtent,
                                             Double targetZ,
                                             Extent<org.joda.time.DateTime> tExtent,
                                             org.joda.time.DateTime targetT)
                                      throws DataReadingException

Description copied from class: AbstractContinuousDomainDataset

Extracts features to be plotted on a map.

Specified by:

extractMapFeatures in interface ContinuousDomainDataset

Overrides:

extractMapFeatures in class AbstractContinuousDomainDataset

Parameters:

varIds - The IDs of the variables to be extracted. If this is null then all variable IDs will be plotted. Any non-scalar parent variables will have all of their child variables extracted.

hExtent - The BoundingBox describing the horizontal domain from which to extract features

zExtent - The vertical extent from which to extract features

tExtent - The time range from which to extract features

Returns:

A Collection of DiscreteFeatures which can be plotted

Throws:

DataReadingException - If there is a problem reading the underlying data

getMapFeatureType

public final Class<PointFeature> getMapFeatureType(String variableId)

Determines the type of feature returned by the extractMapFeatures() methods (defined in subclasses) for a particular variable

Always returns a PointFeature - this is the point of this class. For mixed feature types, extend directly from AbstractContinuousDomainDataset.

Parameters:

variableId - The ID of the variable

Returns:

The class of the Features returned when calling the extractMapFeatures method for the given variable ID

getDatasetBoundingBox

protected BoundingBox getDatasetBoundingBox()

Specified by:

getDatasetBoundingBox in class AbstractContinuousDomainDataset

Returns:

The BoundingBox of the entire dataset

getDatasetVerticalExtent

protected Extent<Double> getDatasetVerticalExtent()

Specified by:

getDatasetVerticalExtent in class AbstractContinuousDomainDataset

Returns:

The Extent of the vertical domain for the entire dataset

getDatasetTimeExtent

protected Extent<org.joda.time.DateTime> getDatasetTimeExtent()

Specified by:

getDatasetTimeExtent in class AbstractContinuousDomainDataset

Returns:

The Extent of the time domain for the entire dataset

getFeatureReader

public abstract DiscreteFeatureReader<F> getFeatureReader()

Specified by:

getFeatureReader in class AbstractContinuousDomainDataset

convertFeature

protected abstract PointFeature convertFeature(F feature,
                                               BoundingBox hExtent,
                                               Extent<Double> zExtent,
                                               Extent<org.joda.time.DateTime> tExtent,
                                               Double targetZ,
                                               org.joda.time.DateTime targetT)

Convert a DiscreteFeature of type F to a PointFeature

Parameters:

feature - The feature to convert

hExtent - The BoundingBox containing the feature

zExtent - The vertical Extent containing the feature

tExtent - The time Extent containing the feature

targetZ - The target depth if multiple features are present in the vertical extent

targetT - The target time if multiple features are present in the time extent

Returns:

A PointFeature ready for plotting, or null if the supplied parameters specify a location where no PointFeature is present.

convertProfileFeature

public static PointFeature convertProfileFeature(ProfileFeature feature,
                                                 Double targetZ)

Convenience method to convert a ProfileFeature to a PointFeature. Can be used by classes which only handle ProfileFeatures to implement convertFeature(DiscreteFeature, BoundingBox, Extent, Extent, Double, DateTime)

Parameters:

feature - The ProfileFeature to convert.

targetZ - The target elevation to extract a PointFeature at

Returns:

A PointFeature ready for plotting, or null if the supplied elevation specifies a location where no PointFeature is present.

convertPointSeriesFeature

public static PointFeature convertPointSeriesFeature(PointSeriesFeature feature,
                                                     org.joda.time.DateTime targetT)

Convenience method to convert a PointSeriesFeature to a PointFeature. Can be used by classes which only handle PointSeriesFeatures to implement convertFeature(DiscreteFeature, BoundingBox, Extent, Extent, Double, DateTime)

Parameters:

feature - The PointSeriesFeature to convert.

targetT - The target DateTime to extract a PointFeature at

Returns:

A PointFeature ready for plotting, or null if the supplied DateTime specifies a time at which no PointFeature is present.