|
SAP BI Java SDK | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An expression in the Filter category, retains objects out of an input set based on a ranking condition such as those listed below.
Method Summary | |
IBIInputReference |
getNumericExpression()
An InputReference that refers to a numeric expression,
according to which the base set is sorted either in ascending or descending
direction, and which is used to evaluate the ranking condition. |
IBIRankType |
getRankType()
Identifies the type of ranking condition that is applied with this filter. |
IBILiteralReference |
getValue()
An InputReference that refers to a literal used in the
ranking condition either as an index, percentage, or threshold value. |
void |
setNumericExpression(IBIInputReference newValue)
An InputReference that refers to a numeric expression,
according to which the base set is sorted either in ascending or descending
direction, and which is used to evaluate the ranking condition. |
void |
setRankType(IBIRankType newValue)
Identifies the type of ranking condition that is applied with this filter. |
void |
setValue(IBILiteralReference newValue)
An InputReference that refers to a literal used in the
ranking condition either as an index, percentage, or threshold value. |
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.msx.IBIFilter |
getJoinType, setJoinType |
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.msx.IBIMemberSetExpression |
getCompositeMemberSetExpression, getMemberSet |
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.main.IBISetExpression |
isActive, setActive |
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.main.IBIIdentifiable |
getDescription, getId, getLabel, setDescription, setId, setLabel |
Methods inherited from interface javax.jmi.reflect.RefObject |
refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite |
Methods inherited from interface javax.jmi.reflect.RefFeatured |
refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue |
Methods inherited from interface javax.jmi.reflect.RefBaseObject |
equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints |
Methods inherited from interface com.sap.ip.bi.sdk.dac.olap.query.tsx.IBITupleSetExpression |
getCompositeTupleSetExpression, getTupleSet |
Method Detail |
public IBIRankType getRankType() throws javax.jmi.reflect.JmiException
Identifies the type of ranking condition that is applied with this filter. Can be one of the following:
The meaning of the value
parameter depends
on the rankType
. For TOPCOUNT, TOPPERCENT, BOTTOMCOUNT, and
BOTTOMPERCENT, the value
parameter plays the role of an index
or a percentage, for example the number or percentage of objects that will
be retained from the base set.
For TOPSUM and BOTTOMSUM, the value
parameter plays the role of a threshold. Once the total for the objects
retained exceeds the threshold, all other objects are discarded.
public void setRankType(IBIRankType newValue) throws javax.jmi.reflect.JmiException
Identifies the type of ranking condition that is applied with this filter. Can be one of the following:
The meaning of the value
parameter depends
on the rankType
. For TOPCOUNT, TOPPERCENT, BOTTOMCOUNT, and
BOTTOMPERCENT, the value
parameter plays the role of an index
or a percentage, for example the number or percentage of objects that will
be retained from the base set.
For TOPSUM and BOTTOMSUM, the value
parameter plays the role of a threshold. Once the total for the objects
retained exceeds the threshold, all other objects are discarded.
public IBILiteralReference getValue() throws javax.jmi.reflect.JmiException
An InputReference
that refers to a literal used in the
ranking condition either as an index, percentage, or threshold value.
public void setValue(IBILiteralReference newValue) throws javax.jmi.reflect.JmiException
An InputReference
that refers to a literal used in the
ranking condition either as an index, percentage, or threshold value.
public IBIInputReference getNumericExpression() throws javax.jmi.reflect.JmiException
An InputReference
that refers to a numeric expression,
according to which the base set is sorted either in ascending or descending
direction, and which is used to evaluate the ranking condition.