Package uk.ac.rdg.resc.edal.metadata

Class Parameter

java.lang.Object

uk.ac.rdg.resc.edal.metadata.Parameter

All Implemented Interfaces:

Serializable

public class Parameter
extends Object
implements Serializable

Describes what is being measured by a variable within a Feature or a Dataset.

Author:

Jon, Guy Griffiths

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameter.Category

Constructor Summary

Constructors

Constructor	Description
Parameter(String varId, String title, String description, String units, String standardName)
Parameter(String varId, String title, String description, String units, String standardName, Map<Integer,Parameter.Category> categories)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Map<Integer,Parameter.Category>	getCategories()
String	getDescription()
Map<String,String>	getForeignTitles()
String	getStandardName()
String	getTitle()
String	getUnits()
String	getVariableId()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Parameter

public Parameter(String varId,
                 String title,
                 String description,
                 String units,
                 String standardName)

Parameters:

varId - The ID of the variable which this parameter describes

title - A human-readable title for the quantity being measured

description - A human-readable description of the quantity

units - The units of the measured quantity

standardName - The standard of the measured quantity

Parameter

public Parameter(String varId,
                 String title,
                 String description,
                 String units,
                 String standardName,
                 Map<Integer,Parameter.Category> categories)

Parameters:

varId - The ID of the variable which this parameter describes

title - A human-readable title for the quantity being measured

description - A human-readable description of the quantity

units - The units of the measured quantity

standardName - The standard of the measured quantity

categories - The Map of integers to the categories they represent (for categorical data only)

Method Detail

getVariableId

public String getVariableId()

Returns:

The identifier of the variable this Parameter describes. This is unique within the context (e.g. within the Feature or Dataset).

getTitle

public String getTitle()

Returns:

Human-readable, fairly short title for the parameter.

getForeignTitles

public Map<String,String> getForeignTitles()

Returns:

A Map of langauge code to title in that language

getDescription

public String getDescription()

Returns:

Human-readable, perhaps-lengthy description of the parameter.

getUnits

public String getUnits()

Returns:

The units of this parameter

getStandardName

public String getStandardName()

Returns:

The standard name of the phenomena which this represents TODO This should allow multiple standard names and have scope for different vocabularies

getCategories

public Map<Integer,Parameter.Category> getCategories()

Returns:

A Map of integer values to the Parameter.Category they represent. Returns null for non-categorical data.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object