oracle.dss.selection.calcStep
Class TimeCalcStep

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TimeCumulativeTotalStep, TimeLagLeadStep, TimeMovingStep, TimeYearToDateStep

public class TimeCalcStep

extends CalcStep

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

TimeCalcStep

See Also:

Serialized Form

Field Summary

static java.lang.String	TIMECALC_CALENDAR_YEAR The calendar year of the time dimension
static java.lang.String	TIMECALC_DAY The day level in the time dimension
static java.lang.String	TIMECALC_FISCAL_YEAR The fiscal year of the time dimension
static java.lang.String	TIMECALC_MONTH The month level in the time dimension
static java.lang.String	TIMECALC_PERIOD Relative to the current time period level
static java.lang.String	TIMECALC_QUARTER The quarter level in the time dimension
static java.lang.String	TIMECALC_TIME_DIMENSION Tags for the operand elements in XML stream.
static java.lang.String	TIMECALC_TIME_HIERARCHY Tags for the operand elements in XML stream.
static java.lang.String	TIMECALC_WEEK The week level in the time dimension
static java.lang.String	TIMECALC_YEAR The year level in the time dimension

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

TimeCalcStep()
Default constructor for base Time 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	getMeasure() Retrieves the measure for the time calculation
java.util.Vector	getMeasureDependencyIDs(java.lang.String measDim) Get measure unique ID dependencies in this step
CalcValue	getTimeDimension() Retrieves the dimension the calculation is performed on.
CalcValue	getTimeHierarchy() Retrieves the hierarchy the calculation is performed on.
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	setMeasure(CalcValue measure) Sets the measure for the time calculation
void	setTimeDimension(CalcValue calcValueDimension) Sets the time dimension for the calculation.
void	setTimeHierarchy(CalcValue calcValueHierarchy) Sets the hierarchy for the calculation.
void	setXML( context, java.lang.Object node) Sets the XML representation of the object.
java.lang.String	toString() Generates the string representation of this TimeCalcStep 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

TIMECALC_PERIOD

public static final java.lang.String TIMECALC_PERIOD

Relative to the current time period level

TIMECALC_DAY

public static final java.lang.String TIMECALC_DAY

The day level in the time dimension

TIMECALC_WEEK

public static final java.lang.String TIMECALC_WEEK

The week level in the time dimension

TIMECALC_MONTH

public static final java.lang.String TIMECALC_MONTH

The month level in the time dimension

TIMECALC_QUARTER

public static final java.lang.String TIMECALC_QUARTER

The quarter level in the time dimension

TIMECALC_YEAR

public static final java.lang.String TIMECALC_YEAR

The year level in the time dimension

TIMECALC_TIME_DIMENSION

public static final java.lang.String TIMECALC_TIME_DIMENSION

Tags for the operand elements in XML stream.

TIMECALC_TIME_HIERARCHY

public static final java.lang.String TIMECALC_TIME_HIERARCHY

Tags for the operand elements in XML stream.

TIMECALC_CALENDAR_YEAR

public static final java.lang.String TIMECALC_CALENDAR_YEAR

The calendar year of the time dimension

TIMECALC_FISCAL_YEAR

public static final java.lang.String TIMECALC_FISCAL_YEAR

The fiscal year of the time dimension

Constructor Detail

TimeCalcStep

public TimeCalcStep()

Default constructor for base Time 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 time 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

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.

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

getViewClassName

public java.lang.String getViewClassName()

Retrieves the view class name name associated with the calc.

Overrides:

getViewClassName in class CalcStep

Returns:

String which represents the view class name.

getMeasure

public CalcValue getMeasure()

Retrieves the measure for the time calculation

Returns:

CalcValue which represents the measure for the calculation

setMeasure

public void setMeasure(CalcValue measure)

Sets the measure for the time calculation

Parameters:

measure - A CalcValue value that represents the measure the for the calculation

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

getTimeDimension

public CalcValue getTimeDimension()

Retrieves the dimension the calculation is performed on.

Returns:

CalcValue which represents the dimension.

setTimeDimension

public void setTimeDimension(CalcValue calcValueDimension)

Sets the time dimension for the calculation.

Parameters:

calcValueDimension - A CalcValue value that represents the dimension.

getTimeHierarchy

public CalcValue getTimeHierarchy()

Retrieves the hierarchy the calculation is performed on.

Returns:

CalcValue which represents the dimension.

setTimeHierarchy

public void setTimeHierarchy(CalcValue calcValueHierarchy)

Sets the hierarchy for the calculation.

Parameters:

calcValueHierarchy - A CalcValue value that represents the hierachy.

toString

public java.lang.String toString()

Generates the string representation of this TimeCalcStep object.

Overrides:

toString in class CalcStep

Returns:

The string representation of this TimeCalcStep object.