mondrian.rolap
Class RolapSchemaParameter

java.lang.Object
  mondrian.rolap.RolapSchemaParameter

All Implemented Interfaces:

ParameterCompilable, Parameter

public class RolapSchemaParameter
extends Object
implements Parameter, ParameterCompilable

Parameter which is defined in a schema.

Since:

Jul 20, 2006

Version:

$Id: //open/mondrian-release/3.0/src/main/mondrian/rolap/RolapSchemaParameter.java#2 $

Author:

jhyde

Constructor Summary

RolapSchemaParameter(RolapSchema schema, String name, String defaultExpString, String description, Type type, boolean modifiable)

Method Summary

Calc	compile(ExpCompiler compiler)
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.
(package private) RolapSchema	getSchema()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RolapSchemaParameter

RolapSchemaParameter(RolapSchema schema,
                     String name,
                     String defaultExpString,
                     String description,
                     Type type,
                     boolean modifiable)

Method Detail

getSchema

RolapSchema getSchema()

isModifiable

public boolean isModifiable()

Description copied from interface: Parameter

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

Specified by:

isModifiable in interface Parameter

getScope

public Parameter.Scope getScope()

Description copied from interface: Parameter

Returns the scope where this parmater is defined.

Specified by:

getScope in interface Parameter

getType

public Type getType()

Description copied from interface: Parameter

Returns the type of this Parameter.

Specified by:

getType in interface Parameter

getDefaultExp

public Exp getDefaultExp()

Description copied from interface: Parameter

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

Specified by:

getDefaultExp in interface Parameter

getName

public String getName()

Description copied from interface: Parameter

Returns the name of this Parameter.

Specified by:

getName in interface Parameter

getDescription

public String getDescription()

Description copied from interface: Parameter

Returns the description of this Parameter.

Specified by:

getDescription in interface Parameter

getValue

public Object getValue()

Description copied from interface: Parameter

Returns the value of this parameter. If Parameter.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.

Specified by:

getValue in interface Parameter

setValue

public void setValue(Object value)

Description copied from interface: Parameter

Sets the value of this parameter.

Specified by:

setValue in interface Parameter

Parameters:

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

compile

public Calc compile(ExpCompiler compiler)

Specified by:

compile in interface ParameterCompilable