Package uk.ac.rdg.resc.edal.catalogue

Class DataCatalogue

java.lang.Object

uk.ac.rdg.resc.edal.catalogue.DataCatalogue

All Implemented Interfaces:

CatalogueConfig.DatasetStorage, DatasetCatalogue, FeatureCatalogue

public class DataCatalogue
extends Object
implements DatasetCatalogue, CatalogueConfig.DatasetStorage, FeatureCatalogue

A catalogues which implements DatasetCatalogue, CatalogueConfig.DatasetStorage, and FeatureCatalogue. Given a CacheConfiguration, this is able to return Datasets, and Collections of DiscreteFeatures given a single String layer identifier. It also provides a cache of DiscreteFeatures for speed.

Author:

Guy Griffiths

Nested Class Summary

Nested classes/interfaces inherited from interface uk.ac.rdg.resc.edal.graphics.utils.FeatureCatalogue

FeatureCatalogue.FeaturesAndMemberName

Field Summary

Fields

Modifier and Type	Field	Description
protected CatalogueConfig	config
protected Map<String,Dataset>	datasets
protected LayerNameMapper	layerNameMapper

Constructor Summary

Constructors

Constructor	Description
DataCatalogue()
DataCatalogue(CatalogueConfig config, LayerNameMapper layerNameMapper)

Method Summary

Modifier and Type	Method	Description
void	changeDatasetId(String oldId, String newId)	Changes a dataset's ID.
void	datasetLoaded(Dataset dataset, Collection<VariableConfig> variables)	Called once a Dataset is ready to be made available
Collection<Dataset>	getAllDatasets()
CatalogueConfig	getConfig()
Dataset	getDatasetFromId(String datasetId)	Returns a Dataset from its ID
DatasetConfig	getDatasetInfo(String datasetId)
FeatureCatalogue.FeaturesAndMemberName	getFeaturesForLayer(String layerName, PlottingDomainParams params)	Given a single String identifier and a set of PlottingDomainParams, returns a Collection of DiscreteFeatures
org.joda.time.DateTime	getLastUpdateTime()
EnhancedVariableMetadata	getLayerMetadata(VariableMetadata variableMetadata)	Returns EnhancedVariableMetadata giving for a given layer.
void	removeDataset(String id)	Removes a dataset from the catalogue.
void	setCache(CacheInfo cacheConfig)	Configures the cache used to store features
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final CatalogueConfig config

datasets

protected Map<String,Dataset> datasets

layerNameMapper

protected final LayerNameMapper layerNameMapper

Constructor Detail

DataCatalogue

public DataCatalogue()

DataCatalogue

public DataCatalogue(CatalogueConfig config,
                     LayerNameMapper layerNameMapper)
              throws IOException

Throws:

IOException

Method Detail

getConfig

public CatalogueConfig getConfig()

shutdown

public void shutdown()

setCache

public void setCache(CacheInfo cacheConfig)

Configures the cache used to store features

Parameters:

cacheConfig - The (new) configuration to use for the cache. Must not be null

removeDataset

public void removeDataset(String id)

Removes a dataset from the catalogue. This will also delete any config information about the dataset from the config file.

Parameters:

id - The ID of the dataset to remove

changeDatasetId

public void changeDatasetId(String oldId,
                            String newId)

Changes a dataset's ID. This will also change the name in the saved config file.

Parameters:

oldId - The old ID

newId - The new ID

datasetLoaded

public void datasetLoaded(Dataset dataset,
                          Collection<VariableConfig> variables)

Description copied from interface: CatalogueConfig.DatasetStorage

Called once a Dataset is ready to be made available

Specified by:

datasetLoaded in interface CatalogueConfig.DatasetStorage

Parameters:

dataset - The Dataset which is ready

variables - A Collection of VariableConfig objects representing the available variables in the given Dataset

getLastUpdateTime

public org.joda.time.DateTime getLastUpdateTime()

Specified by:

getLastUpdateTime in interface DatasetCatalogue

Returns:

The DateTime at which this DatasetCatalogue was last updated

getAllDatasets

public Collection<Dataset> getAllDatasets()

Specified by:

getAllDatasets in interface DatasetCatalogue

Returns:

All available Datasets in this DatasetCatalogue. Will return null in cases where this information is not available (e.g. all Datasets are dynamically generated)

getDatasetFromId

public Dataset getDatasetFromId(String datasetId)

Description copied from interface: DatasetCatalogue

Returns a Dataset from its ID

Specified by:

getDatasetFromId in interface DatasetCatalogue

Parameters:

datasetId - The ID of the dataset

Returns:

The desired dataset, or null if it doesn't exist in the catalogue

getDatasetInfo

public DatasetConfig getDatasetInfo(String datasetId)

getLayerMetadata

public EnhancedVariableMetadata getLayerMetadata(VariableMetadata variableMetadata)
                                          throws EdalLayerNotFoundException

Description copied from interface: DatasetCatalogue

Returns EnhancedVariableMetadata giving for a given layer. This gives default values for scale range, palette etc., as well as metadata such as title, description, etc.

Specified by:

getLayerMetadata in interface DatasetCatalogue

Parameters:

variableMetadata - The VariableMetadata of the desired layer

Returns:

Default metadata values for the desired layer

Throws:

EdalLayerNotFoundException

getFeaturesForLayer

public FeatureCatalogue.FeaturesAndMemberName getFeaturesForLayer(String layerName,
                                                                  PlottingDomainParams params)
                                                           throws EdalException

Description copied from interface: FeatureCatalogue

Given a single String identifier and a set of PlottingDomainParams, returns a Collection of DiscreteFeatures

Specified by:

getFeaturesForLayer in interface FeatureCatalogue

Parameters:

layerName - The name of the layer to extract

params - The PlottingDomainParams describing the domain to be plotted

Returns:

A FeatureCatalogue.FeaturesAndMemberName object encapsulating the returned DiscreteFeatures

Throws:

EdalException - if there is a problem with feature extraction.