oracle.dss.selection.step
Class RangeTimeStep

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

All Implemented Interfaces:

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

public class RangeTimeStep

extends ConditionStep

Represents a step in a selection that specifies the members of a particular dimension based on a range of time. For example, this step might specify the members based on the four quarters before January of 2000.

See Also:

Serialized Form

Field Summary

static int	AFTER The after operator.
static int	BEFORE The before operator.
static int	END_WITH The end-with operator.
static int	START_WITH The start-with 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

RangeTimeStep()
Constructor that does not specify any arguments.

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

RangeTimeStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.Integer numValues, int opType, java.lang.String refValue)
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 RangeTimeStep object.
java.lang.Integer	getNumValues() Retrieves the number of values that this RangeTimeStep object specifies.
int	getOperatorType() Retrieves the operator for this RangeTimeStep object.
java.lang.String	getRefValue() Retrieves the value from which the range for this RangeTimeStep object is based.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this RangeTimeStep object.
void	setNumValues(java.lang.Integer newNumValues) Specifies the number of values that this RangeTimeStep object specifies.
void	setOperatorType(int opType) Specifies the operator for this RangeTimeStep object.
void	setRefValue(java.lang.String newRefValue) Specifies the value from which the range for this RangeTimeStep object is based.
java.lang.String	toString() Generates the string representation of this RangeTimeStep object.

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

START_WITH

public static final int START_WITH

The start-with operator.

END_WITH

public static final int END_WITH

The end-with operator.

BEFORE

public static final int BEFORE

The before operator.

AFTER

public static final int AFTER

The after operator.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

RangeTimeStep

public RangeTimeStep()

Constructor that does not specify any arguments.

RangeTimeStep

public RangeTimeStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

RangeTimeStep

public RangeTimeStep(java.lang.String dimensionName,
                     java.lang.String hierarchy,
                     java.util.Vector levels,
                     java.lang.Integer numValues,
                     int opType,
                     java.lang.String refValue)
              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.

numValues - The number of values that this RangeTimeStep object specifies.

opType - A constant that represents the operator. The valid contants are listed in the See Also section.

refValue - The value from which the range is based.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

AFTER, BEFORE, END_WITH, START_WITH

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 ConditionStep

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 ConditionStep

Parameters:

step - The Step object from which to copy fields.

toString

public java.lang.String toString()

Generates the string representation of this RangeTimeStep object.

Overrides:

toString in class ConditionStep

Returns:

The string representation of this RangeTimeStep object.

getNumValues

public java.lang.Integer getNumValues()

Retrieves the number of values that this RangeTimeStep object specifies.

Returns:

The number of values that this RangeTimeStep object specifies.

setNumValues

public void setNumValues(java.lang.Integer newNumValues)

Specifies the number of values that this RangeTimeStep object specifies.

Parameters:

newNumValues - The number of values that this RangeTimeStep object specifies.

getOperatorType

public int getOperatorType()

Retrieves the operator for this RangeTimeStep object.

Returns:

A constant that represents the operator. The valid contants are listed in the See Also section.

See Also:

AFTER, BEFORE, END_WITH, START_WITH

setOperatorType

public void setOperatorType(int opType)
                     throws InvalidStepArgException

Specifies the operator for this RangeTimeStep object.

Parameters:

opType - A constant that represents the operator. The valid contants are listed in the See Also section.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

AFTER, BEFORE, END_WITH, START_WITH

getRefValue

public java.lang.String getRefValue()

Retrieves the value from which the range for this RangeTimeStep object is based.

Returns:

The value from which the range is based.

setRefValue

public void setRefValue(java.lang.String newRefValue)

Specifies the value from which the range for this RangeTimeStep object is based.

Parameters:

newRefValue - The value from which the range is based.

getViewClassName

public java.lang.String getViewClassName()

Retrieves the name of the StepView class to use to edit this RangeTimeStep object. If the name is null, then 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 RangeTimeStep 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.