oracle.dss.selection.step
Class FamilyStep

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

All Implemented Interfaces:

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

public class FamilyStep

extends BasicFamilyStep

Represents a step in a selection that specifies members of a particular dimension based on a relationship within a family. For example, it might specify the children (such as the cities, Boston, New York, Providence, and so on) of a region (such as, Eastern U.S.).

See Also:

Serialized Form

Field Summary

static int	OP_ANCESTORS The ancestors family operator, which specifies members at any level above a particular member in a hierarchy.
static int	OP_CHILDREN The children family operator, which specifies members at the level immediately below a particular member in a hierarchy.
static int	OP_DESCENDANTS The descendants family operator, which specifies members at any level below a particular member in a hierarchy.
static int	OP_LASTDESCENDANTS The last descendants family operator, which specifies members at the very last level in a hierarchy.
static int	OP_PARENT The parent family operator, which specifies members at the level immediately above a particular member in a hierarchy.
static int	OP_SIBLINGS The siblings family operator, which specifies members at the same level as a particular member in a hierarchy.
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

FamilyStep()
Constructor that does not specify any arguments.

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

FamilyStep(java.lang.String dimensionName, int familyOp, java.util.Vector familyValues)
Constructor that specifies all arguments except whether to include the specified family members.

FamilyStep(java.lang.String dimensionName, java.lang.String hierarchy, int familyOp, java.util.Vector familyValues, boolean familyValuesIncluded)
Constructor that specifies all arguments.

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 FamilyStep object.
int	getFamilyOp() Retrieves the family operator for this FamilyStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this FamilyStep object.
void	setFamilyOp(int familyOp) Specifies the family operator for this FamilyStep object.
java.lang.String	toString() Generates the string representation of this FamilyStep 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

OP_CHILDREN

public static final int OP_CHILDREN

The children family operator, which specifies members at the level immediately below a particular member in a hierarchy.

OP_PARENT

public static final int OP_PARENT

The parent family operator, which specifies members at the level immediately above a particular member in a hierarchy.

OP_SIBLINGS

public static final int OP_SIBLINGS

The siblings family operator, which specifies members at the same level as a particular member in a hierarchy.

OP_ANCESTORS

public static final int OP_ANCESTORS

The ancestors family operator, which specifies members at any level above a particular member in a hierarchy.

OP_DESCENDANTS

public static final int OP_DESCENDANTS

The descendants family operator, which specifies members at any level below a particular member in a hierarchy.

OP_LASTDESCENDANTS

public static final int OP_LASTDESCENDANTS

The last descendants family operator, which specifies members at the very last level in a hierarchy.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

FamilyStep

public FamilyStep()

Constructor that does not specify any arguments.

FamilyStep

public FamilyStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

FamilyStep

public FamilyStep(java.lang.String dimensionName,
                  int familyOp,
                  java.util.Vector familyValues)

Constructor that specifies all arguments except whether to include the specified family members.

Parameters:

dimensionName - The name of the dimension.

familyOp - A constant that represents the family operator. The valid constants are listed in the See Also section.

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

See Also:

OP_ANCESTORS, OP_CHILDREN, OP_DESCENDANTS, OP_LASTDESCENDANTS, OP_PARENT, OP_SIBLINGS

FamilyStep

public FamilyStep(java.lang.String dimensionName,
                  java.lang.String hierarchy,
                  int familyOp,
                  java.util.Vector familyValues,
                  boolean familyValuesIncluded)

Constructor that specifies all arguments.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

familyOp - A constant that represents the family operator. The valid constants are listed in the See Also section.

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.

See Also:

OP_ANCESTORS, OP_CHILDREN, OP_DESCENDANTS, OP_LASTDESCENDANTS, OP_PARENT, OP_SIBLINGS

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

Overrides:

toString in class BasicFamilyStep

Returns:

The string representation of this FamilyStep object.

setFamilyOp

public void setFamilyOp(int familyOp)

Specifies the family operator for this FamilyStep object.

Parameters:

familyOp - A constant that represents the family operator. The valid constants are listed in the See Also section.

See Also:

OP_ANCESTORS, OP_CHILDREN, OP_DESCENDANTS, OP_LASTDESCENDANTS, OP_PARENT, OP_SIBLINGS

getFamilyOp

public int getFamilyOp()

Retrieves the family operator for this FamilyStep object.

Returns:

A constant that represents the family operator. The valid constants are listed in the See Also section.

See Also:

OP_ANCESTORS, OP_CHILDREN, OP_DESCENDANTS, OP_LASTDESCENDANTS, OP_PARENT, OP_SIBLINGS

getViewClassName

public java.lang.String getViewClassName()

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