oracle.dss.selection.step
Class BasicFamilyStep

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FamilyLevelStep, FamilyStep

public abstract class BasicFamilyStep

extends ConditionStep

The base class for the steps in a selection that specify members of a particular dimension based on family relationships.

See Also:

Serialized Form

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

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

Constructor Summary

BasicFamilyStep()
Constructor that does not specify any arguments.

BasicFamilyStep(java.lang.String strDimensionName)
Constructor that specifies a dimension.

BasicFamilyStep(java.lang.String strDimensionName, java.util.Vector vFamilyValues)
Constructor that specifies a dimension and family members.

BasicFamilyStep(java.lang.String strDimensionName, java.util.Vector vFamilyValues, boolean bFamilyValuesIncluded)
Constructor that specifies a dimension, family members, and whether to include the specified family members.

Method Summary

java.lang.Object	clone() Creates a copy of this BasicFamilyStep 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.util.Vector	getFamilyValues() Retrieves the family members whose families are specified in this BasicFamilyStep object.
boolean	isFamilyValuesIncluded() Indicates whether the specified family members as well as the families are included in this BasicFamilyStep object.
void	setFamilyValues(java.util.Vector vFamilyValues) Specifies the family members whose families are to be specified in this BasicFamilyStep object.
void	setFamilyValuesIncluded(boolean bFamilyValuesIncluded) Specifies whether to include the specified family members as well as the families in this BasicFamilyStep object.
java.lang.String	toString() Generates the string representation of this BasicFamilyStep object.

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

getLevels, setLevels

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

addPropertyChangeListener, getAction, getDescription, getDimension, getDispQDR, getEvaluatorClass, getHierarchy, getQDR, getQDRDescription, getViewClassName, 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

Constructor Detail

BasicFamilyStep

public BasicFamilyStep()

Constructor that does not specify any arguments.

BasicFamilyStep

public BasicFamilyStep(java.lang.String strDimensionName)

Constructor that specifies a dimension.

Parameters:

strDimensionName - The name of the dimension.

BasicFamilyStep

public BasicFamilyStep(java.lang.String strDimensionName,
                       java.util.Vector vFamilyValues)

Constructor that specifies a dimension and family members.

Parameters:

strDimensionName - - The name of the dimension.

vFamilyMembers - The vector of family members whose families are to be specified.

BasicFamilyStep

public BasicFamilyStep(java.lang.String strDimensionName,
                       java.util.Vector vFamilyValues,
                       boolean bFamilyValuesIncluded)

Constructor that specifies a dimension, family members, and whether to include the specified family members.

Parameters:

strDimensionName - - The name of the dimension.

vFamilyMembers - The vector of family members whose families are to be specified.

bFamilyMembersIncluded - true if the specified family members are to be included; false if they are not.

Method Detail

clone

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

Creates a copy of this BasicFamilyStep object.

Overrides:

clone in class ConditionStep

Returns:

A copy of this BasicFamilyStep object.

Throws:

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

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

Overrides:

toString in class ConditionStep

Returns:

The string representation of this BasicFamilyStep object.

setFamilyValues

public void setFamilyValues(java.util.Vector vFamilyValues)

Specifies the family members whose families are to be specified in this BasicFamilyStep object.

Parameters:

vFamilyMembers - The vector of family members.

getFamilyValues

public java.util.Vector getFamilyValues()

Retrieves the family members whose families are specified in this BasicFamilyStep object.

Returns:

The vector of family members.

setFamilyValuesIncluded

public void setFamilyValuesIncluded(boolean bFamilyValuesIncluded)

Specifies whether to include the specified family members as well as the families in this BasicFamilyStep object.

Parameters:

bFamilyMembersIncluded - true if the specified family members are to be included; false if they are not.

isFamilyValuesIncluded

public boolean isFamilyValuesIncluded()

Indicates whether the specified family members as well as the families are included in this BasicFamilyStep object.

Returns:

true if the specified family members are included; false if they are not.