mondrian.olap
Interface Parameter

All Known Subinterfaces:

ParameterCompilable

All Known Implementing Classes:

ParameterImpl, RolapSchemaParameter

public interface Parameter

Parameter to a Query.

A parameter is not an expression; see ParameterExpr.

Since:

Jul 22, 2006

Version:

$Id: //open/mondrian-release/3.0/src/main/mondrian/olap/Parameter.java#2 $

Author:

jhyde

Nested Class Summary

static class

Parameter.Scope Scope where a parameter is defined.

Method Summary

Exp	getDefaultExp() Returns the expression which provides the default value for this Parameter.
String	getDescription() Returns the description of this Parameter.
String	getName() Returns the name of this Parameter.
Parameter.Scope	getScope() Returns the scope where this parmater is defined.
Type	getType() Returns the type of this Parameter.
Object	getValue() Returns the value of this parameter.
boolean	isModifiable() Returns whether the value of this Parameter can be modified in a query.
void	setValue(Object value) Sets the value of this parameter.

Method Detail

getScope

Parameter.Scope getScope()

Returns the scope where this parmater is defined.

getType

Type getType()

Returns the type of this Parameter.

getDefaultExp

Exp getDefaultExp()

Returns the expression which provides the default value for this Parameter. Never null.

getName

String getName()

Returns the name of this Parameter.

getDescription

String getDescription()

Returns the description of this Parameter.

isModifiable

boolean isModifiable()

Returns whether the value of this Parameter can be modified in a query.

getValue

Object getValue()

Returns the value of this parameter. If setValue(Object) has not been called, and the parameter still has its default value, returns null.

The type of the value is (depending on the type of the parameter) a String, Number, or Member.

setValue

void setValue(Object value)

Sets the value of this parameter.

Parameters:

value - Value of the parameter; must be a String, a Double, or a Member