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

Class TrajectoryDataset

java.lang.Object

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

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

uk.ac.rdg.resc.edal.dataset.TrajectoryDataset

All Implemented Interfaces:

Serializable, ContinuousDomainDataset, Dataset

Direct Known Subclasses:

FakeTrajectoryDatasetFactory.FakeTrajectoryDataset

public class TrajectoryDataset
extends AbstractContinuousDomainDataset

A Dataset which contains only TrajectoryFeatures.

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
TrajectoryDataset(String id, List<VariableMetadata> vars, DiscreteFeatureReader<TrajectoryFeature> featureReader, FeatureIndexer indexer)

Method Summary

Modifier and Type	Method	Description
List<TrajectoryFeature>	extractMapFeatures(Set<String> varIds, BoundingBox bbox, Extent<Double> zExtent, Double targetZ, Extent<org.joda.time.DateTime> tExtent, org.joda.time.DateTime targetT)	Extracts trajectory features which cross the given 4d area.
List<? extends ProfileFeature>	extractProfileFeatures(Set<String> varIds, BoundingBox bbox, Extent<Double> zExtent, Extent<org.joda.time.DateTime> tExtent, HorizontalPosition targetPos, org.joda.time.DateTime targetTime)	Extracts ProfileFeature(s) from the Dataset
List<? extends PointSeriesFeature>	extractTimeseriesFeatures(Set<String> varIds, BoundingBox bbox, Extent<Double> zExtent, Extent<org.joda.time.DateTime> tExtent, HorizontalPosition targetPos, Double targetZ)	Extracts PointSeriesFeature(s) from the Dataset
protected BoundingBox	getDatasetBoundingBox()
protected Extent<org.joda.time.DateTime>	getDatasetTimeExtent()
protected Extent<Double>	getDatasetVerticalExtent()
Set<String>	getFeatureIds()
DiscreteFeatureReader<? extends DiscreteFeature<?,?>>	getFeatureReader()
Class<? extends DiscreteFeature<?,?>>	getFeatureType(String variableId)	Determines the type of feature returned by the Dataset.readFeature(String) method for a particular variable (feature ID)
Class<? extends DiscreteFeature<?,?>>	getMapFeatureType(String variableId)	Determines the type of feature returned by the extractMapFeatures() methods (defined in subclasses) for a particular variable
TrajectoryFeature	readFeature(String featureId)	Reads an entire feature from underlying storage
boolean	supportsProfileFeatureExtraction(String varId)
boolean	supportsTimeseriesExtraction(String varId)

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

Constructor Detail

TrajectoryDataset

public TrajectoryDataset(String id,
                         List<VariableMetadata> vars,
                         DiscreteFeatureReader<TrajectoryFeature> featureReader,
                         FeatureIndexer indexer)

Method Detail

getFeatureIds

public Set<String> getFeatureIds()

Specified by:

getFeatureIds in interface Dataset

Overrides:

getFeatureIds in class AbstractContinuousDomainDataset

Returns:

the IDs of features which are present in this Dataset

getFeatureType

public Class<? extends DiscreteFeature<?,?>> getFeatureType(String variableId)

Description copied from interface: Dataset

Determines the type of feature returned by the Dataset.readFeature(String) method for a particular variable (feature ID)

Parameters:

variableId - The ID of the variable

Returns:

The class of the Features returned when calling the Dataset.readFeature(java.lang.String) method for the same variable ID

getMapFeatureType

public Class<? extends DiscreteFeature<?,?>> getMapFeatureType(String variableId)

Description copied from interface: Dataset

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

Parameters:

variableId - The ID of the variable

Returns:

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

readFeature

public TrajectoryFeature readFeature(String featureId)
                              throws DataReadingException,
                                     VariableNotFoundException

Description copied from interface: Dataset

Reads an entire feature from underlying storage

Specified by:

readFeature in interface Dataset

Overrides:

readFeature in class AbstractContinuousDomainDataset

Parameters:

featureId - The ID of the feature to read

Returns:

The resulting Feature

Throws:

VariableNotFoundException - If the requested feature is not found

DataReadingException

extractMapFeatures

public List<TrajectoryFeature> extractMapFeatures(Set<String> varIds,
                                                  BoundingBox bbox,
                                                  Extent<Double> zExtent,
                                                  Double targetZ,
                                                  Extent<org.joda.time.DateTime> tExtent,
                                                  org.joda.time.DateTime targetT)

Extracts trajectory features which cross the given 4d area. Note that this just detects overlaps in the bounding boxes. There is no guarantee that any of the returned features are actually within the area, just that their bounding boxes cross.

Specified by:

extractMapFeatures in interface ContinuousDomainDataset

Overrides:

extractMapFeatures in class AbstractContinuousDomainDataset

Parameters:

varIds - The required variable IDs

bbox - The BoundingBox which features should cross

zExtent - The vertical extent which features should be partially contained within

tExtent - The time extent which features should be partially contained within

Returns:

A Collection of the desired TrajectoryFeatures

extractProfileFeatures

public List<? extends ProfileFeature> extractProfileFeatures(Set<String> varIds,
                                                             BoundingBox bbox,
                                                             Extent<Double> zExtent,
                                                             Extent<org.joda.time.DateTime> tExtent,
                                                             HorizontalPosition targetPos,
                                                             org.joda.time.DateTime targetTime)
                                                      throws DataReadingException,
                                                             UnsupportedOperationException,
                                                             VariableNotFoundException

Description copied from interface: Dataset

Extracts ProfileFeature(s) from the Dataset

Specified by:

extractProfileFeatures in interface Dataset

Overrides:

extractProfileFeatures in class AbstractContinuousDomainDataset

Parameters:

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

bbox -

• If this BoundingBox is non- null, all measurements falling within it will be returned.
• If it is null, only measurements which match the horizontal position given by targetPos will be extracted.
• If both bbox and targetPos are null no constraint is placed on horizontal positions - e.g. for a gridded field a profile will be returned for every horizontal grid point.

zExtent -

• If this is non- null, all ProfileFeatures whose domains have any intersection with this vertical extent will be extracted. The domains of the extracted ProfileFeature s will be the entire available domains, not just the intersection.
• If this is null , no constraint will be placed on the vertical domain of the ProfileFeatures to extract.

tExtent -

• If this is non- null, all measurements which fall entirely within its extent will be extracted
• If it is null only profiles matching the time specified by targetT will be extracted.
• If tExtent and targetT are both null , ProfileFeatures for all available time values will be extracted.

targetPos -

• If the bbox argument is null, only measurements which match this horizontal position will be extracted. In the case of a gridded feature, this will be the profile of the grid cell which the position falls into, but for a dataset with a continuous HorizontalDomain only exact matches will be extracted
• If both bbox and targetPos are null no constraint is placed on horizontal positions - e.g. for a gridded field a profile will be returned for every horizontal grid point.
• If this is non-null, the resulting Collection will be sorted according to distance (in co-ordinate units) from the target position

targetTime -

• If tExtent is null only profiles matching the time specified by this parameter will be extracted. In the case of a gridded dataset a time is considered to match if the method TimeAxis#contains(DateTime) on its time axis returns true for the target time. For a non-gridded dataset, the feature time must exactly match the target time.
• If tExtent and targetT are both null , ProfileFeatures for all available time values will be extracted.

Returns:

A Collection of ProfileFeatures, sorted by their distance from the target horizontal position, if it exists.

Throws:

DataReadingException - if there is a problem reading the underlying data

UnsupportedOperationException - if not all of the requested variables have a vertical domain

VariableNotFoundException - if one or more of the specified variables are not present in this dataset

supportsProfileFeatureExtraction

public boolean supportsProfileFeatureExtraction(String varId)

Parameters:

varId - The ID of the variable to extract

Returns:

true if this dataset supports the extraction of the given variable to ProfileFeatures via the Dataset.extractProfileFeatures(Set, BoundingBox, Extent, Extent, HorizontalPosition, DateTime) method

extractTimeseriesFeatures

public List<? extends PointSeriesFeature> extractTimeseriesFeatures(Set<String> varIds,
                                                                    BoundingBox bbox,
                                                                    Extent<Double> zExtent,
                                                                    Extent<org.joda.time.DateTime> tExtent,
                                                                    HorizontalPosition targetPos,
                                                                    Double targetZ)
                                                             throws DataReadingException,
                                                                    UnsupportedOperationException,
                                                                    VariableNotFoundException

Description copied from interface: Dataset

Extracts PointSeriesFeature(s) from the Dataset

Specified by:

extractTimeseriesFeatures in interface Dataset

Overrides:

extractTimeseriesFeatures in class AbstractContinuousDomainDataset

Parameters:

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

bbox -

• If this BoundingBox is non- null, all measurements falling within it will be returned.
• If it is null, only measurements which match the horizontal position given by targetPos will be extracted.
• If both bbox and targetPos are null no constraint is placed on horizontal positions - e.g. for a gridded field a profile will be returned for every horizontal grid point.

zExtent -

• If this is non- null, all measurements which fall entirely within its extent will be extracted
• If it is null only timeseries matching the depth specified by targetZ will be extracted.
• If zExtent and targetZ are both null , PointSeriesFeatures for all available depth values will be extracted.

tExtent -

• If this is non- null, all PointSeriesFeatures whose domains have any intersection with this time extent will be extracted. The domains of the extracted PointSeriesFeature s will be the entire available domains, not just the intersection.
• If this is null , no constraint will be placed on the time domain of the PointSeriesFeatures to extract.

targetPos -

• If the bbox argument is null, only measurements which match this horizontal position will be extracted. In the case of a gridded feature, this will be the profile of the grid cell which the position falls into, but for a dataset with a continuous HorizontalDomain only exact matches will be extracted
• If both bbox and targetPos are null no constraint is placed on horizontal positions - e.g. for a gridded field a profile will be returned for every horizontal grid point.
• If this is non-null, the resulting Collection will be sorted according to distance (in co-ordinate units) from the target position

targetZ -

• If zExtent is null only timeseries matching the depth specified by this parameter will be extracted. In the case of a gridded dataset a depth is considered to match if the method VerticalAxis#contains(Double) on its vertical axis returns true for the target depth. For a non-gridded dataset, the feature depth must exactly match the target depth.
• If zExtent and targetZ are both null , PointSeriesFeatures for all available time values will be extracted.

Returns:

A Collection of PointSeriesFeatures, sorted by their distance from the target horizontal position, if it exists.

Throws:

DataReadingException - if there is a problem reading the underlying data

UnsupportedOperationException - if not all of the requested variables have a time domain

VariableNotFoundException - if one or more of the specified variables are not present in this dataset

supportsTimeseriesExtraction

public boolean supportsTimeseriesExtraction(String varId)

Parameters:

varId - The ID of the variable to extract

Returns:

true if this dataset supports the extraction of the given variable to PointSeriesFeatures via the Dataset.extractTimeseriesFeatures(Set, BoundingBox, Extent, Extent, HorizontalPosition, Double) method

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 DiscreteFeatureReader<? extends DiscreteFeature<?,?>> getFeatureReader()

Specified by:

getFeatureReader in class AbstractContinuousDomainDataset