Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.selection.calcStep
Class RankStep

java.lang.Object
  |
  +--oracle.dss.selection.step.Step
        |
        +--oracle.dss.selection.calcStep.CalcStep
              |
              +--oracle.dss.selection.calcStep.RankStep
All Implemented Interfaces:
java.lang.Cloneable, ObjectFactory, Persistable, java.io.Serializable, StringXMLizable, VectorClone

public class RankStep
extends CalcStep
implements java.lang.Cloneable, java.io.Serializable, Persistable

RankStep

See Also:
Serialized Form

Field Summary
static java.lang.String RANKORDER_ASCENDING
          Constant defining the rank order to be ascending
static java.lang.String RANKORDER_DESCENDING
          Constant defining the rank order to be descending
static java.lang.String WITHINTYPE_LEVEL
          Constant defining the type of the "within" operand.
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.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
RankStep()
          Default constructor for Rank 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 getRankDimension()
          Retrieves the dimension the rank is calculated upon.
 CalcValue getRankHierarchy()
          Retrieves the hierarchy the rank is calculated upon.
 CalcValue getRankMeasure()
          Retrieves the measure whose value is used to calculate the rank.
 CalcValue getRankOrder()
          Retrieves the order of the rank.
 CalcValue getRankWithinType()
          Retrieves the "within" bound type the rank 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 setRankDimension(CalcValue rankDimension)
          Sets the dimension the rank is calculated upon.
 void setRankHierarchy(CalcValue rankHierarchy)
          Sets the hierarchy the rank is calculated upon.
 void setRankMeasure(CalcValue rankMeasure)
          Sets the measure the rank is calculated upon.
 void setRankOrder(CalcValue rankOrder)
          Sets the order for the rank calculation.
 void setRankWithinType(CalcValue rankWithinType)
          Sets the "within" bound type the rank 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 RankStep object.

 

Methods inherited from class oracle.dss.selection.calcStep.CalcStep
copyProps, dump, getDescription, getDescription, getFolder, getID, getInstance, getMeasureDependencyIDs, 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

RANKORDER_ASCENDING

public static final java.lang.String RANKORDER_ASCENDING
Constant defining the rank order to be ascending

RANKORDER_DESCENDING

public static final java.lang.String RANKORDER_DESCENDING
Constant defining the rank order to be descending

WITHINTYPE_TOTAL

public static final java.lang.String WITHINTYPE_TOTAL
Constant defining the type of the "within" operand. Rank 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. Rank within the parent of the current member.

WITHINTYPE_LEVEL

public static final java.lang.String WITHINTYPE_LEVEL
Constant defining the type of the "within" operand. Rank within the specified level
Constructor Detail

RankStep

public RankStep()
Default constructor for Rank 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 rank 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.

getRankDimension

public CalcValue getRankDimension()
Retrieves the dimension the rank is calculated upon.
Returns:
CalcValue which represents the dimension for the Rank.

getRankHierarchy

public CalcValue getRankHierarchy()
Retrieves the hierarchy the rank is calculated upon.
Returns:
CalcValue which represents the hierarchy for the Rank.

getRankWithinType

public CalcValue getRankWithinType()
Retrieves the "within" bound type the rank is calculated upon.
Returns:
CalcValue which represents the "within" bound type for the Rank.

getRankMeasure

public CalcValue getRankMeasure()
Retrieves the measure whose value is used to calculate the rank.
Returns:
CalcValue which represents the measure for the Rank.

getRankOrder

public CalcValue getRankOrder()
Retrieves the order of the rank.
Returns:
CalcValue which represents the rank for the Rank calculation.

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.

setRankDimension

public void setRankDimension(CalcValue rankDimension)
Sets the dimension the rank is calculated upon.
Parameters:
dimension - A CalcValue value that represents the dimension the rank is calculated upon.

setRankHierarchy

public void setRankHierarchy(CalcValue rankHierarchy)
Sets the hierarchy the rank is calculated upon.
Parameters:
rankHierarchy - CalcValue which represents the hierarchy for the Rank.

setRankWithinType

public void setRankWithinType(CalcValue rankWithinType)
Sets the "within" bound type the rank is calculated upon.
Parameters:
rankWithinType - CalcValue which represents the "within" bound type for the Rank.

setRankMeasure

public void setRankMeasure(CalcValue rankMeasure)
Sets the measure the rank is calculated upon.
Parameters:
rankMeasure - CalcValue which represents the measure for the Rank calculation.

setRankOrder

public void setRankOrder(CalcValue rankOrder)
Sets the order for the rank calculation.
Parameters:
rankOrder - CalcValue which represents the order for the Rank 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

toString

public java.lang.String toString()
Generates the string representation of this RankStep object.
Overrides:
toString in class CalcStep
Returns:
The string representation of this RankStep object.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.