oracle.dss.selection.step
Class FavoriteStep

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

All Implemented Interfaces:

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

public class FavoriteStep

extends Step

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

Represents a previously saved selection.

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

FavoriteStep()
Constructor that does not specify any arguments.

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

FavoriteStep(java.lang.String dimensionName, Selection selection)
Constructor that specifies a dimension and a Selection object.

FavoriteStep(java.lang.String dimensionName, java.lang.String strSelectionID)
Constructor that specifies a dimension and the unique identifier for the MDSelection object.

Method Summary

java.lang.Object	clone() Creates a copy of this FavoriteStep 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.lang.Class	getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this FavoriteStep object.
Selection	getSelection() Retrieves the Selection object for this FavoriteStep object.
java.lang.String	getSelectionID() Retrieves the unique identifier of the MDSelection object for this FavoriteStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this FavoriteStep object.
void	setSelection(Selection selection) Specifies the Selection object for this FavoriteStep object.
void	setSelectionID(java.lang.String strSelectionID) Specifies the unique identifier of the MDSelection object for this FavoriteStep object.
java.lang.String	toString() Generates the string representation of this FavoriteStep object.

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

FavoriteStep

public FavoriteStep()

Constructor that does not specify any arguments.

FavoriteStep

public FavoriteStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

FavoriteStep

public FavoriteStep(java.lang.String dimensionName,
Selection selection)

Constructor that specifies a dimension and a Selection object.

Parameters:

dimensionName - The name of the dimension.

selection - The name of the Selection object.

FavoriteStep

public FavoriteStep(java.lang.String dimensionName,
                    java.lang.String strSelectionID)

Constructor that specifies a dimension and the unique identifier for the MDSelection object.

Parameters:

dimensionName - The name of the dimension.

strSelectionID - The unique identifier for the MDSelection object.

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 Step

Parameters:

obj - The Step object with which to compare.

Returns:

true if the objects are completely equal; false if they are not.

clone

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

Creates a copy of this FavoriteStep object.

Overrides:

clone in class Step

Returns:

A copy of this FavoriteStep object.

copyFrom

public void copyFrom(Step step)

Copies all fields from the specified Step object.

Overrides:

copyFrom in class Step

Parameters:

step - The Step object from which to copy the fields.

toString

public java.lang.String toString()

Generates the string representation of this FavoriteStep object.

Overrides:

toString in class Step

Returns:

The string representation of this FavoriteStep object.

setSelectionID

public void setSelectionID(java.lang.String strSelectionID)

Specifies the unique identifier of the MDSelection object for this FavoriteStep object.

Parameters:

strSelectionID - The unique identifier of the MDSelection.

Returns:

none

getSelectionID

public java.lang.String getSelectionID()

Retrieves the unique identifier of the MDSelection object for this FavoriteStep object.

Returns:

The unique identifier of the MDSelection.

setSelection

public void setSelection(Selection selection)

Specifies the Selection object for this FavoriteStep object.

Parameters:

selection - The Selection object.

Returns:

none

getSelection

public Selection getSelection()

Retrieves the Selection object for this FavoriteStep object.

Returns:

The Selection object.

getViewClassName

public java.lang.String getViewClassName()

Retrieves the name of the StepView class to use to edit this FavoriteStep object. If the name is null, 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 FavoriteStep 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.