anl.aida.formula
Class FormulaVariable

java.lang.Object
  extended by anl.aida.formula.FormulaVariable

public class FormulaVariable
extends java.lang.Object

Version:
$Revision$ $Date$

Field Summary
private  java.lang.String alias
           
private  java.lang.String aliasedName
           
private  Dataset dataset
           
private  java.lang.String name
           
private  Range timeStepRange
           
private  Variable variable
           
 
Constructor Summary
private FormulaVariable(java.lang.String name, java.lang.String alias)
           
 
Method Summary
static FormulaVariable createVariable(java.lang.String name, DataManager manager)
           
 DataFrame evaluate()
          Evaluates this FormulaVariable and returns the resulting DataFrame.
 java.lang.String getAliasedName()
           
 Dataset getDataset()
           
 java.lang.String getName()
           
 Range getTimeStepRange()
           
 javax.measure.unit.Unit<?> getUnit()
           
 Variable getVariable()
           
private  void init(DataManager manager)
           
 void setTimeStepRange(Range timeStepRange)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

private java.lang.String name

alias

private java.lang.String alias

aliasedName

private java.lang.String aliasedName

dataset

private Dataset dataset

variable

private Variable variable

timeStepRange

private Range timeStepRange
Constructor Detail

FormulaVariable

private FormulaVariable(java.lang.String name,
                        java.lang.String alias)
Method Detail

createVariable

public static FormulaVariable createVariable(java.lang.String name,
                                             DataManager manager)
                                      throws IllegalFormulaException
Throws:
IllegalFormulaException

getVariable

public Variable getVariable()

init

private void init(DataManager manager)
           throws IllegalFormulaException
Throws:
IllegalFormulaException

getTimeStepRange

public Range getTimeStepRange()

setTimeStepRange

public void setTimeStepRange(Range timeStepRange)

evaluate

public DataFrame evaluate()
Evaluates this FormulaVariable and returns the resulting DataFrame.

Returns:
the data frame that results from formula evaluation

getAliasedName

public java.lang.String getAliasedName()

getName

public java.lang.String getName()

getDataset

public Dataset getDataset()

getUnit

public javax.measure.unit.Unit<?> getUnit()