oracle.dss.selection.step
Class RangeStep

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

All Implemented Interfaces:

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

public class RangeStep

extends ConditionStep

Represents a step in a selection that specifies members of a particular dimension based on a range of members. For example, it might specify the range of months between January and June of last year.

See Also:

Serialized Form

Field Summary

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

RangeStep()
Constructor that does not specify any arguments.

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

RangeStep(java.lang.String dimensionName, java.lang.String startValue, java.lang.String endValue)
Constructor that specifies all arguments except a hierarchy and levels.

RangeStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.String startValue, java.lang.String 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.
java.lang.String	getRangeEndValue() Retrieves the name of the member that represents the upper value of the range in this RangeStep object.
java.lang.String	getRangeStartValue() Retrieves the name of the member that represents the lower value of the range in this RangeStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this RangeStep object.
void	setRangeEndValue(java.lang.String newEndValue) Specifies the name of the member that represents the upper value of the range in this RangeStep object.
void	setRangeStartValue(java.lang.String newStartValue) Specifies the name of the member that represents the lower value of the range in this RangeStep object.
java.lang.String	toString() Generates the string representation of this RangeStep 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, getEvaluatorClass, 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

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

RangeStep

public RangeStep()

Constructor that does not specify any arguments.

RangeStep

public RangeStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

RangeStep

public RangeStep(java.lang.String dimensionName,
                 java.lang.String startValue,
                 java.lang.String endValue)

Constructor that specifies all arguments except a hierarchy and levels.

Parameters:

dimensionName - The name of the dimension.

startValue - The name of the member that represents the start of the range.

endValue - The name of the member that represents the end of the range.

RangeStep

public RangeStep(java.lang.String dimensionName,
                 java.lang.String hierarchy,
                 java.util.Vector levels,
                 java.lang.String startValue,
                 java.lang.String endValue)

Constructor that specifies all arguments.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

levels - The vector of levels.

startValue - The name of the member that represents the lower value of the range.

endValue - The name of the member that represents the upper value of the range.

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

Overrides:

toString in class ConditionStep

Returns:

The string representation of this RangeStep object.

getRangeStartValue

public java.lang.String getRangeStartValue()

Retrieves the name of the member that represents the lower value of the range in this RangeStep object.

Returns:

The name of the member that represents the lower value of the range.

setRangeStartValue

public void setRangeStartValue(java.lang.String newStartValue)

Specifies the name of the member that represents the lower value of the range in this RangeStep object.

Parameters:

newStartValue - The name of the member that represents the lower value of the range.

getRangeEndValue

public java.lang.String getRangeEndValue()

Retrieves the name of the member that represents the upper value of the range in this RangeStep object.

Returns:

The name of the member that represents the upper value of the range.

setRangeEndValue

public void setRangeEndValue(java.lang.String newEndValue)

Specifies the name of the member that represents the upper value of the range in this RangeStep object.

Parameters:

newEndValue - The name of the member that represents the upper value of the range.

getViewClassName

public java.lang.String getViewClassName()

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