|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dss.selection.step.Step | +--oracle.dss.selection.step.ConditionStep | +--oracle.dss.selection.step.MeasConditionStep | +--oracle.dss.selection.step.TwoMeasConditionStep | +--oracle.dss.selection.step.TwoMeasNumStep
Represents a step in a selection that specifies members of a particular dimension based on the way that data values in one measure compare with data values in a second measure that have been modified by adding, subtracting, multiplying or dividing by a specified number. For example, it might specify Cities whose Sales exceeded Forecast by 10 percent.
Field Summary | |
static int |
OP_DIVIDE The divide number operator. |
static int |
OP_EQUAL The equal to operator. |
static int |
OP_GREATER The greater than operator. |
static int |
OP_GREATER_EQUAL The greater than or equal to operator. |
static int |
OP_LESS The less than operator. |
static int |
OP_LESS_EQUAL The less than or equal to operator. |
static int |
OP_MINUS The minus number operator. |
static int |
OP_NOT_EQUAL The not equal to operator. |
static int |
OP_PLUS The plus number operator. |
static int |
OP_TIMES The times number operator. |
static java.lang.String |
STEP_STATE State Management support |
Fields inherited from class oracle.dss.selection.step.Step |
ADD, BASE_STATE_INDEX, CURRENT_STATE_INDEX, KEEP, LONG, MEDIUM, REMOVE, SELECT, SHORT |
Constructor Summary | |
TwoMeasNumStep() Constructor that does not specify any arguments. | |
TwoMeasNumStep(java.lang.String dimensionName) Constructor that specifies a dimension. | |
TwoMeasNumStep(java.lang.String dimensionName, java.lang.String firstMeasure, java.lang.String secondMeasure, int cmpOperator, int numOperator, java.lang.Float offsetNum, boolean isPercent) Constructor that specifies all arguments except a hierarchy and levels. | |
TwoMeasNumStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.String firstMeasure, java.lang.String secondMeasure, int cmpOperator) Constructor that specifies all arguments for the non-offset measure comparison | |
TwoMeasNumStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.String firstMeasure, java.lang.String secondMeasure, int cmpOperator, int numOperator, java.lang.Float offsetNum, boolean isPercent) Constructor that specifies all arguments. |
Method Summary | |
void |
copyFrom(Step step) Copies all fields from the specified Step object. |
boolean |
equals(java.lang.Object obj) Indicates whether one Step object is equivalent to another Step object. |
int |
getCmpOperator() Retrieves the comparison operator for this TwoMeasNumStep object. |
java.lang.Class |
getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this TwoMeasNumStep object. |
int |
getNumOperator() Retrieves the number operator for this TwoMeasNumStep object. |
java.lang.Float |
getOffsetNum() Retrieves the offset number, which represents the number to use to modify the data values in the second measure for the comparison in this TwoMeasNumStep object. |
java.lang.String |
getViewClassName() Retrieves the name of the StepView class to use to edit this TwoMeasNumStep object. |
boolean |
isOffsetCalculated() Indicates whether the comparison measure should be offset by the given offset number. |
boolean |
isPercent() Indicates whether the offset number is a percentage. |
void |
setCmpOperator(int newCmpOperator) Specifies the comparison operator for this TwoMeasNumStep object. |
void |
setNumOperator(int newNumOperator) Specifies the number operator for this TwoMeasNumStep object. |
void |
setOffsetCalculated(boolean isCalculated) Specifies whether the comparison measure should be offset by the given offset number. |
void |
setOffsetNum(java.lang.Float newOffsetNum) Specifies the offset number, which represents the number to use to modify the data values in the second measure for the comparison in this TwoMeasNumStep object. |
void |
setPercent(boolean isPercent) Specifies whether the offset number is a percentage. |
java.lang.String |
toString() Generates the string representation of this TwoMeasNumStep object. |
Methods inherited from class oracle.dss.selection.step.TwoMeasConditionStep |
clone, getCmpMeasure, getComparisonQDR, setCmpMeasure, setComparisonQDR |
Methods inherited from class oracle.dss.selection.step.MeasConditionStep |
getMeasure, setMeasure |
Methods inherited from class oracle.dss.selection.step.ConditionStep |
getLevels, setLevels |
Methods inherited from class oracle.dss.selection.step.Step |
addPropertyChangeListener, getAction, getDescription, 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 |
Field Detail |
public static final int OP_GREATER
public static final int OP_LESS
public static final int OP_GREATER_EQUAL
public static final int OP_LESS_EQUAL
public static final int OP_EQUAL
public static final int OP_NOT_EQUAL
public static final int OP_PLUS
public static final int OP_MINUS
public static final int OP_TIMES
public static final int OP_DIVIDE
public static final java.lang.String STEP_STATE
Constructor Detail |
public TwoMeasNumStep()
public TwoMeasNumStep(java.lang.String dimensionName)
dimensionName
- The name of the dimension.public TwoMeasNumStep(java.lang.String dimensionName, java.lang.String firstMeasure, java.lang.String secondMeasure, int cmpOperator, int numOperator, java.lang.Float offsetNum, boolean isPercent) throws InvalidStepArgException
dimensionName
- The name of the dimension.firstMeasure
- The name of the first measure.secondMeasure
- The name of the second measure.cmpOperator
- A constant that represents the comparison operator. The valid constants are:
OP_EQUAL
OP_GREATER
OP_GREATER_EQUAL
OP_LESS
OP_LESS_EQUAL
OP_NOT_EQUAL
numOperator
- A constant that represents the number operator. The valid constants are:
OP_DIVIDE
OP_MINUS
OP_PLUS
OP_TIMES
offsetNum
- The offset number, which represents the number to use to modify the data values in the second measure for the comparison.isPercent
- true
if the offset number is a percentage; false
if it is not.InvalidStepArgException
- If an argument is not valid.OP_DIVIDE
, OP_MINUS
, OP_PLUS
, OP_TIMES
, OP_EQUAL
, OP_GREATER
, OP_GREATER_EQUAL
, OP_LESS
, OP_LESS_EQUAL
, OP_NOT_EQUAL
public TwoMeasNumStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.String firstMeasure, java.lang.String secondMeasure, int cmpOperator) throws InvalidStepArgException
dimensionName
- The name of the dimension.hierarchy
- The name of the hierarchy.levels
- The vector of levels.firstMeasure
- The name of the first measure.secondMeasure
- The name of the second measure.cmpOperator
- A constant that represents the comparison operator. The valid constants are:
OP_EQUAL
OP_GREATER
OP_GREATER_EQUAL
OP_LESS
OP_LESS_EQUAL
OP_NOT_EQUAL
InvalidStepArgException
- If an argument is not valid.OP_EQUAL
, OP_GREATER
, OP_GREATER_EQUAL
, OP_LESS
, OP_LESS_EQUAL
, OP_NOT_EQUAL
public TwoMeasNumStep(java.lang.String dimensionName, java.lang.String hierarchy, java.util.Vector levels, java.lang.String firstMeasure, java.lang.String secondMeasure, int cmpOperator, int numOperator, java.lang.Float offsetNum, boolean isPercent) throws InvalidStepArgException
dimensionName
- The name of the dimension.hierarchy
- The name of the hierarchy.levels
- The vector of levels.firstMeasure
- The name of the first measure.secondMeasure
- The name of the second measure.cmpOperator
- A constant that represents the comparison operator. The valid constants are:
OP_EQUAL
OP_GREATER
OP_GREATER_EQUAL
OP_LESS
OP_LESS_EQUAL
OP_NOT_EQUAL
numOperator
- A constant that represents the number operator. The valid constants are:
OP_DIVIDE
OP_MINUS
OP_PLUS
OP_TIMES
offsetNum
- The offset number, which represents the number to use to modify the data values in the second measure for the comparison.isPercent
- true
if the offset number is a percentage; false
if it is not.InvalidStepArgException
- If an argument is not valid.OP_DIVIDE
, OP_MINUS
, OP_PLUS
, OP_TIMES
, OP_EQUAL
, OP_GREATER
, OP_GREATER_EQUAL
, OP_LESS
, OP_LESS_EQUAL
, OP_NOT_EQUAL
Method Detail |
public boolean equals(java.lang.Object obj)
Step
object is equivalent to another Step
object.equals
in class TwoMeasConditionStep
obj
- The Step
object with which to compare.true
if the objects are completely equal; false
if they are not.public void copyFrom(Step step)
Step
object.copyFrom
in class TwoMeasConditionStep
step
- The Step
object from which to copy the fields.public java.lang.String toString()
TwoMeasNumStep
object.toString
in class MeasConditionStep
TwoMeasNumStep
object.public void setCmpOperator(int newCmpOperator) throws InvalidStepArgException
TwoMeasNumStep
object.newCmpOperator
- A constant that represents the comparison operator. The valid constants are:
OP_EQUAL
OP_GREATER
OP_GREATER_EQUAL
OP_LESS
OP_LESS_EQUAL
OP_NOT_EQUAL
InvalidStepArgException
- If an argument is not valid.OP_EQUAL
, OP_GREATER
, OP_GREATER_EQUAL
, OP_LESS
, OP_LESS_EQUAL
, OP_NOT_EQUAL
public int getCmpOperator()
TwoMeasNumStep
object.OP_EQUAL
OP_GREATER
OP_GREATER_EQUAL
OP_LESS
OP_LESS_EQUAL
OP_NOT_EQUAL
OP_EQUAL
, OP_GREATER
, OP_GREATER_EQUAL
, OP_LESS
, OP_LESS_EQUAL
, OP_NOT_EQUAL
public void setOffsetCalculated(boolean isCalculated)
isCalculated
- true
if the comparison measure should be offset using the specified numeric operator and offset number; false
if the comparison measure should not be offset.public boolean isOffsetCalculated()
false
if it is not.public void setNumOperator(int newNumOperator) throws InvalidStepArgException
TwoMeasNumStep
object.newNumOperator
- A constant that represents the number operator. The valid constants are:
OP_DIVIDE
OP_MINUS
OP_PLUS
OP_TIMES
InvalidStepArgException
- If an argument is not valid.OP_DIVIDE
, OP_MINUS
, OP_PLUS
, OP_TIMES
public int getNumOperator()
TwoMeasNumStep
object.OP_DIVIDE
OP_MINUS
OP_PLUS
OP_TIMES
OP_DIVIDE
, OP_MINUS
, OP_PLUS
, OP_TIMES
public void setOffsetNum(java.lang.Float newOffsetNum)
TwoMeasNumStep
object.newOffsetNum
- The offset number.public java.lang.Float getOffsetNum()
TwoMeasNumStep
object.public void setPercent(boolean isPercent)
isPercent
- true
if the offset number is a percentage; true
if it is not.public boolean isPercent()
true
if it is not.public java.lang.String getViewClassName()
StepView
class to use to edit this TwoMeasNumStep
object. If the name is null, retrieves the base StepView
class. Overrides the same method in the base Step
class.getViewClassName
in class Step
StepView
class.public java.lang.Class getEvaluatorClass() throws SelectionException
StepEvaluator
class object that is associated with this TwoMeasNumStep
object. The QueryServer
object uses this class to instantiate the appropriate StepEvaluator
object.getEvaluatorClass
in class Step
Class
object.SelectionException
- If the StepEvaluator
class is not found.
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |