oracle.dss.selection.step
Class MemberStep

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

All Implemented Interfaces:

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

public class MemberStep

extends Step

The base class for the steps in a selection that specify members of a particular dimension by name.

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

MemberStep()
Constructor that does not specify any arguments.

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

MemberStep(java.lang.String dimensionName, java.util.Vector members)
Constructor that specifies a dimension and the members.

Method Summary

void	addMember(java.lang.String member) Adds a member to this MemberStep object.
void	addMembers(java.util.Vector members) Adds multiple members to this MemberStep object.
java.lang.Object	clone() Creates a copy of this MemberStep object.
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 MemberStep object.
java.lang.String	getFirstMember() Retrieves the first member of this MemberStep object.
java.lang.String	getMember(int pos) Retrieves the number of members of this MemberStep object at the specified position.
int	getMemberCount() Retrieves the number of members of this MemberStep object.
java.util.Vector	getMembers() Retrieves the members of this MemberStep object.
RangeCollection	getRangeCollection() Retrieves the RangeCollection object of this MemberStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this MemberStep object.
boolean	hasMember(java.lang.String member) Indicates whether this MemberStep object contains the specified member.
boolean	isEmpty() Retrieves whether or not this MemberStep object has members.
void	removeMember(int intIndex) Removes a member from this MemberStep object, using the index of the member.
boolean	removeMember(java.lang.String member) Removes a member from this MemberStep object, using the name of the member and returning whether the member was found and removed.
void	removeMembers(java.util.Vector members) Removes multiple members from this MemberStep object.
void	setMembers(java.util.Vector newMembers) Specifies the members of this MemberStep object.
void	setRangeCollection(RangeCollection rangeCollection) Specifies the RangeCollection object of this MemberStep object.
java.lang.String	toString() Generates the string representation of this MemberStep object.

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

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

MemberStep

public MemberStep()

Constructor that does not specify any arguments.

MemberStep

public MemberStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

MemberStep

public MemberStep(java.lang.String dimensionName,
                  java.util.Vector members)

Constructor that specifies a dimension and the members.

Parameters:

dimensionName - The name of the dimension.

members - The vector of members.

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.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates a copy of this MemberStep object.

Overrides:

clone in class Step

Returns:

A copy of this MemberStep object.

Throws:

java.lang.CloneNotSupportedException - If cloning is not supported for any fields.

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

Overrides:

toString in class Step

Returns:

The string representation of this MemberStep object.

setMembers

public void setMembers(java.util.Vector newMembers)

Specifies the members of this MemberStep object.

getMembers

public java.util.Vector getMembers()

Retrieves the members of this MemberStep object.

Returns:

The vector of members.

setRangeCollection

public void setRangeCollection(RangeCollection rangeCollection)

Specifies the RangeCollection object of this MemberStep object.

Parameters:

rangeCollection - The name of the RangeCollection object.

getRangeCollection

public RangeCollection getRangeCollection()

Retrieves the RangeCollection object of this MemberStep object.

Returns:

The name of the RangeCollection object.

isEmpty

public boolean isEmpty()

Retrieves whether or not this MemberStep object has members.

Returns:

whether or not this MemberStep object has members.

getFirstMember

public java.lang.String getFirstMember()

Retrieves the first member of this MemberStep object.

Returns:

The first member.

getMemberCount

public int getMemberCount()

Retrieves the number of members of this MemberStep object.

Returns:

The number of members.

getMember

public java.lang.String getMember(int pos)

Retrieves the number of members of this MemberStep object at the specified position.

Parameters:

pos - The position of the members to retrieve.

Returns:

The number of members at the specified position.

hasMember

public boolean hasMember(java.lang.String member)

Indicates whether this MemberStep object contains the specified member.

Parameters:

member - The name of the member to find.

Returns:

true if this MemberStep object contains the specified member; false if it does not.

addMember

public void addMember(java.lang.String member)

Adds a member to this MemberStep object.

Parameters:

member - The name of the member to add.

addMembers

public void addMembers(java.util.Vector members)

Adds multiple members to this MemberStep object.

Parameters:

members - The vector of members to add.

removeMember

public boolean removeMember(java.lang.String member)

Removes a member from this MemberStep object, using the name of the member and returning whether the member was found and removed.

Parameters:

member - The name of the member to remove.

Returns:

true if the member was found and removed; false if the member was not found.

removeMember

public void removeMember(int intIndex)

Removes a member from this MemberStep object, using the index of the member.

Parameters:

intIndex - The index of the member to remove.

removeMembers

public void removeMembers(java.util.Vector members)

Removes multiple members from this MemberStep object.

Parameters:

members - The vector of members to remove.

getViewClassName

public java.lang.String getViewClassName()

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