oracle.dss.selection.calcStep
Class TimeCumulativeTotalStep

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

All Implemented Interfaces:

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

public class TimeCumulativeTotalStep

extends TimeCalcStep

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

TimeCumulativeTotalStep

See Also:

Serialized Form

Field Summary

static java.lang.String	WITHINTYPE_PARENT Constant defining the type of the "within" operand.
static java.lang.String	WITHINTYPE_TOTAL Constant defining the type of the "within" operand.

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

TIMECALC_CALENDAR_YEAR, TIMECALC_DAY, TIMECALC_FISCAL_YEAR, TIMECALC_MONTH, TIMECALC_PERIOD, TIMECALC_QUARTER, TIMECALC_TIME_DIMENSION, TIMECALC_TIME_HIERARCHY, TIMECALC_WEEK, TIMECALC_YEAR

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

TimeCumulativeTotalStep()
Default constructor for Time Cumulative Total 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	getTotalWithinType() Retrieves the "within" bound type the cumulative total 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	setTotalWithinType(CalcValue totalWithinType) Sets the "within" bound type the cumulative total 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 TimeCumulativeTotalStep object.

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

getMeasure, getMeasureDependencyIDs, getTimeDimension, getTimeHierarchy, setMeasure, setTimeDimension, setTimeHierarchy

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

WITHINTYPE_TOTAL

public static final java.lang.String WITHINTYPE_TOTAL

Constant defining the type of the "within" operand. Cumulative Total within the level containing the current member

WITHINTYPE_PARENT

public static final java.lang.String WITHINTYPE_PARENT

Constant defining the type of the "within" operand. Cumulative Total within the parent of the current member.

Constructor Detail

TimeCumulativeTotalStep

public TimeCumulativeTotalStep()

Default constructor for Time Cumulative Total calculation step.

Method Detail

clone

public java.lang.Object clone()

Implements the clone method.

Overrides:

clone in class TimeCalcStep

Returns:

Object which represents a clone of this time cumulative total calculation object.

equals

public boolean equals(java.lang.Object obj)

Tests this Step for true equality

Overrides:

equals in class TimeCalcStep

Parameters:

obj - Step to compare it to

Returns:

true if completely internally equal

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 TimeCalcStep

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 TimeCalcStep

Returns:

String which represents the evaluator class name.

getTotalWithinType

public CalcValue getTotalWithinType()

Retrieves the "within" bound type the cumulative total is calculated upon.

Returns:

CalcValue which represents the "within" bound type for the Cumulative Total.

getViewClassName

public java.lang.String getViewClassName()

Retrieves the view class name name associated with the calc.

Overrides:

getViewClassName in class TimeCalcStep

Returns:

String which represents the view class name.

setTotalWithinType

public void setTotalWithinType(CalcValue totalWithinType)

Sets the "within" bound type the cumulative total is calculated upon.

Parameters:

totalWithinType - CalcValue which represents the "within" bound type for the Cumulative Total.

toString

public java.lang.String toString()

Generates the string representation of this TimeCumulativeTotalStep object.

Overrides:

toString in class TimeCalcStep

Returns:

The string representation of this TimeCumulativeTotalStep object.

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 TimeCalcStep

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 TimeCalcStep

Parameters:

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

node - The XML representation of the object