oracle.dss.selection.sortStep
Class MemberSortStep

java.lang.Object
  |
  +--oracle.dss.selection.step.Step
        |
        +--oracle.dss.selection.sortStep.MemberSortStep

All Implemented Interfaces:

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

public class MemberSortStep

extends Step

Represents a step in a sort specification that sorts members of a particular dimension based on a manual reordering such as moving Boston before New York.

See Also:

Serialized Form

Field Summary

static int	AFTER A type of move that specifies moving a member after another member.
static int	BEFORE A type of move that specifies moving a member before another member.
static int	FIRST A type of move that specifies moving a member to the first position.
static int	LAST A type of move that specifies moving a member to the last position.
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

MemberSortStep()
Constructor that does not specify any arguments.

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

MemberSortStep(java.lang.String dimensionName, MemberStep memberStep, int moveType, java.lang.String refMember)
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 MemberSortStep object.
MemberStep	getMembersToMove() Retrieves the MemberStep containing the members to move in this MemberSortStep object.
int	getMoveType() Retrieves the type of move for this MemberSortStep object.
java.lang.String	getRefMember() Retrieves the name of the member relative to which the move is to occur in this MemberSortStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this MemberSortStep object.
void	setMembersToMove(MemberStep newMembersToMove) Specifies the vector containing the names of the members to move in this MemberSortStep object.
void	setMoveType(int newMoveType) Specifies the type of move for this MemberSortStep object.
void	setRefMember(java.lang.String newRefMember) Specifies the name of the member relative to which the move is to occur in this MemberSortStep object.
java.lang.String	toString() Generates the string representation of this MemberSortStep object.

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

addPropertyChangeListener, clone, 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

A type of move that specifies moving a member to the first position.

LAST

public static final int LAST

A type of move that specifies moving a member to the last position.

BEFORE

public static final int BEFORE

A type of move that specifies moving a member before another member.

AFTER

public static final int AFTER

A type of move that specifies moving a member after another member.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

MemberSortStep

public MemberSortStep()

Constructor that does not specify any arguments.

MemberSortStep

public MemberSortStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

MemberSortStep

public MemberSortStep(java.lang.String dimensionName,
MemberStep memberStep,
                      int moveType,
                      java.lang.String refMember)
               throws InvalidStepArgException

Constructor that specifies all arguments.

Parameters:

dimensionName - The name of the dimension.

memberStep - The MemberStep containing the members to move.

moveType - A constant that represents the type of move. The valid constants are:

• AFTER
• BEFORE
• FIRST
• LAST

refMember - The name of the member relative to which the move is to occur. Applies only when the move type is either AFTER or BEFORE.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

AFTER, BEFORE, 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 Step

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 Step

Parameters:

step - The Step object from which to copy the fields.

toString

public java.lang.String toString()

Generates the string representation of this MemberSortStep object.

Overrides:

toString in class Step

Returns:

The string representation of this MemberSortStep object.

setMembersToMove

public void setMembersToMove(MemberStep newMembersToMove)

Specifies the vector containing the names of the members to move in this MemberSortStep object.

Parameters:

newMembersToMove - The MemberStep containing the members to move.

getMembersToMove

public MemberStep getMembersToMove()

Retrieves the MemberStep containing the members to move in this MemberSortStep object.

Returns:

The vector containing the names of the members to move.

setMoveType

public void setMoveType(int newMoveType)
                 throws InvalidStepArgException

Specifies the type of move for this MemberSortStep object.

Parameters:

newMoveType - A constant that represents the type of move. The valid constants are:

• AFTER
• BEFORE
• FIRST
• LAST

Throws:

InvalidStepArgException - If an argument is not not valid.

See Also:

AFTER, BEFORE, FIRST, LAST

getMoveType

public int getMoveType()

Retrieves the type of move for this MemberSortStep object.

Returns:

A constant that represents the type of move. The valid constants are:

• AFTER
• BEFORE
• FIRST
• LAST

See Also:

AFTER, BEFORE, FIRST, LAST

setRefMember

public void setRefMember(java.lang.String newRefMember)

Specifies the name of the member relative to which the move is to occur in this MemberSortStep object. Applies only when the move type is either AFTER or BEFORE.

Parameters:

newRefMember - The name of the member.

getRefMember

public java.lang.String getRefMember()

Retrieves the name of the member relative to which the move is to occur in this MemberSortStep object. Applies only when the move type is either AFTER or BEFORE.

Returns:

The name of the member.

getViewClassName

public java.lang.String getViewClassName()

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