oracle.dss.selection.step
Class Step

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CalcStep, ConditionStep, FavoriteStep, MemberSortStep, MemberStep

public abstract class Step

extends java.lang.Object

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

The base class for all the steps in a selection.

See Also:

Serialized Form

Field Summary

static int	ADD The add action, which adds new members.
static java.lang.String	BASE_STATE_INDEX Deprecated. As of 2.6.0.20.
static java.lang.String	CURRENT_STATE_INDEX Deprecated. As of 2.6.0.20.
static int	KEEP The keep action, which keeps the new members in the current selection and discards the others.
static int	LONG The long description of this Step object, which consists of the action, hierarchy, levels, basic condition, QDRs, and options (such as, exclude zeros); for example, Keep All Levels Top 10 based on Sales for Time:Jan99 Geography:USA.
static int	MEDIUM The medium description of this Step object, which consists of the action, levels, and basic condition; for example Add All levels Top 10 based on Sales
static int	REMOVE The remove action, which removes the new members from the current selection and keeps the others.
static int	SELECT The select action, which replaces the current selection with new members.
static int	SHORT The short description of this Step object, which consists of the basic condition; for example, Top 10 based on Sales.

Constructor Summary

Step()
Constructor that does not specify any arguments.

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

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Adds the specified PropertyChangeListener object to this Step object to listen for property changes.
java.lang.Object	clone() Creates a copy of this Step 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.
int	getAction() Retrieves the action of this Step object.
java.lang.String	getDescription(int type) Retrieves the description of this Step object that is generated by the StepView object.
java.lang.String	getDimension() Retrieves the dimension of this Step object.
OlapQDR	getDispQDR() Retrieves the display QDR object for this Step object.
java.lang.Class	getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this Step object.
java.lang.String	getHierarchy() Retrieves the hierarchy of this Step object.
OlapQDR	getQDR() Retrieves the QDR object for this Step object.
java.lang.String	getQDRDescription() Retrieves the QDR description of this Step object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this Step object.
boolean	isEnabled() Indicates whether this step will be evaluated.
boolean	isValid() Indicates whether the step is valid.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Removes the specified PropertyChangeListener object from this Step object.
void	setAction(int newAction) Specifies the action of this Step object.
void	setDescription(int type, java.lang.String newDesc) Specifies the description of this Step object.
void	setDimension(java.lang.String newDimension) Specifies the dimension of this Step object.
void	setDispQDR(OlapQDR newQDR) Specifes the display QDR object for this Step object.
void	setEnabled(boolean isEnabled) Specifies whether this step is enabled for evaluation.
void	setHierarchy(java.lang.String newHierarchy) Specifies the hierarchy of this Step object.
void	setQDR(OlapQDR newQDR) Specifies the QDR object for this Step object.
void	setQDRDescription(java.lang.String newDesc) Specifies the QDR description of this Step object.
void	setValid(boolean isValid) Specifies whether the step is valid.
java.lang.String	toString() Generates the string representation of this Step object.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SELECT

public static final int SELECT

The select action, which replaces the current selection with new members.

ADD

public static final int ADD

The add action, which adds new members.

KEEP

public static final int KEEP

The keep action, which keeps the new members in the current selection and discards the others.

REMOVE

public static final int REMOVE

The remove action, which removes the new members from the current selection and keeps the others.

SHORT

public static final int SHORT

The short description of this Step object, which consists of the basic condition; for example, Top 10 based on Sales.

MEDIUM

public static final int MEDIUM

The medium description of this Step object, which consists of the action, levels, and basic condition; for example Add All levels Top 10 based on Sales

LONG

public static final int LONG

The long description of this Step object, which consists of the action, hierarchy, levels, basic condition, QDRs, and options (such as, exclude zeros); for example, Keep All Levels Top 10 based on Sales for Time:Jan99 Geography:USA.

BASE_STATE_INDEX

public static final java.lang.String BASE_STATE_INDEX

Deprecated. As of 2.6.0.20.

CURRENT_STATE_INDEX

public static final java.lang.String CURRENT_STATE_INDEX

Deprecated. As of 2.6.0.20.

Constructor Detail

Step

public Step()

Constructor that does not specify any arguments.

Step

public Step(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of a dimension.

Method Detail

clone

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

Creates a copy of this Step object.

Specified by:

clone in interface VectorClone

Returns:

A copy of this Step object.

Throws:

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

equals

public boolean equals(java.lang.Object obj)

Indicates whether one Step object is equivalent to another Step object.

Overrides:

equals in class java.lang.Object

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.

Parameters:

step - The Step object from which to copy fields.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Adds the specified PropertyChangeListener object to this Step object to listen for property changes.

Parameters:

l - The PropertyChangeListener object to add.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Removes the specified PropertyChangeListener object from this Step object.

Parameters:

l - The PropertyChangeListener object to remove.

toString

public java.lang.String toString()

Generates the string representation of this Step object.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of this Step object.

setAction

public void setAction(int newAction)
               throws InvalidStepArgException

Specifies the action of this Step object.

Parameters:

newAction - A constant that represents the action. The valid constants are listed in the See Also section.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

ADD, KEEP, REMOVE, SELECT

getAction

public int getAction()

Retrieves the action of this Step object.

Returns:

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

See Also:

ADD, KEEP, REMOVE, SELECT

setDimension

public void setDimension(java.lang.String newDimension)

Specifies the dimension of this Step object.

Parameters:

newDimension - The name of the dimension.

getDimension

public java.lang.String getDimension()

Retrieves the dimension of this Step object.

Returns:

The name of the dimension.

setHierarchy

public void setHierarchy(java.lang.String newHierarchy)

Specifies the hierarchy of this Step object.

Parameters:

newHierarchy - The name of the hierarchy.

getHierarchy

public java.lang.String getHierarchy()

Retrieves the hierarchy of this Step object.

Returns:

The name of the hierarchy.

getViewClassName

public java.lang.String getViewClassName()

Retrieves the name of the StepView class to use to edit this Step object. If the name is null, then retrieves the base StepView class.

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

Returns:

The Class object.

Throws:

SelectionException - If the StepEvaluator class is not found.

getDescription

public java.lang.String getDescription(int type)

Retrieves the description of this Step object that is generated by the StepView object.

Parameters:

type - A constant that represents the type of description to retrieve. The valid constants are listed in the See Also section.

Returns:

The description of this Step object.

See Also:

LONG, MEDIUM, SHORT

setDescription

public void setDescription(int type,
                           java.lang.String newDesc)

Specifies the description of this Step object. The description is usually generated by the StepView class.

Parameters:

type - A constant that represents the type of description for this Step object. The valid constants are listed in the See Also section.

newDesc - - The description of this Step object.

See Also:

LONG, MEDIUM, SHORT

setQDRDescription

public void setQDRDescription(java.lang.String newDesc)

Specifies the QDR description of this Step object.

Parameters:

newQDRdesc - The description of the QDR.

setQDR

public void setQDR(OlapQDR newQDR)

Specifies the QDR object for this Step object. A QDR is a set of ordered dimension member pairs that fully/partially defines a reference to a subset of data values.

Parameters:

newQDR - The QDR object for this Step object.

getQDR

public OlapQDR getQDR()

Retrieves the QDR object for this Step object. A QDR is a set of ordered dimension member pairs that fully/partially defines a reference to a subset of data values.

Returns:

The QDR object for this Step object.

setDispQDR

public void setDispQDR(OlapQDR newQDR)

Specifes the display QDR object for this Step object. A QDR is a set of ordered dimension member pairs that fully/partially defines a reference to a subset of data values.

Parameters:

newQDR - The display QDR object for this Step object.

getDispQDR

public OlapQDR getDispQDR()

Retrieves the display QDR object for this Step object. A QDR is a set of ordered dimension member pairs that fully/partially defines a reference to a subset of data values.

Returns:

The display QDR object for this Step object.

getQDRDescription

public java.lang.String getQDRDescription()

Retrieves the QDR description of this Step object.

Returns:

The QDR description.

setEnabled

public void setEnabled(boolean isEnabled)

Specifies whether this step is enabled for evaluation.

Parameters:

isEnabled - true to have this step evalauted, false to ignore this step when evaluating the selection to which the step belongs.

isEnabled

public boolean isEnabled()

Indicates whether this step will be evaluated.

Returns:

true if this step will be evaluated; false if this step is ignored when its parent selection is evaluated.

setValid

public void setValid(boolean isValid)

Specifies whether the step is valid.

Parameters:

isValid - true to have the step be valid, false if the step is not valid.

isValid

public boolean isValid()

Indicates whether the step is valid.

Returns:

true if the step is valid; false if the step is not valid.