Package uk.ac.rdg.resc.edal.graphics.utils

Interface LayerNameMapper

All Known Implementing Classes:

SimpleLayerNameMapper

public interface LayerNameMapper

Interface defining the mapping of image layer names (i.e. single String identifiers) to a Dataset ID and a Variable ID

Author:

Guy Griffiths

Method Summary

Modifier and Type	Method	Description
String	getDatasetIdFromLayerName(String layerName)	Returns a Dataset based on a given image layer name
String	getLayerName(String datasetId, String variableId)	Returns the image layer name based on the dataset and variable ID
String	getVariableIdFromLayerName(String layerName)	Returns a variable ID based on a given image layer name

Method Detail

getDatasetIdFromLayerName

String getDatasetIdFromLayerName(String layerName)
                          throws EdalLayerNotFoundException

Returns a Dataset based on a given image layer name

Parameters:

layerName - The name of the image layer

Returns:

The ID of the desired dataset

Throws:

EdalLayerNotFoundException

getVariableIdFromLayerName

String getVariableIdFromLayerName(String layerName)
                           throws EdalLayerNotFoundException

Returns a variable ID based on a given image layer name

Parameters:

layerName - The name of the image layer

Returns:

The ID of the variable (within its Dataset)

Throws:

EdalLayerNotFoundException - if the given layer name does not exist within this catalogue

getLayerName

String getLayerName(String datasetId,
                    String variableId)

Returns the image layer name based on the dataset and variable ID

Parameters:

datasetId - The ID of dataset containing the layer

variableId - The ID of the variable within the dataset

Returns:

The WMS layer name of this variable