gov.nasa.gsfc.spdf.cdas

Class VariableDescription

java.lang.Object

gov.nasa.gsfc.spdf.cdas.VariableDescription

All Implemented Interfaces:

java.lang.Cloneable

public class VariableDescription
extends java.lang.Object
implements java.lang.Cloneable

This class represents the description of a Coordinated Data Analysis System dataset variable.

Author:

B. Harris

Constructor Summary

Constructors

Constructor and Description
VariableDescription() Constructs a VariableDescription with a null value.
VariableDescription(java.lang.String name, java.lang.String shortDescription, java.lang.String longDescription) Constructs a VariableDescription with the given attribute values.
VariableDescription(java.lang.String name, java.lang.String shortDescription, java.lang.String longDescription, java.lang.String parent, java.util.List<java.lang.String> children) Constructs a VariableDescription with the given attribute values.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates and returns a copy of this object.
java.util.List	getChildren() Gets the names of child variables.
java.lang.String	getLongDescription() Gets the long description of the variable.
java.lang.String	getName() Gets the variable's name.
java.lang.String	getParent() Gets the variable's parent.
java.lang.String	getShortDescription() Gets the short description of the variable.
void	setChildren(java.util.List<java.lang.String> value) Sets the names of child variables.
void	setLongDescription(java.lang.String value) Sets the variable's long description.
void	setName(java.lang.String name) Sets the variable's name.
void	setParent(java.lang.String value) Sets the variable's parent.
void	setShortDescription(java.lang.String value) Sets the variable's short description.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableDescription

public VariableDescription()

Constructs a VariableDescription with a null value.

VariableDescription

public VariableDescription(java.lang.String name,
                           java.lang.String shortDescription,
                           java.lang.String longDescription)

Constructs a VariableDescription with the given attribute values.

Parameters:

name - identifies the variable

shortDescription - a short description of the variable

longDescription - a long description of the variable

VariableDescription

public VariableDescription(java.lang.String name,
                           java.lang.String shortDescription,
                           java.lang.String longDescription,
                           java.lang.String parent,
                           java.util.List<java.lang.String> children)

Constructs a VariableDescription with the given attribute values.

Parameters:

name - identifies the variable

shortDescription - a short description of the variable

longDescription - a long description of the variable

parent - name of parent variable

children - names of child variables

Method Detail

getName

public java.lang.String getName()

Gets the variable's name.

Returns:

name of variable

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String name)

Sets the variable's name.

Parameters:

name - new name

See Also:

getName()

getShortDescription

public java.lang.String getShortDescription()

Gets the short description of the variable.

Returns:

description of variable

See Also:

setShortDescription(java.lang.String)

setShortDescription

public void setShortDescription(java.lang.String value)

Sets the variable's short description.

Parameters:

value - new description

See Also:

getShortDescription()

getLongDescription

public java.lang.String getLongDescription()

Gets the long description of the variable.

Returns:

description of variable

See Also:

setLongDescription(java.lang.String)

setLongDescription

public void setLongDescription(java.lang.String value)

Sets the variable's long description.

Parameters:

value - new description

See Also:

getLongDescription()

getParent

public java.lang.String getParent()

Gets the variable's parent.

Returns:

name of parent variable

See Also:

setParent(java.lang.String)

setParent

public void setParent(java.lang.String value)

Sets the variable's parent.

Parameters:

value - new parent name

See Also:

getParent()

getChildren

public java.util.List getChildren()

Gets the names of child variables. This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the VariableDescription object.

Returns:

names of child variables

See Also:

setChildren(java.util.List<java.lang.String>)

setChildren

public void setChildren(java.util.List<java.lang.String> value)

Sets the names of child variables.

Parameters:

value - new list of child variable names

See Also:

getChildren()

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.

See Also:

Object.clone()