wt.query
Interface WhereExpression

All Known Implementing Classes:

CompositeWhereExpression, ExistsExpression, NegatedExpression, SearchCondition

public interface WhereExpression

This interface represents an expression that can be used in a SQL WHERE clause.

Supported API: true

Extendable: false

Field Summary

static String	ADVANCED_QUERY Label for the attribute; Indicates if the expression uses advanced query capabilities.
static String	ADVANCED_QUERY_ENABLED Label for the attribute; Indicates if advanced query capabilities are enabled.
static String	BIND_PARAMETER Label for the attribute; Returns a bind parameter for this expression (if supported).
static String	CORRELATED_CLASS_ATTRIBUTES Label for the attribute.
static String	FROM_COUNT Label for the attribute; Number of FromClause TableExpressions/Aliases that this expression requires.
static String	FROM_INDICIES Label for the attribute; Indicies for all current expressions relative to a FromClause that will be used for validating and setting aliases when this compostie expression is appended to a statement.

Method Summary

Object	getBindParameter() Gets the value of the attribute: BIND_PARAMETER.
Object	getBindParameterFrom(Vector a_singleBindParameter) Supported API: false
List	getClassAttributes() Supported API: false
List	getCorrelatedClassAttributes() Gets the value of the attribute: CORRELATED_CLASS_ATTRIBUTES.
String	getExpression(boolean a_useBind, Vector a_tableInfos, Vector a_aliases) Return string representation of this expression.
int	getFromCount() Gets the value of the attribute: FROM_COUNT.
int[]	getFromIndicies() Gets the value of the attribute: FROM_INDICIES.
WhereExpression	getJoinConditions(JoinIndex a_joinIndex) This method is to return the join search condition.
WhereExpression	getJoinConditions(Set a_joinIndexSet) This method is to return the join search condition.
WhereExpression	getJoinConditions(String a_alias) This method is to return the join search condition.
WhereExpression	getJoinConditions(String a_alias, boolean a_removed) This method is to return the join search condition.
WhereExpression	getJoinConditions(String a_alias, int a_outerNonJoinFromIndex, boolean a_removed) This method is to return the join search condition.
Set	getJoinIndex() Supported API: false
void	handleCorrelatedAttributes(Vector a_tableInfos, Vector a_aliases) Supported API: false
boolean	isAdvancedQuery() Gets the value of the attribute: ADVANCED_QUERY.
boolean	isAdvancedQueryEnabled() Gets the value of the attribute: ADVANCED_QUERY_ENABLED.
boolean	isAllJoinConditions(JoinIndex a_joinIndex) Supported API: false
boolean	isAllJoinConditions(Set a_joinIndexSet) Supported API: false
boolean	isAllJoinConditions(String a_alias) Supported API: false
boolean	isAllJoinConditions(String a_alias, boolean a_removed) Supported API: false
boolean	isAllOuterNonJoinConditions() Supported API: false
void	setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled) Sets the value of the attribute: ADVANCED_QUERY_ENABLED.
int	setAliases(String[] a_aliases, int a_offset) This method sets the aliases for components of the expression.
int	setBindParameterIndicies(int a_offset) Supported API: false
int	setFromIndicies(int[] a_fromIndicies, int a_offset) This method sets the From clause indicies for components of the expression.
int	validate(TableExpression[] a_fromTables, int a_offset) This method validates the expression against the FROM clause.

Field Detail

BIND_PARAMETER

public static final String BIND_PARAMETER

Label for the attribute; Returns a bind parameter for this expression (if supported).

Supported API: false

See Also:

Constant Field Values

FROM_COUNT

public static final String FROM_COUNT

Label for the attribute; Number of FromClause TableExpressions/Aliases that this expression requires.

Supported API: false

See Also:

Constant Field Values

FROM_INDICIES

public static final String FROM_INDICIES

Label for the attribute; Indicies for all current expressions relative to a FromClause that will be used for validating and setting aliases when this compostie expression is appended to a statement.

Supported API: true

See Also:

Constant Field Values

ADVANCED_QUERY

public static final String ADVANCED_QUERY

Label for the attribute; Indicates if the expression uses advanced query capabilities.

Supported API: false

See Also:

Constant Field Values

CORRELATED_CLASS_ATTRIBUTES

public static final String CORRELATED_CLASS_ATTRIBUTES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ADVANCED_QUERY_ENABLED

public static final String ADVANCED_QUERY_ENABLED

Label for the attribute; Indicates if advanced query capabilities are enabled.

Supported API: false

See Also:

Constant Field Values

Method Detail

getBindParameter

public Object getBindParameter()
                        throws WTException

Gets the value of the attribute: BIND_PARAMETER. Returns a bind parameter for this expression (if supported).

Supported API: false

Returns:

Object

Throws:

WTException

getFromCount

public int getFromCount()

Gets the value of the attribute: FROM_COUNT. Number of FromClause TableExpressions/Aliases that this expression requires.

Supported API: false

Returns:

int

getFromIndicies

public int[] getFromIndicies()

Gets the value of the attribute: FROM_INDICIES. Indicies for all current expressions relative to a FromClause that will be used for validating and setting aliases when this compostie expression is appended to a statement.

Supported API: true

Returns:

int[]

isAdvancedQuery

public boolean isAdvancedQuery()
                        throws WTException

Gets the value of the attribute: ADVANCED_QUERY. Indicates if the expression uses advanced query capabilities.

Supported API: false

Returns:

boolean

Throws:

WTException

getCorrelatedClassAttributes

public List getCorrelatedClassAttributes()

Gets the value of the attribute: CORRELATED_CLASS_ATTRIBUTES.

Supported API: false

Returns:

List

isAdvancedQueryEnabled

public boolean isAdvancedQueryEnabled()

Gets the value of the attribute: ADVANCED_QUERY_ENABLED. Indicates if advanced query capabilities are enabled.

Supported API: false

Returns:

boolean

setAdvancedQueryEnabled

public void setAdvancedQueryEnabled(boolean a_AdvancedQueryEnabled)

Sets the value of the attribute: ADVANCED_QUERY_ENABLED. Indicates if advanced query capabilities are enabled.

Supported API: false

Parameters:

a_AdvancedQueryEnabled -

validate

public int validate(TableExpression[] a_fromTables,
                    int a_offset)
             throws QueryException

This method validates the expression against the FROM clause.

Supported API: false

Parameters:

a_fromTables - TableExpressions to validate against.

a_offset - Offset index into the TableExpression array for the next valid TableExpression

Returns:

number of TableExpressions validated

Throws:

QueryException

setAliases

public int setAliases(String[] a_aliases,
                      int a_offset)
               throws QueryException

This method sets the aliases for components of the expression.

Supported API: false

Parameters:

a_aliases - Aliases to set.

a_offset - Offset index into the alias array for the next valid alias

Returns:

number of aliases used

Throws:

QueryException

getExpression

public String getExpression(boolean a_useBind,
                            Vector a_tableInfos,
                            Vector a_aliases)
                     throws QueryException

Return string representation of this expression.

Supported API: false

Parameters:

a_useBind - Indicates if bind parameters should be used.

a_tableInfos -

a_aliases -

Returns:

String

Throws:

QueryException

setFromIndicies

public int setFromIndicies(int[] a_fromIndicies,
                           int a_offset)

This method sets the From clause indicies for components of the expression.

Supported API: true

Parameters:

a_fromIndicies - From indicies to set.

a_offset - Offset index into the From indicies array for the next valid From index

Returns:

number of indicies used

getClassAttributes

public List getClassAttributes()

Supported API: false

Returns:

List

getJoinConditions

public WhereExpression getJoinConditions(String a_alias)
                                  throws QueryException

This method is to return the join search condition.

Supported API: false

Parameters:

a_alias -

Returns:

WhereExpression

Throws:

QueryException

isAllJoinConditions

public boolean isAllJoinConditions(String a_alias)
                            throws QueryException

Supported API: false

Parameters:

a_alias -

Returns:

boolean

Throws:

QueryException

getJoinIndex

public Set getJoinIndex()

Supported API: false

Returns:

Set

getJoinConditions

public WhereExpression getJoinConditions(JoinIndex a_joinIndex)

This method is to return the join search condition.

Supported API: false

Parameters:

a_joinIndex -

Returns:

WhereExpression

isAllOuterNonJoinConditions

public boolean isAllOuterNonJoinConditions()

Supported API: false

Returns:

boolean

getBindParameterFrom

public Object getBindParameterFrom(Vector a_singleBindParameter)

Supported API: false

Parameters:

a_singleBindParameter -

Returns:

Object

setBindParameterIndicies

public int setBindParameterIndicies(int a_offset)

Supported API: false

Parameters:

a_offset -

Returns:

int

getJoinConditions

public WhereExpression getJoinConditions(Set a_joinIndexSet)

This method is to return the join search condition.

Supported API: false

Parameters:

a_joinIndexSet -

Returns:

WhereExpression

isAllJoinConditions

public boolean isAllJoinConditions(Set a_joinIndexSet)

Supported API: false

Parameters:

a_joinIndexSet -

Returns:

boolean

isAllJoinConditions

public boolean isAllJoinConditions(JoinIndex a_joinIndex)

Supported API: false

Parameters:

a_joinIndex -

Returns:

boolean

getJoinConditions

public WhereExpression getJoinConditions(String a_alias,
                                         boolean a_removed)
                                  throws QueryException

This method is to return the join search condition.

Supported API: false

Parameters:

a_alias -

a_removed -

Returns:

WhereExpression

Throws:

QueryException

isAllJoinConditions

public boolean isAllJoinConditions(String a_alias,
                                   boolean a_removed)
                            throws QueryException

Supported API: false

Parameters:

a_alias -

a_removed -

Returns:

boolean

Throws:

QueryException

getJoinConditions

public WhereExpression getJoinConditions(String a_alias,
                                         int a_outerNonJoinFromIndex,
                                         boolean a_removed)
                                  throws QueryException

This method is to return the join search condition.

Supported API: false

Parameters:

a_alias -

a_outerNonJoinFromIndex -

a_removed -

Returns:

WhereExpression

Throws:

QueryException

handleCorrelatedAttributes

public void handleCorrelatedAttributes(Vector a_tableInfos,
                                       Vector a_aliases)

Supported API: false

Parameters:

a_tableInfos -

a_aliases -