ucar.unidata.data

Class DataAlias

java.lang.Object

ucar.unidata.data.DataAlias

All Implemented Interfaces:

java.lang.Comparable

public class DataAlias
extends java.lang.Object
implements java.lang.Comparable

This class manages a set of data aliases - a mapping between canonical names and a list of aliases for the canonical name. This class is not instantiated - rather it provides a set of static methods. It is initialized by the IDV with an XmlResourceCollection that holds a set of aliases.xml files. The xml looks like:

 <aliases>
 <alias name="TEMP"     label="Temperature"   aliases="T,t,Temperature,tdry" />
 ...
 </aliases>
 </pre>
 Each alias tag holds a name (the canonical name), a label and a comma
 separated list of aliases for the name.

Version:

$Revision: 1.39 $

Author:

IDV development team

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_ALIASES Xml attribute for aliases
static java.lang.String	ATTR_LABEL Xml attribute for label
static java.lang.String	ATTR_NAME Xml attribute for name
static java.lang.String	TAG_ALIAS Xml tag for canonical name
static java.lang.String	TAG_ALIASES Xml tag for aliases

Constructor Summary

Constructors

Constructor and Description
DataAlias(java.lang.String name, java.lang.String label) Construct a new DataAlias with the given name and label.

Method Summary

Modifier and Type	Method and Description
protected void	addAlias(java.lang.String alias) Add an alias for this object.
protected void	addAliases(java.util.List l) Add alist of aliases to this DataAlias
static java.lang.String	aliasToCanonical(java.lang.String paramName) Return the canonical name for the given alias.
int	compareTo(java.lang.Object o) _more_
static java.util.List	createDataAliases(org.w3c.dom.Element root) Process the given xml and return a list of DataAlias objects defined within the xml.
boolean	equals(java.lang.Object o) See if o is equal to this.
static DataAlias	findAlias(java.lang.String paramName) Return the DataAlias object the given canonical name.
java.util.List	getAliases() Get aliases for the name of this DataAlias
static java.util.List	getAliasesOf(java.lang.String paramName) Return the list of aliases (Strings) for the given canonical.
static java.util.List	getDataAliasList() Return the list of canonical names (String-s)
java.lang.String	getLabel() Get the label of this DataAlias
static java.util.List	getLabelIdList() Return the list of name/label pairs (TwoFacedObject-s)
java.lang.String	getName() Get the name of this DataAlias
int	hashCode() Override of hashCode method.
static void	init(XmlResourceCollection resources) Initialize the DataAlias-es with the given collection of xml resources, XmlResourceCollection
static void	reInit(XmlResourceCollection resources) Reinitialize the data structures and reprocess the xml.
void	setLabel(java.lang.String value) Set the label of this DataAlias
void	setName(java.lang.String value) Set the name of this DataAlias
java.lang.String	toString() Returns a string representation of this DataAlias.

Methods inherited from class java.lang.Object

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

Field Detail

TAG_ALIAS

public static final java.lang.String TAG_ALIAS

Xml tag for canonical name

See Also:

Constant Field Values

TAG_ALIASES

public static final java.lang.String TAG_ALIASES

Xml tag for aliases

See Also:

Constant Field Values

ATTR_ALIASES

public static final java.lang.String ATTR_ALIASES

Xml attribute for aliases

See Also:

Constant Field Values

ATTR_NAME

public static final java.lang.String ATTR_NAME

Xml attribute for name

See Also:

Constant Field Values

ATTR_LABEL

public static final java.lang.String ATTR_LABEL

Xml attribute for label

See Also:

Constant Field Values

Constructor Detail

DataAlias

public DataAlias(java.lang.String name,
                 java.lang.String label)

Construct a new DataAlias with the given name and label.

Parameters:

name - name of this DataAlias

label - label of this DataAlias. Used for displaying a "nice" string for this DataAlias.

Method Detail

addAlias

protected void addAlias(java.lang.String alias)

Add an alias for this object.

Parameters:

alias - alias to add.

addAliases

protected void addAliases(java.util.List l)

Add alist of aliases to this DataAlias

Parameters:

l - List of names (String-s)

hashCode

public int hashCode()

Override of hashCode method.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode

equals

public boolean equals(java.lang.Object o)

See if o is equal to this.

Overrides:

equals in class java.lang.Object

Parameters:

o - object in question

Returns:

true if o is a DataAlias and they have the same name.

setName

public void setName(java.lang.String value)

Set the name of this DataAlias

Parameters:

value - new name.

getName

public java.lang.String getName()

Get the name of this DataAlias

Returns:

name of this.

setLabel

public void setLabel(java.lang.String value)

Set the label of this DataAlias

Parameters:

value - new label.

getLabel

public java.lang.String getLabel()

Get the label of this DataAlias

Returns:

label.

getAliases

public java.util.List getAliases()

Get aliases for the name of this DataAlias

Returns:

List of names.

createDataAliases

public static java.util.List createDataAliases(org.w3c.dom.Element root)

Process the given xml and return a list of DataAlias objects defined within the xml.

Parameters:

root - root element of the XML

Returns:

A list of DataAlias objects

compareTo

public int compareTo(java.lang.Object o)

_more_

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

o - _more_

Returns:

_more_

reInit

public static void reInit(XmlResourceCollection resources)

Reinitialize the data structures and reprocess the xml. This is called by the AliasEditor when aliases have been changed.

Parameters:

resources - collection of XML resources

init

public static void init(XmlResourceCollection resources)

Initialize the DataAlias-es with the given collection of xml resources, XmlResourceCollection

Parameters:

resources - collection of XML resources

getDataAliasList

public static java.util.List getDataAliasList()

Return the list of canonical names (String-s)

Returns:

List of names

getLabelIdList

public static java.util.List getLabelIdList()

Return the list of name/label pairs (TwoFacedObject-s)

Returns:

List of names

aliasToCanonical

public static java.lang.String aliasToCanonical(java.lang.String paramName)

Return the canonical name for the given alias.

Parameters:

paramName - alias to look for

Returns:

name of DataAlias corresponding to name or null if no match is found.

getAliasesOf

public static java.util.List getAliasesOf(java.lang.String paramName)

Return the list of aliases (Strings) for the given canonical.

Parameters:

paramName - canonical name (name) to look for

Returns:

List of aliases for the canonical name.

findAlias

public static DataAlias findAlias(java.lang.String paramName)

Return the DataAlias object the given canonical name.

Parameters:

paramName - alias to look for

Returns:

The DataAlias corresponding to name or null if no match is found.

toString

public java.lang.String toString()

Returns a string representation of this DataAlias.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the DataAlias.