anl.aida.formula
Interface Formula

All Known Implementing Classes:
DefaultFormula

public interface Formula

Encapsulates a pave style formula and its evaluation.

Version:
$Revision$ $Date$

Method Summary
 DataFrame evaluate(DataManager manager, java.util.List<AxisRange> ranges)
          Evaluates the formula to produce a DataFrame.
 java.lang.String getFormulaAsString()
          Gets the String representation of the formula.
 ValidationResult validate(DataManager manager, java.util.List<AxisRange> ranges)
          Validates the formula.
 

Method Detail

validate

ValidationResult validate(DataManager manager,
                          java.util.List<AxisRange> ranges)
Validates the formula.

Parameters:
manager - the data manager used to validate the formula
ranges - the ranges that constrain the validation
Returns:
a ValidationResult containing the results of the validation.

evaluate

DataFrame evaluate(DataManager manager,
                   java.util.List<AxisRange> ranges)
                   throws IllegalFormulaException
Evaluates the formula to produce a DataFrame.

Parameters:
manager - the DataManager used to help evaluate the formula
ranges - the ranges that constrain the evaluation
Throws:
IllegalFormulaException - if the formula is unable to be executed.

getFormulaAsString

java.lang.String getFormulaAsString()
Gets the String representation of the formula.

Returns:
the String representation of the formula.