oracle.dss.selection.step
Class MeasValRangeStep

java.lang.Object
  |
  +--oracle.dss.selection.step.Step
        |
        +--oracle.dss.selection.step.ConditionStep
              |
              +--oracle.dss.selection.step.MeasConditionStep
                    |
                    +--oracle.dss.selection.step.MeasValRangeStep

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable, VectorClone

public class MeasValRangeStep

extends MeasConditionStep

Represents a step in a selection that specifies members of a particular dimension by comparing data values in a particular measure with a specified range of values. For example, it might specify members based on Sales between $10,000 and $20,000.

See Also:

Serialized Form

Field Summary

static int	OP_BETWEEN The between operator.
static int	OP_OUTSIDE The outside operator.
static java.lang.String	STEP_STATE State Management support

Fields inherited from class oracle.dss.selection.step.Step

ADD, BASE_STATE_INDEX, CURRENT_STATE_INDEX, KEEP, LONG, MEDIUM, REMOVE, SELECT, SHORT

Constructor Summary

MeasValRangeStep()
Constructor that does not specify any arguments.

MeasValRangeStep(java.lang.String dimensionName)
Constructor that specifies a dimension.

MeasValRangeStep(java.lang.String dimensionName, java.lang.String measureName, int cmpOperator, java.lang.Object startValue, java.lang.Object endValue)
Constructor that specifies all arguments except a hierarchy and levels.

MeasValRangeStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.String measureName, int cmpOperator, java.lang.Object startValue, java.lang.Object endValue)
Constructor that specifies all arguments.

Method Summary

void	copyFrom(Step step) Copies all fields from the specified Step object.
boolean	equals(java.lang.Object obj) Indicates whether one Step object is equivalent to another Step object.
int	getCmpOperator() Retrieves the comparison operator for this MeasValRangeStep object.
java.lang.Class	getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this MeasValRangeStep object.
java.lang.Object	getRangeEndValue() Retrieves the upper value of the range of data values to compare with the values of the specified measure in this MeasValRangeStep object.
java.lang.Object	getRangeStartValue() Retrieves the lower value of the range of data values to compare with the values of the specified measure in this MeasValRangeStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this MeasValRangeStep object.
void	setCmpOperator(int newCmpOperator) Specifies the comparison operator for this MeasValRangeStep object.
void	setRangeEndValue(java.lang.Object newEndValue) Specifies the upper value of the range of data values to compare with the values of the specified measure in this MeasValRangeStep object.
void	setRangeStartValue(java.lang.Object newStartValue) Specifies the lower value of the range of data values to compare with the values of the specified measure in this MeasValRangeStep object.
java.lang.String	toString() Generates the string representation of this MeasValRangeStep object.

Methods inherited from class oracle.dss.selection.step.MeasConditionStep

getMeasure, setMeasure

Methods inherited from class oracle.dss.selection.step.ConditionStep

clone, getLevels, setLevels

Methods inherited from class oracle.dss.selection.step.Step

addPropertyChangeListener, getAction, getDescription, getDimension, getDispQDR, getHierarchy, getQDR, getQDRDescription, isEnabled, isValid, removePropertyChangeListener, setAction, setDescription, setDimension, setDispQDR, setEnabled, setHierarchy, setQDR, setQDRDescription, setValid

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OP_BETWEEN

public static final int OP_BETWEEN

The between operator.

OP_OUTSIDE

public static final int OP_OUTSIDE

The outside operator.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

MeasValRangeStep

public MeasValRangeStep()

Constructor that does not specify any arguments.

MeasValRangeStep

public MeasValRangeStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

MeasValRangeStep

public MeasValRangeStep(java.lang.String dimensionName,
                        java.lang.String measureName,
                        int cmpOperator,
                        java.lang.Object startValue,
                        java.lang.Object endValue)
                 throws InvalidStepArgException

Constructor that specifies all arguments except a hierarchy and levels.

Parameters:

dimensionName - The name of the dimension.

measureName - The name of the measure.

cmpOperator - A constant that represents the comparison operator. The valid constants are OP_BETWEEN and OP_OUTSIDE.

startValue - A number that represents the lower value of the range of data values to compare with the values of the specified measure.

endValue - A number that represents the upper value of the range of data values to compare with the values of the specified measure.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

OP_BETWEEN, OP_OUTSIDE

MeasValRangeStep

public MeasValRangeStep(java.lang.String dimensionName,
                        java.lang.String hierarchy,
                        java.util.Vector levels,
                        java.lang.String measureName,
                        int cmpOperator,
                        java.lang.Object startValue,
                        java.lang.Object endValue)
                 throws InvalidStepArgException

Constructor that specifies all arguments.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

levels - The vector levels.

measureName - The name of the measure.

cmpOperator - A constant that represents the comparison operator. The valid constants are OP_BETWEEN and OP_OUTSIDE.

startValue - A number that represents the lower value of the range of data values to compare with the values of the specified measure.

endValue - A number that represents the upper value of the range of data values to compare with the values of the specified measure.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

OP_BETWEEN, OP_OUTSIDE

Method Detail

equals

public boolean equals(java.lang.Object obj)

Indicates whether one Step object is equivalent to another Step object.

Overrides:

equals in class MeasConditionStep

Parameters:

obj - The Step object with which to compare.

Returns:

true if the objects are completely equal; false if they are not.

copyFrom

public void copyFrom(Step step)

Copies all fields from the specified Step object.

Overrides:

copyFrom in class MeasConditionStep

Parameters:

step - The Step object from which to copy the fields.

toString

public java.lang.String toString()

Generates the string representation of this MeasValRangeStep object.

Overrides:

toString in class MeasConditionStep

Returns:

The string representation of this MeasValRangeStep object.

setCmpOperator

public void setCmpOperator(int newCmpOperator)
                    throws InvalidStepArgException

Specifies the comparison operator for this MeasValRangeStep object.

Parameters:

newCmpOperator - A constant that represents the comparison operator. The valid constants are OP_BETWEEN and OP_OUTSIDE.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

OP_BETWEEN, OP_OUTSIDE

getCmpOperator

public int getCmpOperator()

Retrieves the comparison operator for this MeasValRangeStep object.

Returns:

A constant that represents the comparison operator. The valid constants are OP_BETWEEN and OP_OUTSIDE.

See Also:

OP_BETWEEN, OP_OUTSIDE

setRangeStartValue

public void setRangeStartValue(java.lang.Object newStartValue)

Specifies the lower value of the range of data values to compare with the values of the specified measure in this MeasValRangeStep object.

Parameters:

newStartValue - A number that represents the lower value of the range of data values.

getRangeStartValue

public java.lang.Object getRangeStartValue()

Retrieves the lower value of the range of data values to compare with the values of the specified measure in this MeasValRangeStep object.

Returns:

A number that represents the lower value of the range of data values.

setRangeEndValue

public void setRangeEndValue(java.lang.Object newEndValue)

Specifies the upper value of the range of data values to compare with the values of the specified measure in this MeasValRangeStep object.

Parameters:

newEndValue - A number that represents the upper value of the range of data values.

getRangeEndValue

public java.lang.Object getRangeEndValue()

Retrieves the upper value of the range of data values to compare with the values of the specified measure in this MeasValRangeStep object.

Returns:

A number that represents the upper value of the range of data values.

getViewClassName

public java.lang.String getViewClassName()

Retrieves the name of the StepView class to use to edit this MeasValRangeStep object. If the name is null, retrieves the base StepView class. Overrides the same method in the base Step class.

Overrides:

getViewClassName in class Step

Returns:

The name of the StepView class.

getEvaluatorClass

public java.lang.Class getEvaluatorClass()
                                  throws SelectionException

Retrieves the StepEvaluator class object that is associated with this MeasValRangeStep object. The QueryServer object uses this class to instantiate the appropriate StepEvaluator object.

Overrides:

getEvaluatorClass in class Step

Returns:

The Class object.

Throws:

SelectionException - If the StepEvaluator class is not found.