oracle.dss.selection.step
Class MeasValStep

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

All Implemented Interfaces:

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

public class MeasValStep

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 value. For example, it might specify all Cities whose total dollar Sales for a particular Product exceeded $5,000,000 during the previous year.

See Also:

Serialized Form

Field Summary

static int	OP_EQUAL The equal to operator.
static int	OP_GREATER The greater than operator.
static int	OP_GREATER_EQUAL The greater than or equal to operator.
static int	OP_LESS The less than operator.
static int	OP_LESS_EQUAL The less than or equal to operator.
static int	OP_NOT_EQUAL The not equal to 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

MeasValStep()
Constructor that does not specify any arguments.

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

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

MeasValStep(java.lang.String dimensionName, java.lang.String measureName, java.lang.String hierarchy, java.util.Vector levels, int cmpOperator, java.lang.Object cmpValue)
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 MeasValStep object.
java.lang.Object	getCmpValue() Retrieves the data value to compare with the values of the specified measure in this MeasValStep object.
java.lang.Class	getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this MeasValStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this MeasValStep object.
void	setCmpOperator(int newCmpOperator) Specifies the comparison operator for this MeasValStep object.
void	setCmpValue(java.lang.Object newCmpValue) Specifies the data value to compare with the values of the specified measure in this MeasValStep object.
java.lang.String	toString() Generates the string representation of this MeasValStep 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_GREATER

public static final int OP_GREATER

The greater than operator.

OP_LESS

public static final int OP_LESS

The less than operator.

OP_GREATER_EQUAL

public static final int OP_GREATER_EQUAL

The greater than or equal to operator.

OP_LESS_EQUAL

public static final int OP_LESS_EQUAL

The less than or equal to operator.

OP_EQUAL

public static final int OP_EQUAL

The equal to operator.

OP_NOT_EQUAL

public static final int OP_NOT_EQUAL

The not equal to operator.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

MeasValStep

public MeasValStep()

Constructor that does not specify any arguments.

MeasValStep

public MeasValStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

MeasValStep

public MeasValStep(java.lang.String dimensionName,
                   java.lang.String measureName,
                   int cmpOperator,
                   java.lang.Object cmpValue)
            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_EQUAL
• OP_GREATER
• OP_GREATER_EQUAL
• OP_LESS
• OP_LESS_EQUAL
• OP_NOT_EQUAL

cmpValue - The data value to compare with the values of the specified measure.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

OP_EQUAL, OP_GREATER, OP_GREATER_EQUAL, OP_LESS, OP_LESS_EQUAL, OP_NOT_EQUAL

MeasValStep

public MeasValStep(java.lang.String dimensionName,
                   java.lang.String measureName,
                   java.lang.String hierarchy,
                   java.util.Vector levels,
                   int cmpOperator,
                   java.lang.Object cmpValue)
            throws InvalidStepArgException

Constructor that specifies all arguments.

Parameters:

dimensionName - The name of the dimension.

measureName - The name of the measure.

hierarchy - The name of the hierarchy.

levels - The vector of levels.

cmpOperator - A constant that represents the comparison operator. The valid constants are:

• OP_EQUAL
• OP_GREATER
• OP_GREATER_EQUAL
• OP_LESS
• OP_LESS_EQUAL
• OP_NOT_EQUAL

cmpValue - The data value to compare with the values of the specified measure.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

OP_EQUAL, OP_GREATER, OP_GREATER_EQUAL, OP_LESS, OP_LESS_EQUAL, OP_NOT_EQUAL

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 MeasValStep object.

Overrides:

toString in class MeasConditionStep

Returns:

The string representation of this MeasValStep object.

setCmpOperator

public void setCmpOperator(int newCmpOperator)
                    throws InvalidStepArgException

Specifies the comparison operator for this MeasValStep object.

Parameters:

newCmpOperator - A constant that represents the comparison operator. The valid constants are:

• OP_EQUAL
• OP_GREATER
• OP_GREATER_EQUAL
• OP_LESS
• OP_LESS_EQUAL
• OP_NOT_EQUAL

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

OP_EQUAL, OP_GREATER, OP_GREATER_EQUAL, OP_LESS, OP_LESS_EQUAL, OP_NOT_EQUAL

getCmpOperator

public int getCmpOperator()

Retrieves the comparison operator for this MeasValStep object.

Returns:

A constant that represents the comparison operator. The valid constants are:

• OP_EQUAL
• OP_GREATER
• OP_GREATER_EQUAL
• OP_LESS
• OP_LESS_EQUAL
• OP_NOT_EQUAL

See Also:

OP_EQUAL, OP_GREATER, OP_GREATER_EQUAL, OP_LESS, OP_LESS_EQUAL, OP_NOT_EQUAL

setCmpValue

public void setCmpValue(java.lang.Object newCmpValue)

Specifies the data value to compare with the values of the specified measure in this MeasValStep object.

Parameters:

newCmpValue - The data value to compare with the values of the specified measure.

getCmpValue

public java.lang.Object getCmpValue()

Retrieves the data value to compare with the values of the specified measure in this MeasValStep object.

Returns:

The data value to compare with the values of the specified measure.

getViewClassName

public java.lang.String getViewClassName()

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