com.sap.ip.bi.sdk.dac.olap.query

Interface IBICommandProcessor

public interface IBICommandProcessor

The OLAP Command Processor, which provides a simplified command API to dynamically change the status of an OLAP query. An OLAP query is created with the IBIMainFactory.createQuery(Cube) method. This query can be executed "as-is" in its default state, however in this state it is very unspecific. If nothing additional is specified, in its initial state a query selects all dimensions on the slicer axis without any restrictions, and the measure dimension is assigned with all its measures selected to the columns axis. This query selects a single cell per measure, for which all dimensions are filtered to their default members, which are the ALL MEMBERS in case of ODBO.

The methods of IBICommandProcessor allow you to control many details of a query, such as layout and filters, dynamically at runtime without rebuilding a query from scratch. The implementation of the methods manipulate the more complex low-level query object model. You can therefore think of IBICommandProcessor as a set of macros that simplify the manipulation of the query model object tree.

Since:

1.0

Field Summary

static int	COLUMNS_AXIS_INDEX The constant which represents the columns axis and can be used for the moveDimension command.
static int	ROWS_AXIS_INDEX The constant which represents the rows axis and can be used for the moveDimension command.
static int	SLICER_AXIS_INDEX The constant which represents the slicer axis and can be used for the moveDimension command.

Method Summary

IBICalculatedMember	addCalculatedMember(org.omg.cwm.analysis.olap.Dimension dimension, IBIInputReference formula, int solveOrder) Creates an IBICalculatedMember for the specified dimension based on the specified formula and adds it to the member set of the dimension.
IBIDimensionMembers	addDimensionMembers(org.omg.cwm.analysis.olap.Dimension dimension) Adds all members of the specified dimension to the dimensions member set.
IBILevelMembers	addLevelMembers(org.omg.cwm.analysis.olap.Level level) Adds all members of the specified level to the dimensions member set.
void	addMember(IBIMember member) Adds a single member to the member set of the dimension to which the member belongs.
void	addMemberList(IBIMemberList memberList) Adds a member list to the member set of the dimension to which the members of the member list belong.
void	addRange(IBIRange memberRange) Adds a member range to the member set of the dimension to which the members of the member range belong.
void	addSapVariableValue(IBISapMemberVariable variable, IBISapRangeSignType sign, IBIRelationalOperatorType option, IBIMember low, IBIMember high) Adds a variable value range specification for an SAP variable of type IBISapMemberVariable with selection type IBISapVariableSelectionTypeEnum.COMPLEX.
void	addSapVariableValue(IBISapNumericVariable variable, IBISapRangeSignType sign, IBIRelationalOperatorType option, Object low, Object high) Adds a variable value range specification for an SAP variable of type IBISapNumericVariable with selection type IBISapVariableSelectionTypeEnum.COMPLEX.
void	clearMemberSet(org.omg.cwm.analysis.olap.Dimension dimension) Deletes all IBIMemberSetExpressions which have been added to the IBIMemberSet of the specified dimension.
void	clearSapVariableValue(IBISapVariable variable) Clears the variable specification of the specified variable.
IBIRankingFilter	createBottomCountFilter(org.omg.cwm.analysis.olap.Dimension dimension, int bottomValue, IBIMember measure) Creates a new ranking filter and applies it to the specified dimension.
IBIRankingFilter	createBottomPercentFilter(org.omg.cwm.analysis.olap.Dimension dimension, double bottomPercentage, IBIMember measure) Creates a new ranking filter and applies it to the specified dimension.
IBIRankingFilter	createBottomSumFilter(org.omg.cwm.analysis.olap.Dimension dimension, double threshold, IBIMember measure) Creates a new ranking filter and applies it to the specified dimension.
IBIConditionBasedFilter	createSearchFilterBetween(org.omg.cwm.analysis.olap.Dimension dimension, double lowerLimit, double upperLimit, IBIMember measure) Creates a new search filter and applies it to the specified dimension.
IBIConditionBasedFilter	createSearchFilterEqual(org.omg.cwm.analysis.olap.Dimension dimension, double searchValue, IBIMember measure) Creates a new search filter and applies it to the specified dimension.
IBIConditionBasedFilter	createSearchFilterGreaterThan(org.omg.cwm.analysis.olap.Dimension dimension, double lowerLimit, IBIMember measure) Creates a new search filter and applies it to the specified dimension.
IBIConditionBasedFilter	createSearchFilterGreaterThanEqual(org.omg.cwm.analysis.olap.Dimension dimension, double lowerLimit, IBIMember measure) Creates a new search filter and applies it to the specified dimension.
IBIConditionBasedFilter	createSearchFilterLessThan(org.omg.cwm.analysis.olap.Dimension dimension, double upperLimit, IBIMember measure) Creates a new search filter and applies it to the specified dimension.
IBIConditionBasedFilter	createSearchFilterLessThanEqual(org.omg.cwm.analysis.olap.Dimension dimension, double upperLimit, IBIMember measure) Creates a new search filter and applies it to the specified dimension.
IBIConditionBasedFilter	createSearchFilterNotEqual(org.omg.cwm.analysis.olap.Dimension dimension, double searchValue, IBIMember measure) Creates a new search filter and applies it to the specified dimension.
IBIRankingFilter	createTopCountFilter(org.omg.cwm.analysis.olap.Dimension dimension, int topValue, IBIMember measure) Creates a new ranking filter and applies it to the specified dimension.
IBIRankingFilter	createTopPercentFilter(org.omg.cwm.analysis.olap.Dimension dimension, double topPercentage, IBIMember measure) Creates a new ranking filter and applies it to the specified dimension.
IBIRankingFilter	createTopSumFilter(org.omg.cwm.analysis.olap.Dimension dimension, double threshold, IBIMember measure) Creates a new ranking filter and applies it to the specified dimension.
void	deselectAttribute(org.omg.cwm.analysis.olap.Dimension dimension, org.omg.cwm.objectmodel.core.Attribute attribute) Deselects a dimension attribute of a specific dimension to be requested by the query from the data source to which the query is connected.
IBIMemberDrill	drillDownMember(IBIMember member) Adds the children of the specified member to the set.
IBITupleDrill	drillDownTuple(IBITuple tuple, IBIMember member) Adds the children of the specified member of a tuple to the set.
IBIMemberDrill	drillUpMember(IBIMember member) Removes all descendants of the specified member from the member set.
IBITupleDrill	drillUpTuple(IBITuple tuple, IBIMember member) Removes all descendants of the specified member of a tuple from the member set.
IBIAxisDimension	getAxisDimension(org.omg.cwm.analysis.olap.Dimension dimension) Returns the axis dimension of the query which references the specified dimension.
List	getMemberSetExpression(org.omg.cwm.analysis.olap.Dimension dimension) Returns an interface to the collection of IBIMemberSetExpression for this dimension.
IBIQueryFactory	getQueryFactory() Retrieves the IBIQueryFactory which can be used to create all different kinds of objects of the query model.
List	getSapVariables() Returns an unmodifiable list of all variables of this query.
IBISetExpression	getSetExpressionById(String id) Retrieves set expressions by their IDs.
IBISort	getSortOrder(org.omg.cwm.analysis.olap.Dimension dimension) Returns an interface to access the sort properties of this dimension.
List	getTupleSetExpression(int axisIndex) Returns an interface to the collection of IBITupleSetExpression for this axis.
boolean	isSuppressingEmptyColumns() Returns the current setting for the columns axis of the query, whether empty tuples are eliminated or not.
boolean	isSuppressingEmptyRows() Returns the current setting for the rows axis of the query, whether empty tuples are suppressed or not.
void	moveDimension(org.omg.cwm.analysis.olap.Dimension dimension, int axisIndex, int positionIndex) Populates axes with dimensions.
void	moveDimensionToColumns(org.omg.cwm.analysis.olap.Dimension dimension) Populates axes with dimensions, using a "columns" shortcut from the moveDimension method with a specific set of parameters.
void	moveDimensionToRows(org.omg.cwm.analysis.olap.Dimension dimension) Populates axes with dimensions, using a "rows" shortcut from the moveDimension method with a specific set of parameters.
void	moveDimensionToSlicer(org.omg.cwm.analysis.olap.Dimension dimension) Populates axes with dimensions, using a "slicer" shortcut from the moveDimension method with a specific set of parameters.
IBICompositeMemberSetExpression	moveMemberSetExpressionsToComposite(org.omg.cwm.analysis.olap.Dimension dimension, IBIJoinType joinType, boolean addCompositeToMemberSet) Creates and returns an interface to an IBICompositeMemberSetExpression.
void	removeSetExpression(IBISetExpression setExpression) Removes the specified IBISetExpression setExpression from the IBIMemberSet or IBITupleSet.
void	revealEmptyColumns() Reveals empty tuples on the columns axis.
void	revealEmptyRows() Reveals empty tuples on the rows axis.
void	selectAttribute(org.omg.cwm.analysis.olap.Dimension dimension, org.omg.cwm.objectmodel.core.Attribute attribute) Selects a dimension attribute of a specific dimension to be requested by the query from the data source to which the query is connected.
void	setInitialState() Sets the query back to its initial state, where the measures dimension is moved to the columns axis and all measures are selected.
IBISort	setOrderByAttribute(org.omg.cwm.analysis.olap.Dimension dimension, IBISortDirectionType sortDirection, boolean breakingHierarchy, org.omg.cwm.objectmodel.core.Attribute attribute) Sets the order of the specified dimension to be ordered by an attribute.
IBISort	setOrderByMeasureValue(org.omg.cwm.analysis.olap.Dimension dimension, IBISortDirectionType sortDirection, boolean breakingHierarchy, IBIMember measure) Sets the order of the specified dimension to be ordered by the given measure.
void	setSapVariableValue(IBISapHierarchyVariable variable, org.omg.cwm.analysis.olap.Hierarchy hierarchy) Sets a variable value for an SAP variable of type IBISapHierarchyVariable with selection type IBISapVariableSelectionTypeEnum.SINGLEVALUE.
void	setSapVariableValue(IBISapMemberVariable variable, IBIMember member) Sets a variable value for an SAP variable of type IBISapMemberVariable with selection type IBISapVariableSelectionTypeEnum.SINGLEVALUE.
void	setSapVariableValue(IBISapMemberVariable variable, IBIMember low, IBIMember high) Sets a variable value range for an SAP variable of type IBISapMemberVariable with selection type IBISapVariableSelectionTypeEnum.INTERVAL.
void	setSapVariableValue(IBISapNumericVariable variable, Object value) Sets a variable value for an SAP variable of type IBISapNumericVariable with selection type IBISapVariableSelectionTypeEnum.SINGLEVALUE.
void	setSapVariableValue(IBISapNumericVariable variable, Object low, Object high) Sets a variable value range for an SAP variable of type IBISapNumericVariable with selection type IBISapVariableSelectionTypeEnum.INTERVAL.
void	suppressEmptyColumns() Suppresses all empty tuples on the columns axis from the result set of the query.
void	suppressEmptyRows() Suppresses all empty tuples on the rows axis from the result set of the query.
void	swapAxes() Exchanges all dimensions on the columns axis with the dimensions on the rows axis, and vice versa.
IBIMemberDrill	zoomInMember(IBIMember member) Clears the member set of the specified dimension and adds the children of the given member.
IBITupleDrill	zoomInTuple(IBITuple tuple, IBIMember member) Clears the member set of the tuple members dimensions and adds the children of the given member of a tuple.
IBIMemberDrill	zoomOutMember(IBIMember member) Clears the member set of the specified dimension and adds the parent of the given member and its siblings to the set.
IBITupleDrill	zoomOutTuple(IBITuple tuple, IBIMember member) Clears the member set of the tuple members dimensions and adds the parent of the given member of a tuple and its siblings to the set.

Field Detail

SLICER_AXIS_INDEX

public static final int SLICER_AXIS_INDEX

The constant which represents the slicer axis and can be used for the moveDimension command.

COLUMNS_AXIS_INDEX

public static final int COLUMNS_AXIS_INDEX

The constant which represents the columns axis and can be used for the moveDimension command.

ROWS_AXIS_INDEX

public static final int ROWS_AXIS_INDEX

The constant which represents the rows axis and can be used for the moveDimension command.

Method Detail

moveDimension

public void moveDimension(org.omg.cwm.analysis.olap.Dimension dimension,
                          int axisIndex,
                          int positionIndex)
                   throws BIOlapQueryException

Populates axes with dimensions. Use this method to alter the initial state of the query in which only a slicer axis upon which all dimensions are placed, and a column axis with the measure dimension assigned, exists.

Use this method to also change the sort order or nesting of dimensions within an axis. In this case, the parameter axisIndex, which defines the target axis, is the same as the axis where the dimension currently is. positionIndex is the index position the dimension will hold after the move. All dimensions with a position index greater or equal to the target index are moved to the right.

Note that there are a couple of shortcuts to this method, moveDimensionToRows(Dimension) and moveDimensionToColumns(Dimension), which do not require the axisIndex and positionIndex parameters.

Parameters:

dimension - dimension to be moved

axisIndex - axis ordinal of the target axis

positionIndex - position index of the target position

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based

moveDimensionToColumns

public void moveDimensionToColumns(org.omg.cwm.analysis.olap.Dimension dimension)
                            throws BIOlapQueryException

Populates axes with dimensions, using a "columns" shortcut from the moveDimension method with a specific set of parameters. The target axis is fixed to the axis with axisIndex "0", and the position index is set so that the dimension will be appended to the last position.

Parameters:

dimension - dimension to be moved

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based

moveDimensionToRows

public void moveDimensionToRows(org.omg.cwm.analysis.olap.Dimension dimension)
                         throws BIOlapQueryException

Populates axes with dimensions, using a "rows" shortcut from the moveDimension method with a specific set of parameters. The target axis is fixed to the axis with axisIndex "1", and the position index is set so that the dimension will be appended to the last position.

Parameters:

dimension - dimension to be moved

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based

moveDimensionToSlicer

public void moveDimensionToSlicer(org.omg.cwm.analysis.olap.Dimension dimension)
                           throws BIOlapQueryException

Populates axes with dimensions, using a "slicer" shortcut from the moveDimension method with a specific set of parameters. The target axis is fixed to slicer axis of the query, and the position index is set so that the dimension will be appended to the last position.

Parameters:

dimension - dimension to be moved

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based

getAxisDimension

public IBIAxisDimension getAxisDimension(org.omg.cwm.analysis.olap.Dimension dimension)
                                  throws BIOlapQueryException

Returns the axis dimension of the query which references the specified dimension.

Parameters:

dimension - dimension which is referenced by the requested axis dimension of the query

Returns:

axis dimension which references the specified dimension

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based

getQueryFactory

public IBIQueryFactory getQueryFactory()

Retrieves the IBIQueryFactory which can be used to create all different kinds of objects of the query model.

Returns:

the factory which can be used to create query objects

swapAxes

public void swapAxes()

Exchanges all dimensions on the columns axis with the dimensions on the rows axis, and vice versa. In addition, tuple sets specified for the axis and all other settings of the axes are exchanged. These settings are suppressingEmptyTuples of interface IBIAxis and distinct, hierarchized of the interface IBITupleSet of the axis.

createTopCountFilter

public IBIRankingFilter createTopCountFilter(org.omg.cwm.analysis.olap.Dimension dimension,
                                             int topValue,
                                             IBIMember measure)
                                      throws BIOlapQueryException

Creates a new ranking filter and applies it to the specified dimension. The filter isolates the top topValue members of the specified dimension based on a measure. The method returns an IBIRankingFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

topValue - number of members to be isolated

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based, or if topValue is negative

createBottomCountFilter

public IBIRankingFilter createBottomCountFilter(org.omg.cwm.analysis.olap.Dimension dimension,
                                                int bottomValue,
                                                IBIMember measure)
                                         throws BIOlapQueryException

Creates a new ranking filter and applies it to the specified dimension. The filter isolates the bottom bottomValue members of the specified dimension based on a measure. The method returns an IBIRankingFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

bottomValue - number of members to be isolated

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based, or if bottomValue is negative

createTopPercentFilter

public IBIRankingFilter createTopPercentFilter(org.omg.cwm.analysis.olap.Dimension dimension,
                                               double topPercentage,
                                               IBIMember measure)
                                        throws BIOlapQueryException

Creates a new ranking filter and applies it to the specified dimension. The filter isolates the top percent members of the specified dimension based on a measure. The method returns an IBIRankingFilter interface to the created filter instance. The filter isolates at least as many members from the dimension so that it matches as a fraction at least the specified percentage.

Parameters:

dimension - dimension to which the ranking filter is to be applied

topPercentage - percentage of members to be isolated

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based, or if topPercentage is negative

createBottomPercentFilter

public IBIRankingFilter createBottomPercentFilter(org.omg.cwm.analysis.olap.Dimension dimension,
                                                  double bottomPercentage,
                                                  IBIMember measure)
                                           throws BIOlapQueryException

Creates a new ranking filter and applies it to the specified dimension. The filter isolates the bottom percent members of the specified dimension based on a measure. The method returns an IBIRankingFilter interface to the created filter instance. The filter isolates at least as many members from the dimension so that it matches as a fraction at least the specified percentage.

Parameters:

dimension - dimension to which the ranking filter is to be applied

bottomPercentage - percentage of members to be isolated

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based, or if bottomPercentage is negative

createTopSumFilter

public IBIRankingFilter createTopSumFilter(org.omg.cwm.analysis.olap.Dimension dimension,
                                           double threshold,
                                           IBIMember measure)
                                    throws BIOlapQueryException

Creates a new ranking filter and applies it to the specified dimension. The filter isolates as many members (from the top set of members) is required so that their sum matches at least the specified threshold. The members are ordered from largest to smallest according to the specified measure. The method returns an IBIRankingFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

threshold - the value the sum of isolated members must at least match

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based

createBottomSumFilter

public IBIRankingFilter createBottomSumFilter(org.omg.cwm.analysis.olap.Dimension dimension,
                                              double threshold,
                                              IBIMember measure)
                                       throws BIOlapQueryException

Creates a new ranking filter and applies it to the specified dimension. The filter isolates as many members (from the bottom set of members) as is required so that their sum matches at the maximum the specified threshold. The members are ordered from smallest to largest according to the specified measure. The method returns an IBIRankingFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

threshold - the value the sum of isolated members may at the maximum match

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based

createSearchFilterGreaterThan

public IBIConditionBasedFilter createSearchFilterGreaterThan(org.omg.cwm.analysis.olap.Dimension dimension,
                                                             double lowerLimit,
                                                             IBIMember measure)
                                                      throws BIOlapQueryException

Creates a new search filter and applies it to the specified dimension. The filter isolates all members of the dimension for which the specified measure is greater than the lowerLimit. The method returns an IBIConditionBasedFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

lowerLimit - the value members must be greater than to be isolated by the filter

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based

createSearchFilterLessThan

public IBIConditionBasedFilter createSearchFilterLessThan(org.omg.cwm.analysis.olap.Dimension dimension,
                                                          double upperLimit,
                                                          IBIMember measure)
                                                   throws BIOlapQueryException

Creates a new search filter and applies it to the specified dimension. The filter isolates all members of the dimension for which the specified measure is less than the upperLimit. The method returns an IBIConditionBasedFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

upperLimit - the value members must be less than to be isolated by the filter

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based

createSearchFilterGreaterThanEqual

public IBIConditionBasedFilter createSearchFilterGreaterThanEqual(org.omg.cwm.analysis.olap.Dimension dimension,
                                                                  double lowerLimit,
                                                                  IBIMember measure)
                                                           throws BIOlapQueryException

Creates a new search filter and applies it to the specified dimension. The filter isolates all members of the dimension for which the specified measure is greater than or equal to the lowerLimit. The method returns an IBIConditionBasedFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

lowerLimit - the value to which members must be greater than or equal to be isolated by the filter

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based

createSearchFilterLessThanEqual

public IBIConditionBasedFilter createSearchFilterLessThanEqual(org.omg.cwm.analysis.olap.Dimension dimension,
                                                               double upperLimit,
                                                               IBIMember measure)
                                                        throws BIOlapQueryException

Creates a new search filter and applies it to the specified dimension. The filter isolates all members of the dimension for which the specified measure is less than or equal to the upperLimit. The method returns an IBIConditionBasedFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

upperLimit - the value to which members must be less than or equal to be isolated by the filter

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based

createSearchFilterBetween

public IBIConditionBasedFilter createSearchFilterBetween(org.omg.cwm.analysis.olap.Dimension dimension,
                                                         double lowerLimit,
                                                         double upperLimit,
                                                         IBIMember measure)
                                                  throws BIOlapQueryException

Creates a new search filter and applies it to the specified dimension. The filter isolates all members of the dimension for which the specified measure is between or equal to the lowerLimit and the upperLimit. The method returns an IBIConditionBasedFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

lowerLimit - the value to which members must be greater than or equal to be isolated by the filter

upperLimit - the value to which members must be less than or equal to be isolated by the filter

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based

createSearchFilterEqual

public IBIConditionBasedFilter createSearchFilterEqual(org.omg.cwm.analysis.olap.Dimension dimension,
                                                       double searchValue,
                                                       IBIMember measure)
                                                throws BIOlapQueryException

Creates a new search filter and applies it to the specified dimension. The filter isolates all members of the dimension for which the specified measure is equal to the searchValue. The method returns an IBIConditionBasedFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

searchValue - the value to which members must be equal to be isolated by the filter

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based

createSearchFilterNotEqual

public IBIConditionBasedFilter createSearchFilterNotEqual(org.omg.cwm.analysis.olap.Dimension dimension,
                                                          double searchValue,
                                                          IBIMember measure)
                                                   throws BIOlapQueryException

Creates a new search filter and applies it to the specified dimension. The filter isolates all members of the dimension for which the specified measure is not equal to the searchValue. The method returns an IBIConditionBasedFilter interface to the created filter instance.

Parameters:

dimension - dimension to which the ranking filter is to be applied

searchValue - the value to which members must be not equal to be isolated by the filter

measure - measure on which the ranking is based

Returns:

an interface to the created filter

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based

removeSetExpression

public void removeSetExpression(IBISetExpression setExpression)
                         throws BIOlapQueryException

Removes the specified IBISetExpression setExpression from the IBIMemberSet or IBITupleSet. With this, you can delete previously created filter, tuple/member selection or drill operations. The method allows to delete everything which is of type IBISetExpression from the containing list.

Parameters:

setExpression - the IBISetExpression which is to be removed

Throws:

BIOlapQueryException - if setExpression is not referenced by the query

getMemberSetExpression

public List getMemberSetExpression(org.omg.cwm.analysis.olap.Dimension dimension)
                            throws BIOlapQueryException

Returns an interface to the collection of IBIMemberSetExpression for this dimension.

Parameters:

dimension - dimension for which the collection of IBIMemberSetExpression is requested

Returns:

an interface to the collection of IBIMemberSetExpression for this dimension

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based

getTupleSetExpression

public List getTupleSetExpression(int axisIndex)
                           throws BIOlapQueryException

Returns an interface to the collection of IBITupleSetExpression for this axis.

Parameters:

axisIndex - axis ordinal of the target axis

Returns:

an interface to the collection of IBITupleSetExpression for this axis

Throws:

BIOlapQueryException - if axis does not exist for this query

Since:

3.50 SP4

moveMemberSetExpressionsToComposite

public IBICompositeMemberSetExpression moveMemberSetExpressionsToComposite(org.omg.cwm.analysis.olap.Dimension dimension,
                                                                           IBIJoinType joinType,
                                                                           boolean addCompositeToMemberSet)
                                                                    throws BIOlapQueryException

Creates and returns an interface to an IBICompositeMemberSetExpression. The member set expressions of the dimensions member set are moved to the composite. The composite is then optionally added to the dimensions member set.

Parameters:

dimension - dimension, the member set expressions of which are moved to the composite

joinType - join type which specifies how the member set expressions of the composite are joined with previously defined member set expressions. If the composite is added to the member set, only the join type INITIAL makes sense.

addCompositeToMemberSet - flag which specifies whether or not the newly created IBICompositeMemberSetExpression is added to the dimensions member set

Returns:

the created IBICompositeMemberSetExpression

Throws:

BIOlapQueryException -

Since:

3.50 SP1

getSortOrder

public IBISort getSortOrder(org.omg.cwm.analysis.olap.Dimension dimension)
                     throws BIOlapQueryException

Returns an interface to access the sort properties of this dimension.

Parameters:

dimension - dimension to which the ranking filter is to be applied

Returns:

an interface to access the sort properties of this dimension, or null if no sort order has been specified

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based

setOrderByMeasureValue

public IBISort setOrderByMeasureValue(org.omg.cwm.analysis.olap.Dimension dimension,
                                      IBISortDirectionType sortDirection,
                                      boolean breakingHierarchy,
                                      IBIMember measure)
                               throws BIOlapQueryException

Sets the order of the specified dimension to be ordered by the given measure. Sort order and the effect on hierarchies are controlled by the parameters sortDirection and breakingHierarchy.

Parameters:

dimension - dimension for which the order properties are set

sortDirection - specifies ascending or descending order

breakingHierarchy - if true, the hierarchical sort order of the members is retained

measure - measure on which the sort should be based

Returns:

an interface to access the sort properties of this dimension

Throws:

BIOlapQueryException - if dimension or measure is not referenced by the cube upon which the query is based, or if sortDirection is null

setOrderByAttribute

public IBISort setOrderByAttribute(org.omg.cwm.analysis.olap.Dimension dimension,
                                   IBISortDirectionType sortDirection,
                                   boolean breakingHierarchy,
                                   org.omg.cwm.objectmodel.core.Attribute attribute)
                            throws BIOlapQueryException

Sets the order of the specified dimension to be ordered by an attribute. Sort order and the effect on hierarchies are controlled by the parameters sortDirection and breakingHierarchy.

Parameters:

dimension - dimension for which the order properties are set

sortDirection - specifies ascending or descending order

breakingHierarchy - if set to true the hierarchical sort order of the members is retained

attribute - attribute on which the sort should be based

Returns:

an interface to access the sort properties of this dimension

Throws:

BIOlapQueryException - if dimension or attribute is not referenced by the cube upon which the query is based, or if sortDirection is null

clearMemberSet

public void clearMemberSet(org.omg.cwm.analysis.olap.Dimension dimension)
                    throws BIOlapQueryException

Deletes all IBIMemberSetExpressions which have been added to the IBIMemberSet of the specified dimension. Member selections on a dimension are made through the IBIMemberSet interface, exposed by an AxisDimension. When a query is created by the method IBIMainFactory.createQuery(Cube) of the IBIMainFactory interface, the member sets of all dimensions are empty. If there are no IBIMemberSetExpressions defined for a member set of a dimension, implicitly all dimension members are selected. To make a query more specific or restrictive, members or sets of members can be added to the member set.

Parameters:

dimension - dimension for which the member set should be cleared

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based

addMember

public void addMember(IBIMember member)
               throws BIOlapQueryException

Adds a single member to the member set of the dimension to which the member belongs. Note that the member is added to the end of the member set. Multiple members can also be added to dimensions, which are on the slicer axis. If the member set is empty before the method call (in other words, if it selects all dimension members) and a member is added, it contains only the added member after the method call.

Parameters:

member - member which is added to the member set

Throws:

BIOlapQueryException - if member is not referenced by the cube upon which the query is based

addCalculatedMember

public IBICalculatedMember addCalculatedMember(org.omg.cwm.analysis.olap.Dimension dimension,
                                               IBIInputReference formula,
                                               int solveOrder)
                                        throws BIOlapQueryException

Creates an IBICalculatedMember for the specified dimension based on the specified formula and adds it to the member set of the dimension.

Parameters:

dimension - dimension for which the calculated member is created. The calculated member is added to the dimensions member set.

formula - formula which acts as definition for the calculated member

solveOrder - integer value which specifies the calculated member's position in the calculation order of all calculated members of this query

Returns:

the newly created and added calculated member

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based or the formula is null

Since:

3.50 SP1

addMemberList

public void addMemberList(IBIMemberList memberList)
                   throws BIOlapQueryException

Adds a member list to the member set of the dimension to which the members of the member list belong. All members of the member list have to belong to the same dimension. Note that the member list is added to the end of the member set. With this, it is possible to add many members in one step. If the member set is empty before the method call (in other words, if it selects all dimension members) and a member list is added, it contains only the added member list after the method call.

Parameters:

memberList - member list which is added to the member set

Throws:

BIOlapQueryException - if the members of the memberList are not referenced by the cube upon which the query is based, or if it contains members of different dimensions

addRange

public void addRange(IBIRange memberRange)
              throws BIOlapQueryException

Adds a member range to the member set of the dimension to which the members of the member range belong. All members of the member range have to belong to the same dimension. Note that the member range is added to the end of the member set. With this, it is possible to add many members in one step. If the member set is empty before the method call (in other words, if it selects all dimension members) and a member range is added, it contains only the added member range after the method call.

Parameters:

memberRange - member range which is added to the member set

Throws:

BIOlapQueryException - if the members of the member range are not referenced by the cube upon which the query is based, or if it contains members of different dimensions

Since:

3.50 SP12

addDimensionMembers

public IBIDimensionMembers addDimensionMembers(org.omg.cwm.analysis.olap.Dimension dimension)
                                        throws BIOlapQueryException

Adds all members of the specified dimension to the dimensions member set. In MDX terms, it adds a set value expression to the dimension of the type <dimension>.MEMBERS.

Parameters:

dimension - dimension of which all members are added to the dimensions member set

Returns:

an IBIDimensionMembers object

Throws:

BIOlapQueryException - if dimension is not referenced by the cube upon which the query is based

addLevelMembers

public IBILevelMembers addLevelMembers(org.omg.cwm.analysis.olap.Level level)
                                throws BIOlapQueryException

Adds all members of the specified level to the dimensions member set. In MDX terms, it adds a set value expression to the dimension of the type <level>.MEMBERS.

About member selection based on level:

Many hierarchies have at least two levels, the first of which is the ALL level. The ALL level usually contains just one member, the ALL member, which represents the aggregated values of all members.

It's important to note that it is often not meaningful to return the ALL member in a result set, but rather to return results based on a specific level, beginning with the second level, which begins the set of "real" members. Consider the hierarchy diagram below:

This is a geography hierarchy, with three levels shown:

• Level 1: ALL level
• Level 2: Region level
• Level 3: Country level

If you create a query that returns the top five countries based on sales without restricting to a specific level, the first result returned would be "All Countries," because the highest sales would be the total of all sales values across the hierarchy - the ALL member. The second two results would be "Europe" and "America." Instead, you would want to create a query based on a specific level - the Country level.

See the following source code snippet for an example of using addLevelMembers to select the members of the right level for this query:

Level countryLevel = olap.getObjectFinder().
findLevelFirst(geographyHierarchy, "Country");
commandProcessor.addLevelMembers(countryLevel);
commandProcessor.createTopCountFilter(geographyDimension, 5, salesMeasure);


Parameters:

level - level of which all members are added to the levels dimensions member set

Returns:

an IBILevelMembers object

Throws:

BIOlapQueryException - if level is not referenced by the cube upon which the query is based

drillDownMember

public IBIMemberDrill drillDownMember(IBIMember member)
                               throws BIOlapQueryException

Adds the children of the specified member to the set. When used in a pivot table, the method provides one possibility to navigate a hierarchy. In contrast to the zoom operation (zoomIn), the method retains the parent member.

For example:

 Hierarchy structure:
 [All countries]
    [USA]
    [Germany]
    [France]

 Initial state:
 [All countries]

 drillDown on [All countries] returns

 [All countries]
  [USA]
  [Germany]
  [France]

Parameters:

member - the member which is drilled on

Returns:

the created set expression for the drill operation

Throws:

BIOlapQueryException - if member is not referenced by the cube upon which the query is based

drillUpMember

public IBIMemberDrill drillUpMember(IBIMember member)
                             throws BIOlapQueryException

Removes all descendants of the specified member from the member set. When used in a pivot table, the method provides one possibility to navigate a hierarchy.

For example:

 Initial state:

 [All regions]
    [USA]
    [Germany]
      [North]
      [South]
      [East]
      [West]
    [France]

 drillUp on [South] returns

 [All countries]
  [USA]
  [Germany]
  [France]

Parameters:

member - the member which is drilled on

Returns:

the created set expression for the drill operation

Throws:

BIOlapQueryException - if member is not referenced by the cube upon which the query is based

zoomInMember

public IBIMemberDrill zoomInMember(IBIMember member)
                            throws BIOlapQueryException

Clears the member set of the specified dimension and adds the children of the given member. When used in a pivot table, the method provides one possibility to navigate a hierarchy. In contrast to the drill operation (drillDownMember), the method does not retain the parent member.

For example:

 Hierarchy structure:
 [All countries]
    [USA]
    [Germany]
    [France]

 Initial state:
 [All countries]

 zoomIn on [All countries] returns

  [USA]
  [Germany]
  [France]

Parameters:

member - the member which is zoomed in upon

Returns:

the created set expression for the zoom operation

Throws:

BIOlapQueryException - if member is not referenced by the cube upon which the query is based

zoomOutMember

public IBIMemberDrill zoomOutMember(IBIMember member)
                             throws BIOlapQueryException

Clears the member set of the specified dimension and adds the parent of the given member and its siblings to the set. When used in a pivot table, the method provides one possibility to navigate a hierarchy.

For example:

 Hierarchy structure:
 [All countries]
    [USA]
    [Germany]
    [France]


 Initial state:
 [All countries]

 zoomOut on [France] returns

  [All countries]

Parameters:

member - the member which is zoomed out upon

Returns:

the created set expression for the zoom operation

Throws:

BIOlapQueryException - if member is not referenced by the cube upon which the query is based

drillDownTuple

public IBITupleDrill drillDownTuple(IBITuple tuple,
                                    IBIMember member)
                             throws BIOlapQueryException

Adds the children of the specified member of a tuple to the set. When used in a pivot table, the method provides one possibility to navigate a hierarchy. In contrast to the zoom operation (zoomIn), the method retains the parent member. In order to execute a drill down on a tuple member, the existing query has to be executed and transformed into a pure specification of tuples for all axes. All existing IBIMemberSet specifications of all dimensions are cleared and transformed into the according IBITupleSet specifications for the existing axes.

For example:

 Hierarchy structure:
 [All countries]
   [USA]
   [Germany]
   [France]

 Initial state:
 ([Beer],[All countries])
 ([Wine],[All countries])

 drillDown on [All countries] of tuple ([Wine],[All countries]) returns

 ([Beer],[All countries])
 ([Wine],[All countries])
           [USA]
           [Germany]
           [France]
 

Parameters:

tuple - tuple which contains the member which is drilled down upon

member - member of the tuple which is drilled down upon

Returns:

the created set expression for the drill operation

Throws:

BIOlapQueryException - if member is not referenced by the cube upon which the query is based, or if the tuple has a dimensionality which does not correspond to any of the dimensionalities of the axes of the query

drillUpTuple

public IBITupleDrill drillUpTuple(IBITuple tuple,
                                  IBIMember member)
                           throws BIOlapQueryException

Removes all descendants of the specified member of a tuple from the member set. When used in a pivot table, the method provides one possibility to navigate a hierarchy. In order to execute a drill up on a tuple member, the existing query has to be executed and transformed into a pure specification of tuples for all axes. All existing IBIMemberSet specifications of all dimensions are cleared and transformed into the according IBITupleSet specifications for the existing axes.

For example:

 Initial state:
 ([Beer],[All countries])
           [USA]
           [Germany]
           [France]
 ([Wine],[All countries])
           [USA]
           [Germany]
           [France]

 drillUp on [Germany] of tuple ([Wine],[Germany]) returns

 ([Beer],[All countries])
           [USA]
           [Germany]
           [France]
 ([Wine],[All countries])
 

Parameters:

tuple - tuple which contains the member which is drilled up upon

member - member of the tuple which is drilled up upon

Returns:

the created set expression for the drill operation

Throws:

BIOlapQueryException - if member is not referenced by the cube upon which the query is based, or the if tuple has a dimensionality which does not correspond to any of the dimensionalities of the axes of the query

zoomInTuple

public IBITupleDrill zoomInTuple(IBITuple tuple,
                                 IBIMember member)
                          throws BIOlapQueryException

Clears the member set of the tuple members dimensions and adds the children of the given member of a tuple. When used in a pivot table, the method provides one possibility to navigate a hierarchy. In contrast to the drill operation (drillDownTuple), the method does not retain the parent member. In order to execute a zoom in on a tuple member, the existing query has to be executed and transformed into a pure specification of tuples for all axes. All existing IBIMemberSet specifications of all dimensions are cleared and transformed into the according IBITupleSet specifications for the existing axes.

For example:

 Hierarchy structure:
 [All countries]
   [USA]
   [Germany]
   [France]

 Initial state:
 ([Beer],[All countries])
 ([Wine],[All countries])

 zoomIn on [All countries] of tuple ([Wine],[All countries]) returns

 ([Wine],[USA])
 ([Wine],[Germany])
 ([Wine],[France])
 

Parameters:

tuple - tuple which contains the member which is zoomed in upon

member - member of the tuple which is zoomed in upon

Returns:

the created set expression for the zoom operation

Throws:

BIOlapQueryException - if member is not referenced by the cube upon which the query is based, or if the tuple has a dimensionality which does not correspond to any of the dimensionalities of the axes of the query

zoomOutTuple

public IBITupleDrill zoomOutTuple(IBITuple tuple,
                                  IBIMember member)
                           throws BIOlapQueryException

Clears the member set of the tuple members dimensions and adds the parent of the given member of a tuple and its siblings to the set. When used in a pivot table, the method provides one possibility to navigate a hierarchy. In order to execute a zoom out on a tuple member, the existing query has to be executed and transformed into a pure specification of tuples for all axes. All existing IBIMemberSet specifications of all dimensions are cleared and transformed into the according IBITupleSet specifications for the existing axes.

For example:

 Initial state:
 ([Beer],[All countries])
 ([Wine],[All countries])
           [USA]
             [CA]
             [OR]
             [WA]
           [Germany]
           [France]

 zoomOut on [CA] of tuple ([Wine],[CA]) returns

 ([Wine],[USA])
 ([Wine],[Germany])
 ([Wine],[France])

Parameters:

tuple - tuple which contains the member which is zoomed out upon

member - member of the tuple which is zoomed out upon

Returns:

the created set expression for the zoom operation

Throws:

BIOlapQueryException - if member is not referenced by the cube upon which the query is based, or if the tuple has a dimensionality which does not correspond to any of the dimensionalities of the axes of the query

selectAttribute

public void selectAttribute(org.omg.cwm.analysis.olap.Dimension dimension,
                            org.omg.cwm.objectmodel.core.Attribute attribute)
                     throws BIOlapQueryException

Selects a dimension attribute of a specific dimension to be requested by the query from the data source to which the query is connected.

Parameters:

dimension - dimension to which the attribute belongs

attribute - attribute to be requested from the data source

Throws:

BIOlapQueryException - if dimension or attribute is not referenced by the cube upon which the query is based

deselectAttribute

public void deselectAttribute(org.omg.cwm.analysis.olap.Dimension dimension,
                              org.omg.cwm.objectmodel.core.Attribute attribute)
                       throws BIOlapQueryException

Deselects a dimension attribute of a specific dimension to be requested by the query from the data source to which the query is connected.

Parameters:

dimension - dimension to which the attribute belongs

attribute - attribute not to be requested any more from the data source

Throws:

BIOlapQueryException - if dimension or attribute is not referenced by the cube upon which the query is based

suppressEmptyRows

public void suppressEmptyRows()

Suppresses all empty tuples on the rows axis from the result set of the query. In MDX terms, it specifies the NON EMPTY flag for the rows axis.

suppressEmptyColumns

public void suppressEmptyColumns()

Suppresses all empty tuples on the columns axis from the result set of the query. In MDX terms, it specifies the NON EMPTY flag for the columns axis.

revealEmptyRows

public void revealEmptyRows()

Reveals empty tuples on the rows axis. In MDX terms, it specifies that no NON EMPTY flag is used for the rows axis.

revealEmptyColumns

public void revealEmptyColumns()

Reveals empty tuples on the columns axis. In MDX terms, it specifies that no NON EMPTY flag is used for the columns axis.

isSuppressingEmptyRows

public boolean isSuppressingEmptyRows()

Returns the current setting for the rows axis of the query, whether empty tuples are suppressed or not. If true, the query suppresses empty tuples from the rows axis. If false, empty tuples on the rows axis are revealed.

Returns:

true if the query is suppressing empty tuples from the rows axis

isSuppressingEmptyColumns

public boolean isSuppressingEmptyColumns()

Returns the current setting for the columns axis of the query, whether empty tuples are eliminated or not. If true, the query eliminates empty tuples from the columns axis. If false, empty tuples on the columns axis are revealed.

Returns:

true if the query is eliminating empty tuples from the columns axis

setInitialState

public void setInitialState()

Sets the query back to its initial state, where the measures dimension is moved to the columns axis and all measures are selected. All other dimensions are moved to the slicer axis. For each available measure one value will be calculated which corresponds to the aggregated value over all dimensions.

getSetExpressionById

public IBISetExpression getSetExpressionById(String id)
                                      throws BIOlapQueryException

Retrieves set expressions by their IDs. The ID which is used to search for them is the attribute id of the interface IBIIdentifiable.
If the object with the specified ID cannot be found, null is returned.
This could be a way for a Web application to just store the ID as a string and to allow retrieval of the object later on in order to change it. You could, for example, retrieve an already created filter by its ID and then disable it by calling setActive(false).

Parameters:

id - the id of the to-be-retrieved set expression. This can be a filter, a sort operation, etc.

Returns:

the requested query object which has to be cast into the right type in order to be used

Throws:

BIOlapQueryException - if the set expression with the specified id could not be found

getSapVariables

public List getSapVariables()

Returns an unmodifiable list of all variables of this query. These are the variables defined in the underlying BW query and exposed by the ODBO interface.

Returns:

the list of variables specified for the OLAP query and for the cube upon which it is based.

Since:

3.50 SP2

clearSapVariableValue

public void clearSapVariableValue(IBISapVariable variable)
                           throws BIOlapQueryException

Clears the variable specification of the specified variable. When the selection type is either IBISapVariableSelectionTypeEnum.SINGLEVALUE or IBISapVariableSelectionTypeEnum.INTERVAL, the variable value is set to null. When the selection type is IBISapVariableSelectionTypeEnum.COMPLEX, the list of range specifications is cleared.

Parameters:

variable - variable, the value or values of which should be cleared

Throws:

BIOlapQueryException - if the variable does not exist for this query

Since:

3.50 SP2

setSapVariableValue

public void setSapVariableValue(IBISapHierarchyVariable variable,
                                org.omg.cwm.analysis.olap.Hierarchy hierarchy)
                         throws BIOlapQueryException

Sets a variable value for an SAP variable of type IBISapHierarchyVariable with selection type IBISapVariableSelectionTypeEnum.SINGLEVALUE.

Parameters:

variable - the variable for which a value should be set

hierarchy - the hierarchy which should be used for the value

Throws:

BIOlapQueryException - if variable or hierarchy is null

Since:

3.50 SP2

setSapVariableValue

public void setSapVariableValue(IBISapMemberVariable variable,
                                IBIMember member)
                         throws BIOlapQueryException

Sets a variable value for an SAP variable of type IBISapMemberVariable with selection type IBISapVariableSelectionTypeEnum.SINGLEVALUE.

Parameters:

variable - the variable for which a value should be set

member - the member which should be used for the value

Throws:

BIOlapQueryException - if variable or member is null

Since:

3.50 SP2

setSapVariableValue

public void setSapVariableValue(IBISapMemberVariable variable,
                                IBIMember low,
                                IBIMember high)
                         throws BIOlapQueryException

Sets a variable value range for an SAP variable of type IBISapMemberVariable with selection type IBISapVariableSelectionTypeEnum.INTERVAL.

Parameters:

variable - the variable for which a value should be set

low - the member which should be used for the lower limit of the range

high - the member which should be used for the upper limit of the range

Throws:

BIOlapQueryException - if variable, low, or high is null

Since:

3.50 SP2

addSapVariableValue

public void addSapVariableValue(IBISapMemberVariable variable,
                                IBISapRangeSignType sign,
                                IBIRelationalOperatorType option,
                                IBIMember low,
                                IBIMember high)
                         throws BIOlapQueryException

Adds a variable value range specification for an SAP variable of type IBISapMemberVariable with selection type IBISapVariableSelectionTypeEnum.COMPLEX. You can specify a complex selection by iteratively calling this method. You can delete the list of selection specifications by calling the clearSapVariableValue(IBISapVariable) method.

Parameters:

variable - the variable for which a value should be set

sign - the sign designating whether the members of this SAP variable value range specification should be included or excluded from the selection

option - the option which specifies how members should be selected based on the specified low and high value

low - the member which should be used for the lower limit of the range

high - the member which should be used for the upper limit of the range or null, for all IBIRelationalOperatorType except for the type IBIRelationalOperatorTypeEnum.BETWEEN

Throws:

BIOlapQueryException - if variable, low, or high is null

Since:

3.50 SP2

setSapVariableValue

public void setSapVariableValue(IBISapNumericVariable variable,
                                Object value)
                         throws BIOlapQueryException

Sets a variable value for an SAP variable of type IBISapNumericVariable with selection type IBISapVariableSelectionTypeEnum.SINGLEVALUE.

Parameters:

variable - the variable for which a value should be set

value - the value of type Java Wrapper class which should be set

Throws:

BIOlapQueryException - if variable or value is null

Since:

3.50 SP2

setSapVariableValue

public void setSapVariableValue(IBISapNumericVariable variable,
                                Object low,
                                Object high)
                         throws BIOlapQueryException

Sets a variable value range for an SAP variable of type IBISapNumericVariable with selection type IBISapVariableSelectionTypeEnum.INTERVAL.

Parameters:

variable - the variable for which a value should be set

low - the lower limit of the range of type Java Wrapper class

high - the upper limit of the range of type Java Wrapper class

Throws:

BIOlapQueryException - if variable, low, or high is null

Since:

3.50 SP2

addSapVariableValue

public void addSapVariableValue(IBISapNumericVariable variable,
                                IBISapRangeSignType sign,
                                IBIRelationalOperatorType option,
                                Object low,
                                Object high)
                         throws BIOlapQueryException

Adds a variable value range specification for an SAP variable of type IBISapNumericVariable with selection type IBISapVariableSelectionTypeEnum.COMPLEX. You can specify a complex selection by iteratively calling this method. You can delete the list of selection specifications by calling the clearSapVariableValuemethod.

Parameters:

variable - the variable for which a value should be set

sign - the sign designating whether the members of this SAP variable value range specification should be included or excluded from the selection.

option - the option which specifies how members should be selected based on the specified low and high value

low - the lower limit of the range of type Java Wrapper class

high - the upper limit of the range of type Java Wrapper class or null, for all IBIRelationalOperatorType except for the type IBIRelationalOperatorTypeEnum.BETWEEN

Throws:

BIOlapQueryException - if variable, low, or high is null

Since:

3.50 SP2