com.sap.ip.bi.sdk.dac.relational.query.tree
Interface IBIWhereTree

public interface IBIWhereTree

The WHERE condition represented in tree form to simplify manipulation and SQL code generation. The tree contains a stack to support its use in the Relational Command Processor.

Since:

3.50

Method Summary

void	clear() Removes the contents.
List	getPredicateList() Returns the list of predicates of the WHERE tree.
IBIWhereTreeNode	getRoot() Gets the root of the tree.
boolean	isInCNF() Checks if the WHERE tree is in conjunctive normal form (CNF).
boolean	isInMDX() Checks if translation of the WHERE tree to MDX is possible.
boolean	isInSelectOptions() Checks if translation of the WHERE tree to SELECT-OPTIONS is possible.
void	normalize() Normalizes the WHERE tree (CNF).
IBIWhereTreeNode	peek() Returns the top node of the stack.
void	peekRoot() Sets the root node to the top node of the stack.
IBIWhereTreeNode	pop() Pops the top node off the stack.
void	popRoot() Pops the top node off the stack and assigns it to the root node.
void	push(Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper) Pushes a node comprised of the column column and the logical operator oper on to the stack.
void	push(Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper, Object value) Pushes a node comprised of the column column, the logical operator oper, and the value value on to the stack.
void	push(Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper, Object[] values) Pushes a node comprised of the column column, the logical operator oper, and the array of values values on to the stack.
void	push(Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper, Object lowValue, Object highValue) Pushes a node comprised of the column column, the logical operator oper, and the values lowValue and highValue on to the stack.
void	push(com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLLogicalOperator oper) Pushes the logical operator oper on to the stack.
void	push(String tableRef, Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper) Pushes a node comprised of the table reference tableRef, the column column, and the logical operator oper on to the stack.
void	push(String tableRef, Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper, IBIQuery subQuery) Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the query subQuery on to the stack.
void	push(String tableRef, Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper, Object value) Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the value value on to the stack.
void	push(String tableRef, Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper, Object[] values) Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the array of values values on to the stack.
void	push(String tableRef, Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper, Object lowValue, Object highValue) Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the values lowValue and highValue on to the stack.
void	push(String tableRef, Column column, com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper, String tabRef2, Column column2) Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the 2nd table reference tabRef2 and column column2 on to the stack (left and right hand side of a join).
void	pushRoot() Pushes the root node on to the stack.
void	setRoot(IBIWhereTreeNode node) Sets the root of the tree to node.
String	toString() Returns a string representation of the WHERE tree.

Method Detail

clear

public void clear()

Removes the contents.

setRoot

public void setRoot(IBIWhereTreeNode node)

Sets the root of the tree to node.

Parameters:

node - the root of the tree

See Also:

getRoot()

getRoot

public IBIWhereTreeNode getRoot()

Gets the root of the tree.

Returns:

the root of the tree

See Also:

setRoot(IBIWhereTreeNode)

pop

public IBIWhereTreeNode pop()

Pops the top node off the stack.

Returns:

the top node of the stack.

peek

public IBIWhereTreeNode peek()

Returns the top node of the stack.

Returns:

the top node.

pushRoot

public void pushRoot()

Pushes the root node on to the stack.

popRoot

public void popRoot()

Pops the top node off the stack and assigns it to the root node.

peekRoot

public void peekRoot()

Sets the root node to the top node of the stack.

push

public void push(String tableRef,
                 Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper)

Pushes a node comprised of the table reference tableRef, the column column, and the logical operator oper on to the stack.

Parameters:

tableRef - the table reference

column - the column

oper - the logical operator

push

public void push(String tableRef,
                 Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper,
                 IBIQuery subQuery)

Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the query subQuery on to the stack.

Parameters:

tableRef - the table reference

column - the column

oper - the logical operator

subQuery - the sub-query

push

public void push(String tableRef,
                 Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper,
                 String tabRef2,
                 Column column2)

Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the 2nd table reference tabRef2 and column column2 on to the stack (left and right hand side of a join).

Parameters:

tableRef - the left table reference

column - the left column

oper - the logical operator

tabRef2 - the right table reference

column2 - the right column

push

public void push(String tableRef,
                 Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper,
                 Object lowValue,
                 Object highValue)

Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the values lowValue and highValue on to the stack.

Parameters:

tableRef - the table reference

column - the column

oper - the logical operator

lowValue - the low value

highValue - the high value

push

public void push(String tableRef,
                 Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper,
                 Object[] values)

Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the array of values values on to the stack.

Parameters:

tableRef - the table reference

column - the column

oper - the logical operator

values - the values

push

public void push(String tableRef,
                 Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper,
                 Object value)

Pushes a node comprised of the table reference tableRef, the column column, the logical operator oper, and the value value on to the stack.

Parameters:

tableRef - the table reference

column - the column

oper - the logical operator

value - the value

push

public void push(Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper,
                 Object lowValue,
                 Object highValue)

Pushes a node comprised of the column column, the logical operator oper, and the values lowValue and highValue on to the stack.

Parameters:

column - the column

oper - the logical operator

lowValue - the low value

highValue - the high value

push

public void push(Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper,
                 Object[] values)

Pushes a node comprised of the column column, the logical operator oper, and the array of values values on to the stack.

Parameters:

column - the column

oper - the logical operator

values - the values

push

public void push(Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper,
                 Object value)

Pushes a node comprised of the column column, the logical operator oper, and the value value on to the stack.

Parameters:

column - the column

oper - the logical operator

value - the value

push

public void push(Column column,
                 com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLComparisonOperator oper)

Pushes a node comprised of the column column and the logical operator oper on to the stack.

Parameters:

column - the column

oper - the logical operator

push

public void push(com.sap.ip.bi.sdk.dac.relational.query.sql.IBISQLLogicalOperator oper)

Pushes the logical operator oper on to the stack.

Parameters:

oper - the logical operator

toString

public String toString()

Returns a string representation of the WHERE tree.

Overrides:

toString in class Object

Returns:

the string representation of the WHERE tree.

isInCNF

public boolean isInCNF()

Checks if the WHERE tree is in conjunctive normal form (CNF).

Returns:

true if the WHERE tree is in CNF, otherwise false

isInSelectOptions

public boolean isInSelectOptions()

Checks if translation of the WHERE tree to SELECT-OPTIONS is possible.

Returns:

true if the translation of the WHERE tree to SELECT-OPTIONS is possible, otherwise false

isInMDX

public boolean isInMDX()

Checks if translation of the WHERE tree to MDX is possible.

Returns:

true if the translation of the WHERE tree to MDX is possible, otherwise false

getPredicateList

public List getPredicateList()

Returns the list of predicates of the WHERE tree.

Returns:

the list of predicates of the WHERE tree.

normalize

public void normalize()

Normalizes the WHERE tree (CNF).