oracle.dss.selection.step
Class TwoMeasNumRangeStep

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

All Implemented Interfaces:

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

public class TwoMeasNumRangeStep

extends TwoMeasConditionStep

Represents a step in a selection that specifies members of a particular dimension based on the way that data values in one measure compare with a range of data values of a second measure. For example, it might specify members based on Sales within 10% of Costs.

See Also:

Serialized Form

Field Summary

static int	OP_OUTSIDE The outside operator.
static int	OP_WITHIN The within 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

TwoMeasNumRangeStep()
Constructor that does not specify any arguments.

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

TwoMeasNumRangeStep(java.lang.String dimensionName, java.lang.String firstMeasure, java.lang.String secondMeasure, int rangeOperator, java.lang.Float offsetNum, boolean isPercent)
Constructor that specifies all arguments except a hierarchy and levels.

TwoMeasNumRangeStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.String firstMeasure, java.lang.String secondMeasure, int rangeOperator, java.lang.Float offsetNum, boolean isPercent)
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.
java.lang.Class	getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this TwoMeasNumRangeStep object.
java.lang.Float	getOffsetNum() Retrieves the offset number, which represents the number to use to determine the range of data values for the comparison in this TwoMeasNumRangeStep object.
int	getRangeOperator() Retrieves the comparison operator for this TwoMeasNumRangeStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this TwoMeasNumRangeStep object.
boolean	isPercent() Indicates whether the offset number is a percentage.
void	setOffsetNum(java.lang.Float newOffsetNum) Specifies the offset number, which represents the number to use to determine the range of data values for the comparison in this TwoMeasNumRangeStep object.
void	setPercent(boolean isPercent) Specifies whether the offset number is a percentage.
void	setRangeOperator(int newRangeOperator) Specifies the comparison operator for this TwoMeasNumRangeStep object.
java.lang.String	toString() Generates the string representation of this TwoMeasNumRangeStep object.

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

clone, getCmpMeasure, getComparisonQDR, setCmpMeasure, setComparisonQDR

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

getMeasure, setMeasure

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

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_WITHIN

public static final int OP_WITHIN

The within 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

TwoMeasNumRangeStep

public TwoMeasNumRangeStep()

Constructor that does not specify any arguments.

TwoMeasNumRangeStep

public TwoMeasNumRangeStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

TwoMeasNumRangeStep

public TwoMeasNumRangeStep(java.lang.String dimensionName,
                           java.lang.String firstMeasure,
                           java.lang.String secondMeasure,
                           int rangeOperator,
                           java.lang.Float offsetNum,
                           boolean isPercent)
                    throws InvalidStepArgException

Constructor that specifies all arguments except a hierarchy and levels.

Parameters:

dimensionName - The name of the dimension.

firstMeasure - The name of the first measure.

secondMeasure - The name of the second measure.

rangeOperator - A constant that represents the comparison operator. The valid constants are OP_WITHIN and OP_OUTSIDE.

offsetNum - The offset number, which represents the number to use to determine the range of data values for the comparison.

isPercent - true if the offset number is a percentage; false if it is not.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

OP_WITHIN, OP_OUTSIDE

TwoMeasNumRangeStep

public TwoMeasNumRangeStep(java.lang.String dimensionName,
                           java.lang.String hierarchy,
                           java.util.Vector levels,
                           java.lang.String firstMeasure,
                           java.lang.String secondMeasure,
                           int rangeOperator,
                           java.lang.Float offsetNum,
                           boolean isPercent)
                    throws InvalidStepArgException

Constructor that specifies all arguments.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

levels - The vector of levels.

firstMeasure - The name of the first measure.

secondMeasure - The name of the second measure.

rangeOperator - A constant that represents the comparison operator. The valid constants are OP_WITHIN and OP_OUTSIDE.

offsetNum - The offset number, which represents the number to use to determine the range of data values for the comparison.

isPercent - true if the offset number is a percentage; false if it is not.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

OP_WITHIN, 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 TwoMeasConditionStep

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 TwoMeasConditionStep

Parameters:

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

toString

public java.lang.String toString()

Generates the string representation of this TwoMeasNumRangeStep object.

Overrides:

toString in class MeasConditionStep

Returns:

The string representation of this TwoMeasNumRangeStep object.

setRangeOperator

public void setRangeOperator(int newRangeOperator)
                      throws InvalidStepArgException

Specifies the comparison operator for this TwoMeasNumRangeStep object.

Parameters:

newRangeOperator - A constant that represents the comparison operator. The valid constants are OP_WITHIN and OP_OUTSIDE.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

OP_WITHIN, OP_OUTSIDE

getRangeOperator

public int getRangeOperator()

Retrieves the comparison operator for this TwoMeasNumRangeStep object.

Returns:

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

See Also:

OP_WITHIN, OP_OUTSIDE

setOffsetNum

public void setOffsetNum(java.lang.Float newOffsetNum)

Specifies the offset number, which represents the number to use to determine the range of data values for the comparison in this TwoMeasNumRangeStep object.

Parameters:

newOffsetNum - The offset number.

getOffsetNum

public java.lang.Float getOffsetNum()

Retrieves the offset number, which represents the number to use to determine the range of data values for the comparison in this TwoMeasNumRangeStep object.

Returns:

The offset number.

setPercent

public void setPercent(boolean isPercent)

Specifies whether the offset number is a percentage.

Parameters:

isPercent - true if the offset number is a percentage; false if it is not.

isPercent

public boolean isPercent()

Indicates whether the offset number is a percentage.

Returns:

true if the offset number is a percentage; false if it is not.

getViewClassName

public java.lang.String getViewClassName()

Retrieves the name of the StepView class to use to edit this TwoMeasNumRangeStep 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 TwoMeasNumRangeStep 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.