oracle.dss.selection.step
Class DrillLevelStep

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

All Implemented Interfaces:

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

public class DrillLevelStep

extends FamilyLevelStep

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

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

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

Constructor Summary

DrillLevelStep()
Constructor that does not specify any arguments.

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

DrillLevelStep(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.

Method Summary

java.lang.Class	getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this DrillLevelStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this FamilyLevelStep object.

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

copyFrom, equals, includeSiblings, isRange, setRange, setSiblings, toString

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

Constructor Detail

DrillLevelStep

public DrillLevelStep()

Constructor that does not specify any arguments.

DrillLevelStep

public DrillLevelStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

DrillLevelStep

public DrillLevelStep(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

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, retrieves the base StepView class. Overrides the same method in the base Step class.

Overrides:

getViewClassName in class FamilyLevelStep

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 DrillLevelStep object. The QueryServer object uses this class to instantiate the appropriate StepEvaluator object.

Overrides:

getEvaluatorClass in class FamilyLevelStep

Returns:

The Class object.

Throws:

SelectionException - If the StepEvaluator class is not found.