oracle.dss.selection.step
Class TopBottomStep

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

All Implemented Interfaces:

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

public class TopBottomStep

extends MeasConditionStep

Represents a step in a selection that specifies members of a particular dimension based on the top (largest) or bottom (smallest) data values in a particular measure. For example, it might specify the top 10 members based on Sales.

See Also:

Serialized Form

Field Summary

static int	BOTTOM The bottom data values of a particular measure.
static java.lang.String	STEP_STATE State Management support
static int	TOP The top data values of a particular measure.
static int	TOP_OR_BOTTOM The top or bottom data values of a particular measure.

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

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

Constructor Summary

TopBottomStep()
Constructor that does not specify any arguments.

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

TopBottomStep(java.lang.String dimensionName, java.lang.String measureName, int topBotType, java.lang.Number position, boolean isPercent)
Constructor that specifies all arguments except a hierarchy and levels.

TopBottomStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.String measureName, int topBotType, java.lang.Number position, 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 TopBottomStep object.
java.lang.Number	getPosition() Retrieves the value from which to start finding the top, bottom, or top or bottom data values.
int	getTopBottomType() Retrieves the type of data values that this TopBottomSumStep object uses.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this TopBottomStep object.
boolean	isPercent() Indicates whether the value from which to start finding the top, bottom, or top or bottom data values is a percentage.
void	setPercent(boolean isPercent) Specifies whether the value from which to start finding the top, bottom, or top or bottom data values is a percentage.
void	setPosition(java.lang.Number newPosition) Specifies the value from which to start finding the top, bottom, or top or bottom data values.
void	setTopBottomType(int newType) Specifies the type of data values that this TopBottomSumStep object uses.
java.lang.String	toString() Generates the string representation of this TopBottomStep 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

TOP

public static final int TOP

The top data values of a particular measure.

BOTTOM

public static final int BOTTOM

The bottom data values of a particular measure.

TOP_OR_BOTTOM

public static final int TOP_OR_BOTTOM

The top or bottom data values of a particular measure.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

TopBottomStep

public TopBottomStep()

Constructor that does not specify any arguments.

TopBottomStep

public TopBottomStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

TopBottomStep

public TopBottomStep(java.lang.String dimensionName,
                     java.lang.String measureName,
                     int topBotType,
                     java.lang.Number position,
                     boolean isPercent)
              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.

topBotType - A constant that represents the type of data values that this TopBottomSumStep object uses. The valid constants are TOP, BOTTOM, and TOP_OR_BOTTOM.

position - The value from which to start finding the top, bottom, or top or bottom data values.

isPercent - true if the value from which to start finding the top, bottom, or top or bottom data values is a percentage; false if it is not.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

TOP, BOTTOM, TOP_OR_BOTTOM

TopBottomStep

public TopBottomStep(java.lang.String dimensionName,
                     java.lang.String hierarchy,
                     java.util.Vector levels,
                     java.lang.String measureName,
                     int topBotType,
                     java.lang.Number position,
                     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.

measureName - The name of the measure.

topBotType - A constant that represents the type of data values that this TopBottomSumStep object uses. The valid constants are TOP, BOTTOM, and TOP_OR_BOTTOM.

position - The value from which to start finding the top, bottom, or top or bottom data values.

isPercent - true if the value from which to start finding the top, bottom, or top or bottom data values is a percentage; false if it is not.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

TOP, BOTTOM, TOP_OR_BOTTOM

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 fields.

toString

public java.lang.String toString()

Generates the string representation of this TopBottomStep object.

Overrides:

toString in class MeasConditionStep

Returns:

The string representation of this TopBottomStep object.

setTopBottomType

public void setTopBottomType(int newType)
                      throws InvalidStepArgException

Specifies the type of data values that this TopBottomSumStep object uses.

Parameters:

newType - A constant that represents the type of data values that this TopBottomSumStep object uses. The valid constants are TOP, BOTTOM, and TOP_OR_BOTTOM.

Throws:

InvalidStepArgException - If the arguments are not valid.

See Also:

TOP, BOTTOM, TOP_OR_BOTTOM

getTopBottomType

public int getTopBottomType()

Retrieves the type of data values that this TopBottomSumStep object uses.

Returns:

A constant that represents the type of data values that this TopBottomSumStep object uses. The valid constants are TOP, BOTTOM, and TOP_OR_BOTTOM.

See Also:

TOP, BOTTOM, TOP_OR_BOTTOM

setPosition

public void setPosition(java.lang.Number newPosition)

Specifies the value from which to start finding the top, bottom, or top or bottom data values.

Parameters:

newPosition - The value from which to start finding the top, bottom, or top or bottom data values.

getPosition

public java.lang.Number getPosition()

Retrieves the value from which to start finding the top, bottom, or top or bottom data values.

Returns:

The value from which to start finding the top, bottom, or top or bottom data values.

setPercent

public void setPercent(boolean isPercent)

Specifies whether the value from which to start finding the top, bottom, or top or bottom data values is a percentage.

Parameters:

isPercent - true if the value from which to start finding the top, bottom, or top or bottom data values is a percentage; false if it is not.

isPercent

public boolean isPercent()

Indicates whether the value from which to start finding the top, bottom, or top or bottom data values is a percentage.

Returns:

true if the value from which to start finding the top, bottom, or top or bottom data values 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 TopBottomStep 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 TopBottomStep 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.