oracle.dss.selection.step
Class FamilyLevelStep

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DrillLevelStep

public class FamilyLevelStep

extends BasicFamilyStep

Represents a step in a selection that specifies members of a particular dimension based on a particular level. For example, it might specify the cities in USA.

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

FamilyLevelStep()
Constructor that does not specify any arguments.

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

FamilyLevelStep(java.lang.String dimensionName, java.lang.String hierarchy, java.lang.String level, java.util.Vector familyValues, boolean familyValuesIncluded, boolean downto, boolean siblings)
Constructor that is used to drill down to one level.

FamilyLevelStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.util.Vector familyValues, boolean familyValuesIncluded)
Constructor that is used to specify multiple levels.

FamilyLevelStep(java.lang.String dimensionName, java.util.Vector familyValues)
Constructor that specifies a dimension and family members.

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 FamilyLevelStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this FamilyLevelStep object.
boolean	includeSiblings() Indicates whether siblings of the specified family members are included in this FamilyLevelStep object.
boolean	isRange() Indicates whether descendants down to the specified level are included in this FamilyLevelStep object.
void	setRange(boolean downto) Specifies whether to include descendants down to the specified level in this FamilyLevelStep object.
void	setSiblings(boolean siblings) Specifies whether to include siblings of the specified family members in this FamilyLevelStep object.
java.lang.String	toString() Generates the string representation of this FamilyLevelStep object.

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

clone, getFamilyValues, isFamilyValuesIncluded, setFamilyValues, setFamilyValuesIncluded

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

FamilyLevelStep

public FamilyLevelStep()

Constructor that does not specify any arguments.

FamilyLevelStep

public FamilyLevelStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

FamilyLevelStep

public FamilyLevelStep(java.lang.String dimensionName,
                       java.util.Vector familyValues)

Constructor that specifies a dimension and family members.

Parameters:

dimensionName - The name of the dimension.

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

FamilyLevelStep

public FamilyLevelStep(java.lang.String dimensionName,
                       java.lang.String hierarchy,
                       java.util.Vector levels,
                       java.util.Vector familyValues,
                       boolean familyValuesIncluded)

Constructor that is used to specify multiple levels.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

levels - The vector of levels.

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

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

FamilyLevelStep

public FamilyLevelStep(java.lang.String dimensionName,
                       java.lang.String hierarchy,
                       java.lang.String level,
                       java.util.Vector familyValues,
                       boolean familyValuesIncluded,
                       boolean downto,
                       boolean siblings)

Constructor that is used to drill down to one level.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

level - The name of the level.

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

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

downto - true if descendants down to the specified level are to be included; false if they are not.

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

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 BasicFamilyStep

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 BasicFamilyStep

Parameters:

step - The Step object from which to copy fields.

toString

public java.lang.String toString()

Generates the string representation of this FamilyLevelStep object.

Overrides:

toString in class BasicFamilyStep

Returns:

The string representation of this FamilyLevelStep object.

setRange

public void setRange(boolean downto)

Specifies whether to include descendants down to the specified level in this FamilyLevelStep object.

Parameters:

downto - true if descendants down to the specified level are to be included; false if they are not.

isRange

public boolean isRange()

Indicates whether descendants down to the specified level are included in this FamilyLevelStep object.

Returns:

true if descendants down to the specified level are included; false if they are not.

setSiblings

public void setSiblings(boolean siblings)

Specifies whether to include siblings of the specified family members in this FamilyLevelStep object.

Parameters:

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

includeSiblings

public boolean includeSiblings()

Indicates whether siblings of the specified family members are included in this FamilyLevelStep object.

Returns:

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

getViewClassName

public java.lang.String getViewClassName()

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