oracle.dss.selection.calcStep
Class RelationshipShareStep

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

All Implemented Interfaces:

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

public class RelationshipShareStep

extends CalcStep

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

RelationshipShareStep

See Also:

Serialized Form

Field Summary

static java.lang.String	MEMBERTYPE_DIMMEMBER Constant defining the type of the "relative to member" operand.
static java.lang.String	MEMBERTYPE_PARENT Constant defining the type of the "relative to member" operand.
static java.lang.String	MEMBERTYPE_TOTAL Constant defining the type of the "relative to member" operand.

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

RelationshipShareStep()
Default constructor for Relationship Share 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.
java.util.Vector	getMeasureDependencyIDs(java.lang.String measDim) Get measure unique ID dependencies in this step
CalcValue	getShareDimension() Retrieves the dimension the share is calculated upon.
CalcValue	getShareDimensionMember() Retrieves the dimension member the share is calculated upon.
CalcValue	getShareHierarchy() Retrieves the hierarchy the share is calculated upon.
CalcValue	getShareMeasure() Retrieves the measure the share is calculated upon.
CalcValue	getShareMemberType() Retrieves the "relative to member" type the share is calculated upon.
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	setShareDimension(CalcValue dimension) Sets the dimension the share is calculated upon.
void	setShareDimensionMember(CalcValue dimensionMember) Sets the dimension member the share is calculated upon.
void	setShareHierarchy(CalcValue hierarchy) Sets the hierarchy the share is calculated upon.
void	setShareMeasure(CalcValue measure) Sets the measure the share is calculated upon.
void	setShareMemberType(CalcValue memberType) Sets the "relative to member" type the share is calculated upon.
void	setXML( context, java.lang.Object node) Sets the XML representation of the object.
java.lang.String	toString() Generates the string representation of this RelationshipShareStep 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

Field Detail

MEMBERTYPE_TOTAL

public static final java.lang.String MEMBERTYPE_TOTAL

Constant defining the type of the "relative to member" operand. Share relative to total of the level associated with the current member.

MEMBERTYPE_PARENT

public static final java.lang.String MEMBERTYPE_PARENT

Constant defining the type of the "relative to member" operand. Share relative to parent of the current member.

MEMBERTYPE_DIMMEMBER

public static final java.lang.String MEMBERTYPE_DIMMEMBER

Constant defining the type of the "relative to member" operand. Share relative to the specified dimension member.

Constructor Detail

RelationshipShareStep

public RelationshipShareStep()

Default constructor for Relationship Share calculation step.

Method Detail

clone

public java.lang.Object clone()

Implements the clone method.

Overrides:

clone in class CalcStep

Returns:

Object which represents a clone of this relationship share calculation object.

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

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.

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.

getShareDimension

public CalcValue getShareDimension()

Retrieves the dimension the share is calculated upon.

Returns:

CalcValue which represents the dimension for the Share.

getShareDimensionMember

public CalcValue getShareDimensionMember()

Retrieves the dimension member the share is calculated upon.

Returns:

CalcValue which represents the dimension member for the Share.

getShareHierarchy

public CalcValue getShareHierarchy()

Retrieves the hierarchy the share is calculated upon.

Returns:

CalcValue which represents the hierarchy for the Share.

getShareMeasure

public CalcValue getShareMeasure()

Retrieves the measure the share is calculated upon.

Returns:

CalcValue which represents the measure for the Share.

getShareMemberType

public CalcValue getShareMemberType()

Retrieves the "relative to member" type the share is calculated upon.

Returns:

CalcValue which represents the "relative to member" for the Share.

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.

setShareDimension

public void setShareDimension(CalcValue dimension)

Sets the dimension the share is calculated upon.

Parameters:

Dimension - A CalcValue value that represents the dimension the share is calculated upon.

setShareDimensionMember

public void setShareDimensionMember(CalcValue dimensionMember)

Sets the dimension member the share is calculated upon.

Parameters:

dimensionMember - A CalcValue value that represents the dimension member the share is calculated upon.

setShareHierarchy

public void setShareHierarchy(CalcValue hierarchy)

Sets the hierarchy the share is calculated upon.

Parameters:

shareHierarchy - A CalcValue value that represents the hierarchy the share is calculated upon.

setShareMeasure

public void setShareMeasure(CalcValue measure)

Sets the measure the share is calculated upon.

Parameters:

measureShare - A CalcValue value that represents the measure the share is calculated upon.

setShareMemberType

public void setShareMemberType(CalcValue memberType)

Sets the "relative to member" type the share is calculated upon.

Parameters:

memberShare - A CalcValue value that represents the "relative to member" the share is calculated upon.

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

Overrides:

toString in class CalcStep

Returns:

The string representation of this RelationshipShareStep object.