mondrian.calc

Interface ParameterSlot

public interface ParameterSlot

Implementation of a parameter.

Since:

Jul 25, 2006

Author:

jhyde

Method Summary

Methods

Modifier and Type	Method and Description
Object	getCachedDefaultValue()
Calc	getDefaultValueCalc() Returns a compiled expression to compute the default value of the parameter.
int	getIndex() Returns the unique index of the slot.
Parameter	getParameter() Returns the parameter.
Object	getParameterValue() Returns the value of this parameter.
boolean	isParameterSet() Returns whether the parameter has been assigned a value.
void	setCachedDefaultValue(Object value)
void	setParameterValue(Object value, boolean assigned) Sets the value of this parameter.
void	unsetParameterValue() Unsets the parameter value.

Method Detail

getIndex

int getIndex()

Returns the unique index of the slot.

getDefaultValueCalc

Calc getDefaultValueCalc()

Returns a compiled expression to compute the default value of the parameter.

getParameter

Parameter getParameter()

Returns the parameter.

setParameterValue

void setParameterValue(Object value,
                     boolean assigned)

Sets the value of this parameter.

NOTE: This method will be removed when we store parameter values in the Result rather than in the Query.

Parameters:

value - New value

assigned - Whether isParameterSet() should return true; supply value false if this is an internal assignment, to remember the default value

getParameterValue

Object getParameterValue()

Returns the value of this parameter.

NOTE: This method will be removed when we store parameter values in the Result rather than in the Query.

isParameterSet

boolean isParameterSet()

Returns whether the parameter has been assigned a value. (That value may be null.)

Returns:

Whether parmaeter has been assigned a value.

setCachedDefaultValue

void setCachedDefaultValue(Object value)

getCachedDefaultValue

Object getCachedDefaultValue()

unsetParameterValue

void unsetParameterValue()

Unsets the parameter value.