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

Class VariableConfig

java.lang.Object

uk.ac.rdg.resc.edal.catalogue.jaxb.VariableConfig

All Implemented Interfaces:

EnhancedVariableMetadata

public class VariableConfig
extends Object
implements EnhancedVariableMetadata

A class representing a variable in the XML config. This contains all of the information needed to define the EnhancedVariableMetadata which contains default plotting options etc.

Author:

Guy Griffiths

Constructor Summary

Constructors

Constructor	Description
VariableConfig(String id, String title, String description, Extent<Float> colorScaleRange, String paletteName, Color belowMinColour, Color aboveMaxColour, Color noDataColour, String scaling, int numColorBands)

Method Summary

Modifier and Type	Method	Description
String	getCopyright()
PlottingStyleParameters	getDefaultPlottingParameters()
String	getDescription()
String	getId()
String	getMoreInfo()
DatasetConfig	getParentDataset()
String	getTitle()
boolean	isDisabled()
boolean	isDownloadable()
boolean	isQueryable()
void	setColorScaleRange(Extent<Float> colorScaleRange)
void	setDisabled(boolean disabled)
void	setId(String id)
void	setNumColorBands(int numColorBands)
void	setPaletteName(String paletteName)
void	setScaling(String scaling)
void	setTitle(String title)

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableConfig

public VariableConfig(String id,
                      String title,
                      String description,
                      Extent<Float> colorScaleRange,
                      String paletteName,
                      Color belowMinColour,
                      Color aboveMaxColour,
                      Color noDataColour,
                      String scaling,
                      int numColorBands)

Method Detail

getId

public String getId()

Specified by:

getId in interface EnhancedVariableMetadata

Returns:

The ID of the configured variable within its Dataset

getTitle

public String getTitle()

Specified by:

getTitle in interface EnhancedVariableMetadata

Returns:

The title of this layer to be displayed in the menu and the Capabilities document

getDefaultPlottingParameters

public PlottingStyleParameters getDefaultPlottingParameters()

Specified by:

getDefaultPlottingParameters in interface EnhancedVariableMetadata

Returns:

The default plot settings for this variable - this may not return null, but any of the defined methods within the returned PlottingStyleParameters object may do.

isQueryable

public boolean isQueryable()

Specified by:

isQueryable in interface EnhancedVariableMetadata

Returns:

Whether or not this layer can be queried with GetFeatureInfo requests

isDownloadable

public boolean isDownloadable()

Specified by:

isDownloadable in interface EnhancedVariableMetadata

Returns:

Whether or not this layer can be downloaded in CSV/CoverageJSON format

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface EnhancedVariableMetadata

Returns:

Whether this layer is disabled

getDescription

public String getDescription()

Specified by:

getDescription in interface EnhancedVariableMetadata

Returns:

A brief description of this layer to be displayed in the Capabilities document

getCopyright

public String getCopyright()

Specified by:

getCopyright in interface EnhancedVariableMetadata

Returns:

Copyright information about this layer to be displayed be clients

getMoreInfo

public String getMoreInfo()

Specified by:

getMoreInfo in interface EnhancedVariableMetadata

Returns:

More information about this layer to be displayed be clients

setId

public void setId(String id)

setTitle

public void setTitle(String title)

setColorScaleRange

public void setColorScaleRange(Extent<Float> colorScaleRange)

setPaletteName

public void setPaletteName(String paletteName)

setScaling

public void setScaling(String scaling)

setNumColorBands

public void setNumColorBands(int numColorBands)

setDisabled

public void setDisabled(boolean disabled)

getParentDataset

public DatasetConfig getParentDataset()