oracle.dss.selection.calcStep
Class RelationshipCalcStep

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

All Implemented Interfaces:

java.lang.Cloneable, ObjectFactory, Persistable, java.io.Serializable, StringXMLizable, VectorClone

public class RelationshipCalcStep

extends CalcStep

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

RelationshipCalcStep

See Also:

Serialized Form

Fields inherited from class oracle.dss.selection.calcStep.CalcStep

_DEBUG, CALCTYPE_ADDITION, CALCTYPE_ARITHMETIC_END, CALCTYPE_ARITHMETIC_START, CALCTYPE_CUMULATIVETOTAL, CALCTYPE_DIFFERENCE, CALCTYPE_DIVISION, CALCTYPE_END, CALCTYPE_INDEX, CALCTYPE_LAG, CALCTYPE_LAGDIFFERENCE, CALCTYPE_LAGPERCENT, CALCTYPE_LEAD, CALCTYPE_MOVINGAVERAGE, CALCTYPE_MOVINGMAXIMUM, CALCTYPE_MOVINGMINIMUM, CALCTYPE_MOVINGTOTAL, CALCTYPE_MULTIPLICATION, CALCTYPE_PERCENTDIFFERENCE, CALCTYPE_PERCENTMARKUP, CALCTYPE_PERCENTVARIANCE, CALCTYPE_RANK, CALCTYPE_RATIO, CALCTYPE_SHARE, CALCTYPE_START, CALCTYPE_SUBTRACTION, CALCTYPE_VARIANCE, CALCTYPE_YEARTODATE, OPERAND_BASE_MEASURE, OPERAND_DIMENSION, OPERAND_DIMMEMBER, OPERAND_HIERARCHY, OPERAND_LEFT, OPERAND_LEVEL, OPERAND_MEASURE, OPERAND_MEMBER, OPERAND_MEMBER_DIMMEMBER, OPERAND_MEMBER_LEVEL, OPERAND_MEMBERTYPE, OPERAND_RANKORDER, OPERAND_RIGHT, OPERAND_TARGET_MEASURE, OPERAND_TIME_DIMMEMBER, STRING_DELIMITER

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

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

Constructor Summary

RelationshipCalcStep()
Default constructor for Relationship calculation step.

Method Summary

java.lang.Object	clone() Implements the clone method.
boolean	equals(java.lang.Object obj) Tests this Step for true equality
java.lang.Class	getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this Step object.
java.lang.String	getEvaluatorClassName() Retrieves the evaluator class name name associated with the calc.
CalcValue	getLeftOperand() Retrieves the left side operand.
java.util.Vector	getMeasureDependencyIDs(java.lang.String measDim) Get measure unique ID dependencies in this step
CalcValue	getRightOperand() Retrieves the right side operand.
java.lang.String	getViewClassName() Retrieves the view class name name associated with the calc.
java.lang.Object	getXML( context) Returns the XML representation of the object.
void	setLeftOperand(CalcValue leftOperand) Sets the left side operand.
void	setRightOperand(CalcValue rightOperand) Sets the right side operand.
void	setXML( context, java.lang.Object node) Sets the XML representation of the object.
java.lang.String	toString() Generates the string representation of this RelationshipCalcStep object.

Methods inherited from class oracle.dss.selection.calcStep.CalcStep

copyProps, dump, getDescription, getDescription, getFolder, getID, getInstance, getNumberFormatString, getPersistableAttributes, getPersistableComponents, getType, getXMLAsString, initialize, isType, setDescription, setFolder, setID, setNumberFormatString, setPersistableAttributes, setPersistableComponents, setType, setXMLAsString, updateCalcValue

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

addPropertyChangeListener, copyFrom, getAction, 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

Methods inherited from interface oracle.dss.util.persistence.Persistable

getPersistableAttributes, getPersistableComponents, initialize, setPersistableAttributes, setPersistableComponents

Methods inherited from interface oracle.dss.util.persistence.StringXMLizable

getXMLAsString, setXMLAsString

Methods inherited from interface oracle.dss.bicontext.ObjectFactory

getObjectInstanceClassName, setObjectInstanceClassName

Constructor Detail

RelationshipCalcStep

public RelationshipCalcStep()

Default constructor for Relationship calculation step.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Tests this Step for true equality

Overrides:

equals in class CalcStep

Parameters:

obj - Step to compare it to

Returns:

true if completely internally equal

getMeasureDependencyIDs

public java.util.Vector getMeasureDependencyIDs(java.lang.String measDim)

Get measure unique ID dependencies in this step

Overrides:

getMeasureDependencyIDs in class CalcStep

Parameters:

measDim - the measure dimension ID for those steps that need to know if they have measure members

Returns:

Vector of measures this step depends on, as unique ID Strings null if none

getLeftOperand

public CalcValue getLeftOperand()

Retrieves the left side operand.

Returns:

CalcValue which represents the left side operand.

setLeftOperand

public void setLeftOperand(CalcValue leftOperand)

Sets the left side operand.

Parameters:

leftOperand - A CalcValue value that represents the left side operand.

getRightOperand

public CalcValue getRightOperand()

Retrieves the right side operand.

Returns:

CalcValue which represents the right side operand.

setRightOperand

public void setRightOperand(CalcValue rightOperand)

Sets the right side operand.

Parameters:

rightOperand - A CalcValue value that represents the right side operand.

clone

public java.lang.Object clone()

Implements the clone method.

Overrides:

clone in class CalcStep

Returns:

Object which represents a clone of this relationship calculation object.

getViewClassName

public java.lang.String getViewClassName()

Retrieves the view class name name associated with the calc. Note: If the view class name is null, the Template page in the wizard will be omitted, and the user will be taken directly to the Custom Formula Editor page

Overrides:

getViewClassName in class CalcStep

Returns:

String which represents the view class name.

getEvaluatorClassName

public java.lang.String getEvaluatorClassName()

Retrieves the evaluator class name name associated with the calc.

Overrides:

getEvaluatorClassName in class CalcStep

Returns:

String which represents the evaluator class name.

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.

Overrides:

getEvaluatorClass in class Step

Returns:

The Class object.

Throws:

SelectionException - If the StepEvaluator class is not found.

getXML

public java.lang.Object getXML( context)

Returns the XML representation of the object. Note that XML representation can be of any type. The XML returned could contain only partial updates of the states. However, it is up to the implementor to decide whether this should be supported. (i.e. Not mandatory)

Overrides:

getXML in class CalcStep

Parameters:

context - The control settings that is send by the container (caller)

Returns:

The XML representation of the object

See Also:

ObjectScope

setXML

public void setXML( context,
                   java.lang.Object node)

Sets the XML representation of the object. Note that XML representation can be of any type.

Overrides:

setXML in class CalcStep

Parameters:

context - The control settings that is send by the container (caller)

node - The XML representation of the object

toString

public java.lang.String toString()

Generates the string representation of this RelationshipCalcStep object.

Overrides:

toString in class CalcStep

Returns:

The string representation of this RelationshipCalcStep object.