mondrian.calc.impl
Class AbstractTupleListCalc

java.lang.Object
  extended by mondrian.calc.impl.AbstractCalc
      extended by mondrian.calc.impl.AbstractTupleListCalc
All Implemented Interfaces:
Calc, ListCalc, TupleListCalc
Direct Known Subclasses:
IterableTupleListCalc, NativizeSetFunDef.NativeTupleListCalc, SetFunDef.TupleSetListCalc

public abstract class AbstractTupleListCalc
extends AbstractCalc
implements TupleListCalc

Abstract implementation of the ListCalc interface for expressions that return a list of tuples but never a list of members.

The derived class must implement the TupleListCalc.evaluateTupleList(mondrian.olap.Evaluator) method, and the evaluate(mondrian.olap.Evaluator) method will call it.

Since:
Oct 24, 2008
Version:
$Id: //open/mondrian/src/main/mondrian/calc/impl/AbstractTupleListCalc.java#4 $
Author:
jhyde
See Also:
AbstractListCalc

Field Summary
 
Fields inherited from class mondrian.calc.impl.AbstractCalc
exp, type
 
Constructor Summary
protected AbstractTupleListCalc(Exp exp, Calc[] calcs)
          Creates an abstract implementation of a compiled expression which returns a mutable list of tuples.
protected AbstractTupleListCalc(Exp exp, Calc[] calcs, boolean mutable)
          Creates an abstract implementation of a compiled expression which returns a list.
 
Method Summary
 Object evaluate(Evaluator evaluator)
          Evaluates this expression.
 List<Member[]> evaluateList(Evaluator evaluator)
          Evaluates an expression to yield a list of members or tuples.
 ResultStyle getResultStyle()
          Returns style in which the result of evaluating this expression is returned.
 SetType getType()
          Returns the type of this expression.
 String toString()
           
 
Methods inherited from class mondrian.calc.impl.AbstractCalc
accept, anyDepends, anyDependsButFirst, butDepends, dependsOn, getArguments, getCalcs, getName, simplifyEvaluator
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface mondrian.calc.TupleListCalc
evaluateTupleList
 
Methods inherited from interface mondrian.calc.Calc
accept, dependsOn
 

Constructor Detail

AbstractTupleListCalc

protected AbstractTupleListCalc(Exp exp,
                                Calc[] calcs)
Creates an abstract implementation of a compiled expression which returns a mutable list of tuples.

Parameters:
exp - Expression which was compiled
calcs - List of child compiled expressions (for dependency analysis)

AbstractTupleListCalc

protected AbstractTupleListCalc(Exp exp,
                                Calc[] calcs,
                                boolean mutable)
Creates an abstract implementation of a compiled expression which returns a list.

Parameters:
exp - Expression which was compiled
calcs - List of child compiled expressions (for dependency analysis)
mutable - Whether the list is mutable
Method Detail

getType

public SetType getType()
Description copied from interface: Calc
Returns the type of this expression.

Specified by:
getType in interface Calc
Overrides:
getType in class AbstractCalc

evaluate

public final Object evaluate(Evaluator evaluator)
Description copied from interface: Calc
Evaluates this expression.

Specified by:
evaluate in interface Calc
Parameters:
evaluator - Provides dimensional context in which to evaluate this expression
Returns:
Result of expression evaluation

getResultStyle

public ResultStyle getResultStyle()
Description copied from interface: Calc
Returns style in which the result of evaluating this expression is returned.

One application of this method is for the compiler to figure out whether the compiled expression is returning a mutable list. If a mutable list is required, the compiler can create a mutable copy.

Specified by:
getResultStyle in interface Calc
Overrides:
getResultStyle in class AbstractCalc
See Also:
ExpCompiler.compileList(mondrian.olap.Exp, boolean)

toString

public String toString()
Overrides:
toString in class Object

evaluateList

public final List<Member[]> evaluateList(Evaluator evaluator)
Description copied from interface: ListCalc
Evaluates an expression to yield a list of members or tuples.

The list is immutable if Calc.getResultStyle() yields ResultStyle.MUTABLE_LIST. Otherwise, the caller must not modify the list.

Specified by:
evaluateList in interface ListCalc
Parameters:
evaluator - Evaluation context
Returns:
A list of members or tuples, never null.

Get Mondrian at SourceForge.net. Fast, secure and free Open Source software downloads