oracle.dss.selection.step
Class FirstLastStep

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

All Implemented Interfaces:

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

public class FirstLastStep

extends ConditionStep

Represents a step in a selection that specifies a specified number of first or last members of a particular dimension.

See Also:

Serialized Form

Field Summary

static int	FIRST The first members of a dimension.
static int	LAST The last members of a dimension.
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

FirstLastStep()
Constructor that does not specify any arguments.

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

FirstLastStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, int firstLastType, java.lang.Integer numValues)
Constructor that specifes 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 FirstLastStep object.
int	getFirstLastType() Retrieves the type of members that this FirstLastStep object specifies.
java.lang.Integer	getNumValues() Retrieves the number of members that this FirstLastStep object specifies.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this FirstLastStep object.
void	setFirstLastType(int firstLastType) Specifies the type of members that this FirstLastStep object specifies.
void	setNumValues(java.lang.Integer newNumValues) Specifies the number of members to specify in this FirstLastStep object.
java.lang.String	toString() Generates the string representation of this FirstLastStep 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

FIRST

public static final int FIRST

The first members of a dimension.

LAST

public static final int LAST

The last members of a dimension.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

FirstLastStep

public FirstLastStep()

Constructor that does not specify any arguments.

FirstLastStep

public FirstLastStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

FirstLastStep

public FirstLastStep(java.lang.String dimensionName,
                     java.lang.String hierarchy,
                     java.util.Vector levels,
                     int firstLastType,
                     java.lang.Integer numValues)
              throws InvalidStepArgException

Constructor that specifes all arguments.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

levels - The vector of levels.

firstLastType - A constant that indicates the type of members that this FirstLastStep object specifies. The valid constants are FIRST and LAST.

numMembers - The number of members to specify.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

FIRST, LAST

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

Overrides:

toString in class ConditionStep

Returns:

The string representation of this FirstLastStep object.

setFirstLastType

public void setFirstLastType(int firstLastType)
                      throws InvalidStepArgException

Specifies the type of members that this FirstLastStep object specifies.

Parameters:

firstLastType - A constant that indicates the type of members that this FirstLastStep object specifies. The valid constants are FIRST and LAST.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

FIRST, LAST

getFirstLastType

public int getFirstLastType()

Retrieves the type of members that this FirstLastStep object specifies.

Returns:

A constant that indicates the type of members that this FirstLastStep object specifies. The valid constants are FIRST and LAST.

See Also:

FIRST, LAST

getNumValues

public java.lang.Integer getNumValues()

Retrieves the number of members that this FirstLastStep object specifies.

Returns:

The number of members that this FirstLastStep object specifies.

setNumValues

public void setNumValues(java.lang.Integer newNumValues)

Specifies the number of members to specify in this FirstLastStep object.

Parameters:

newNumMembers - The number of members to specify.

getViewClassName

public java.lang.String getViewClassName()

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