anl.aida.data
Class DefaultVariable

java.lang.Object
  extended by anl.aida.data.DefaultVariable
All Implemented Interfaces:
Variable

public class DefaultVariable
extends java.lang.Object
implements Variable

class that stores metadata on a variable in a dataset

Version:
$Revision$ $Date$
See Also:
DefaultVariable

Field Summary
protected  Dataset dataset
           
protected  java.lang.String description
           
protected  java.lang.String fullName
           
protected  java.lang.String name
           
protected  javax.measure.unit.Unit<?> unit
           
 
Constructor Summary
DefaultVariable(java.lang.String name, java.lang.String description, javax.measure.unit.Unit<?> unit, Dataset dataset)
           
 
Method Summary
 Dataset getDataset()
          Gets the dataset in which this variable appears.
 java.lang.String getDescription()
          Get the description of a variable
 java.lang.String getName()
          Get the name of the variable
 javax.measure.unit.Unit<?> getUnit()
          Gets this Variable's standard of measurement.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

unit

protected javax.measure.unit.Unit<?> unit

name

protected java.lang.String name

fullName

protected java.lang.String fullName

description

protected java.lang.String description

dataset

protected Dataset dataset
Constructor Detail

DefaultVariable

public DefaultVariable(java.lang.String name,
                       java.lang.String description,
                       javax.measure.unit.Unit<?> unit,
                       Dataset dataset)
Method Detail

getDataset

public Dataset getDataset()
Gets the dataset in which this variable appears. This may be null if the Variable is a composite composed of multiple datasets.

Specified by:
getDataset in interface Variable
Returns:
the dataset in which this variable appears.

getDescription

public java.lang.String getDescription()
Get the description of a variable

Specified by:
getDescription in interface Variable
Returns:
the description

getName

public java.lang.String getName()
Get the name of the variable

Specified by:
getName in interface Variable
Returns:
the name

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
the variables name plus its unit represention

getUnit

public javax.measure.unit.Unit<?> getUnit()
Gets this Variable's standard of measurement.

Specified by:
getUnit in interface Variable
Returns:
this Variable's standard of measurement.