|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dss.selection.step.Step | +--oracle.dss.selection.step.MemberStep
The base class for the steps in a selection that specify members of a particular dimension by name.
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 |
public static final java.lang.String STEP_STATE
Constructor Detail |
public MemberStep()
public MemberStep(java.lang.String dimensionName)
dimensionName
- The name of the dimension.public MemberStep(java.lang.String dimensionName, java.util.Vector members)
dimensionName
- The name of the dimension.members
- The vector of members.Method Detail |
public boolean equals(java.lang.Object obj)
Step
object is equivalent to another Step
object.equals
in class Step
obj
- The Step
object with which to compare.true
if the objects are completely equal; false
if they are not.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
MemberStep
object.clone
in class Step
MemberStep
object.java.lang.CloneNotSupportedException
- If cloning is not supported for any fields.public void copyFrom(Step step)
Step
object.copyFrom
in class Step
step
- The Step
object from which to copy the fields.public java.lang.String toString()
MemberStep
object.toString
in class Step
MemberStep
object.public void setMembers(java.util.Vector newMembers)
MemberStep
object.public java.util.Vector getMembers()
MemberStep
object.public void setRangeCollection(RangeCollection rangeCollection)
RangeCollection
object of this MemberStep
object.rangeCollection
- The name of the RangeCollection
object.public RangeCollection getRangeCollection()
RangeCollection
object of this MemberStep
object.RangeCollection
object.public boolean isEmpty()
MemberStep
object has members.MemberStep
object has members.public java.lang.String getFirstMember()
MemberStep
object.public int getMemberCount()
MemberStep
object.public java.lang.String getMember(int pos)
MemberStep
object at the specified position.pos
- The position of the members to retrieve.public boolean hasMember(java.lang.String member)
MemberStep
object contains the specified member.member
- The name of the member to find.true
if this MemberStep
object contains the specified member; false
if it does not.public void addMember(java.lang.String member)
MemberStep
object.member
- The name of the member to add.public void addMembers(java.util.Vector members)
MemberStep
object.members
- The vector of members to add.public boolean removeMember(java.lang.String member)
MemberStep
object, using the name of the member and returning whether the member was found and removed.member
- The name of the member to remove.true
if the member was found and removed; false
if the member was not found.public void removeMember(int intIndex)
MemberStep
object, using the index of the member.intIndex
- The index of the member to remove.public void removeMembers(java.util.Vector members)
MemberStep
object.members
- The vector of members to remove.public java.lang.String getViewClassName()
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.getViewClassName
in class Step
StepView
class.public java.lang.Class getEvaluatorClass() throws SelectionException
StepEvaluator
class object that is associated with this MemberStep
object. The QueryServer
object uses this class to instantiate the appropriate StepEvaluator
object.getEvaluatorClass
in class Step
Class
object.SelectionException
- If the StepEvaluator
class is not found.
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |