oracle.olapi.data.source
Class BooleanParameter

java.lang.Object
  oracle.olapi.data.source.Parameter
      oracle.olapi.data.source.BooleanParameter

public class BooleanParameter
extends Parameter

A Parameter that specifies a boolean value that you use in creating a query. After creating the query, you can change the value of the BooleanParameter and thereby change the selection of dimension or measure elements that the query represents.

The createSource method creates a parameterized BooleanSource. You use the parameterized BooleanSource as a parameter to a method that selects one or more elements of another Source and produces a derived Source. You can then create a Cursor for the Source to retrieve the results of the query.

You can change the selection of elements that the derived Source represents by changing the value of the BooleanParameter with a setValue method. The Cursor for the query Source then has the values of the new selection. You do not need to create a new Cursor. You can instead just set the position of the existing Cursor to its first position and get the values for the new selection from the Cursor.

Constructor Summary

BooleanParameter(DataProvider dataProvider, boolean initialValue)
Creates a BooleanParameter that has the specified boolean value.

BooleanParameter(DataProvider dataProvider, java.lang.Boolean initialValue)
Creates a BooleanParameter that has the specified Boolean value.

Method Summary

java.lang.Object	acceptVisitor(ParameterVisitor visitor, java.lang.Object context) Calls the visitBooleanParameter method of the specified ParameterVisitor and passes that method this BooleanParameter and the specified context Object.
java.lang.Boolean	getValue() Gets the value of this BooleanParameter.
java.lang.Object	getValueObject() Gets the value of this BooleanParameter as an Object.
void	setValue(boolean value) Sets the value of this BooleanParameter to the specified boolean.
void	setValue(java.lang.Boolean value) Sets the value of this BooleanParameter to the specified Boolean.

Methods inherited from class oracle.olapi.data.source.Parameter

createSource, getDataProvider, getID

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanParameter

public BooleanParameter(DataProvider dataProvider,
                        java.lang.Boolean initialValue)

Creates a BooleanParameter that has the specified Boolean value.

Parameters:

dataProvider - The DataProvider that you are using.

initialValue - The Boolean value that you want this StringParameter to have.

BooleanParameter

public BooleanParameter(DataProvider dataProvider,
                        boolean initialValue)

Creates a BooleanParameter that has the specified boolean value.

Parameters:

dataProvider - The DataProvider that you are using.

initialValue - The boolean value that you want this StringParameter to have.

Method Detail

acceptVisitor

public final java.lang.Object acceptVisitor(ParameterVisitor visitor,
                                            java.lang.Object context)

Calls the visitBooleanParameter method of the specified ParameterVisitor and passes that method this BooleanParameter and the specified context Object.

Specified by:

acceptVisitor in class Parameter

Parameters:

visitor - An instance a class derived from the ParameterVisitor class.

context - An Object.

Returns:

The Object returned by the visitBooleanParameter method of the specified ParameterVisitor.

getValue

public final java.lang.Boolean getValue()

Gets the value of this BooleanParameter.

Returns:

The value of this BooleanParameter.

getValueObject

public final java.lang.Object getValueObject()

Gets the value of this BooleanParameter as an Object.

Specified by:

getValueObject in class Parameter

Returns:

The value of this BooleanParameter as an Object.

setValue

public final void setValue(java.lang.Boolean value)

Sets the value of this BooleanParameter to the specified Boolean.

Parameters:

value - A Boolean that you want this BooleanParameter to have as its value.

setValue

public final void setValue(boolean value)

Sets the value of this BooleanParameter to the specified boolean.

Parameters:

value - A boolean that you want this BooleanParameter to have as its value.