oracle.dss.selection.step
Class AttributeStep

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

All Implemented Interfaces:

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

public class AttributeStep

extends ConditionStep

Represents a step in a selection that specifies members of a particular dimension based on an attribute. For example, it might specify members with a color of red.

See Also:

Serialized Form

Field Summary

static int	OP_EQUAL The equal operator.
static int	OP_NOT_EQUAL The not equal operator.
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

AttributeStep()
Constructor that does not specify any arguments.

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

AttributeStep(java.lang.String dimensionName, java.lang.String attribute, java.util.Vector attributeValues)
Constructor that specifies all arguments except a hierarchy, levels, and an operator.

AttributeStep(java.lang.String dimensionName, java.lang.String attribute, java.util.Vector attributeValues, int attributeOp)
Constructor that specifies all arguments except a hierarchy and levels.

AttributeStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.String attribute, java.util.Vector attributeValues, int attributeOp)
Constructor that specifies all arguments.

Method Summary

java.lang.Object	clone() Creates a copy of this AttributeStep 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.String	getAttribute() Retrieves the attribute of this AttributeStep object.
int	getAttributeOp() Retrieves the operator for this AttributeStep object.
java.util.Vector	getAttributeValues() Retrieves the members of this AttributeStep object.
java.lang.Class	getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this AttributeStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this AttributeStep object.
void	setAttribute(java.lang.String Attribute) Specifies the attribute of this AttributeStep object.
void	setAttributeOp(int op) Specifies the operator for this AttributeStep object.
void	setAttributeValues(java.util.Vector AttributeValues) Specifes the members of this AttributeStep object.
java.lang.String	toString() Generates the string representation of this AttributeStep object.

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_EQUAL

public static final int OP_EQUAL

The equal operator.

OP_NOT_EQUAL

public static final int OP_NOT_EQUAL

The not equal operator.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

AttributeStep

public AttributeStep()

Constructor that does not specify any arguments.

AttributeStep

public AttributeStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

AttributeStep

public AttributeStep(java.lang.String dimensionName,
                     java.lang.String attribute,
                     java.util.Vector attributeValues)

Constructor that specifies all arguments except a hierarchy, levels, and an operator.

Parameters:

dimensionName - The name of the dimension.

attribute - The name of the attribute.

attributeValues - The vector of attribute members.

AttributeStep

public AttributeStep(java.lang.String dimensionName,
                     java.lang.String attribute,
                     java.util.Vector attributeValues,
                     int attributeOp)

Constructor that specifies all arguments except a hierarchy and levels.

Parameters:

dimensionName - The name of the dimension.

attribute - The name of the attribute.

attributeValues - The vector of attribute members.

attributeOp - A constant that represents the operator. The valid constants are OP_EQUAL and OP_NOT_EQUAL.

See Also:

OP_EQUAL, OP_NOT_EQUAL

AttributeStep

public AttributeStep(java.lang.String dimensionName,
                     java.lang.String hierarchy,
                     java.util.Vector levels,
                     java.lang.String attribute,
                     java.util.Vector attributeValues,
                     int attributeOp)

Constructor that specifies all arguments.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

levels - The vector of levels.

attribute - The name of the attribute.

attributeValues - The vector of attribute members.

attributeOp - A constant that represents the operator. The valid constants are OP_EQUAL and OP_NOT_EQUAL.

See Also:

OP_EQUAL, OP_NOT_EQUAL

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 ConditionStep

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

Overrides:

clone in class ConditionStep

Returns:

A copy of this AttributeStep object.

Throws:

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

copyFrom

public void copyFrom(Step step)

Copies all fields from the specified Step object.

Overrides:

copyFrom in class ConditionStep

Parameters:

step - The Step object from which to copy fields.

toString

public java.lang.String toString()

Generates the string representation of this AttributeStep object.

Overrides:

toString in class ConditionStep

Returns:

The string representation of this AttributeStep object.

setAttribute

public void setAttribute(java.lang.String Attribute)

Specifies the attribute of this AttributeStep object.

Parameters:

Attribute - The name of the attribute.

getAttribute

public java.lang.String getAttribute()

Retrieves the attribute of this AttributeStep object.

Returns:

The name of the attribute.

setAttributeValues

public void setAttributeValues(java.util.Vector AttributeValues)

Specifes the members of this AttributeStep object.

Parameters:

AttributeValues - The vector of attribute members.

getAttributeValues

public java.util.Vector getAttributeValues()

Retrieves the members of this AttributeStep object.

Returns:

The vector of attribute members.

setAttributeOp

public void setAttributeOp(int op)

Specifies the operator for this AttributeStep object.

Parameters:

op - A constant that represents the operator. The valid constants are OP_EQUAL and OP_NOT_EQUAL.

See Also:

OP_EQUAL, OP_NOT_EQUAL

getAttributeOp

public int getAttributeOp()

Retrieves the operator for this AttributeStep object.

Returns:

A constant that represents the operator. The valid constants are OP_EQUAL and OP_NOT_EQUAL.

See Also:

OP_EQUAL, OP_NOT_EQUAL

getViewClassName

public java.lang.String getViewClassName()

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