Interface for building WHERE expressions. More...

import"sbISQLBuilder.idl";

Inheritance diagram for sbISQLWhereBuilder:

Collaboration diagram for sbISQLWhereBuilder:

Public Member Functions
void	addCriterion (in sbISQLBuilderCriterion aCriterion)
	Add a criteria constraint to the query. More...

void	removeCriterion (in sbISQLBuilderCriterion aCriterion)
	Remve a criteria constraint from the query. More...

sbISQLBuilderCriterion	createMatchCriterionString (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType, in AString aValue)
	Create a match criterion with an AString datatype. More...

sbISQLBuilderCriterion	createMatchCriterionBetweenString (in AString aTableName, in AString aSrcColumnName, in AString aLeftValue, in AString aRightValue)

sbISQLBuilderCriterion	createMatchCriterionNotBetweenString (in AString aTableName, in AString aSrcColumnName, in AString aLeftValue, in AString aRightValue)

sbISQLBuilderCriterion	createMatchCriterionLong (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType, in long aValue)
	Create a match criterion with a long (32 bit) datatype. More...

sbISQLBuilderCriterion	createMatchCriterionLongLong (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType, in long long aValue)
	Create a match criterion with a long long (64 bit) datatype. More...

sbISQLBuilderCriterion	createMatchCriterionNull (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType)
	Create a match criterion that tests against the null value. More...

sbISQLBuilderCriterion	createMatchCriterionTable (in AString aLeftTableName, in AString aLeftColumnName, in unsigned long aMatchType, in AString aRightTableName, in AString aRightColumnName)
	Create a match criterion that tests against a table column. More...

sbISQLBuilderCriterionIn	createMatchCriterionIn (in AString aTableName, in AString aSrcColumnName)
	Create a match criterion using the IN() operator. More...

sbISQLBuilderCriterion	createMatchCriterionParameter (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType)
	Create a match criterion that tests against a parameter placeholder. More...

sbISQLBuilderCriterion	createAndCriterion (in sbISQLBuilderCriterion aLeft, in sbISQLBuilderCriterion aRight)
	Create a match criterion that is the logical AND of two critera. More...

sbISQLBuilderCriterion	createOrCriterion (in sbISQLBuilderCriterion aLeft, in sbISQLBuilderCriterion aRight)
	Create a match criterion that is the logical OR of two critera. More...

Public Member Functions inherited from sbISQLBuilder
void	addJoin (in unsigned long aJoinType, in AString aJoinedTableName, in AString aJoinedTableAlias, in AString aJoinedColumnName, in AString aJoinToTableName, in AString aJoinToColumnName)
	Add a join to the query. More...

void	addJoinWithIndexHint (in unsigned long aJoinType, in AString aJoinedTableName, in AString aJoinedTableAlias, in AString aJoinedColumnName, in AString aJoinToTableName, in AString aJoinToColumnName, in boolean aRequiresFromTableIndexHint, in boolean aRequiresToTableIndexHint)
	Add a join to the query. More...

void	addSubqueryJoin (in unsigned long aJoinType, in sbISQLSelectBuilder aJoinedSubquery, in AString aJoinedTableAlias, in AString aJoinedColumnName, in AString aJoinToTableName, in AString aJoinToColumnName)
	Add a subquery join join to the query. More...

void	addJoinWithCriterion (in unsigned long aJoinType, in AString aJoinedTableName, in AString aJoinedTableAlias, in sbISQLBuilderCriterion aCriterion)
	Add a join to the query with a critera object specifcying the join constraints. More...

void	addSubquery (in sbISQLSelectBuilder aSubquery, in AString aAlias)
	Add a subquery to the from clause. More...

void	reset ()
	Clears out query configuration to this instance can be reused. More...

AString	toString ()
	Return the generated SQL statement for the query. More...

Additional Inherited Members
Public Attributes inherited from sbISQLBuilder
const unsigned long	MATCH_EQUALS = 0

const unsigned long	MATCH_NOTEQUALS = 1

const unsigned long	MATCH_GREATER = 2

const unsigned long	MATCH_GREATEREQUAL = 3

const unsigned long	MATCH_LESS = 4

const unsigned long	MATCH_LESSEQUAL = 5

const unsigned long	MATCH_LIKE = 6

const unsigned long	MATCH_NOTLIKE = 7

const unsigned long	MATCH_MATCH = 8

attribute long	limit
	Value for the limit clause. More...

attribute boolean	limitIsParameter
	Is the limit clause a parameter? More...

attribute long	offset
	Value for the offset clause. More...

attribute boolean	offsetIsParameter
	Is the offset clause a parameter? More...

const unsigned long	JOIN_INNER = 0

const unsigned long	JOIN_LEFT = 1

const unsigned long	JOIN_LEFT_OUTER = 2

Detailed Description

Interface for building WHERE expressions.

Definition at line 184 of file sbISQLBuilder.idl.

Member Function Documentation

void sbISQLWhereBuilder::addCriterion ( in sbISQLBuilderCriterion aCriterion )

Add a criteria constraint to the query.

Parameters

aCriterion The Criterion to add

sbISQLBuilderCriterion sbISQLWhereBuilder::createAndCriterion	(	in sbISQLBuilderCriterion	aLeft,
		in sbISQLBuilderCriterion	aRight
	)

Create a match criterion that is the logical AND of two critera.

Parameters

aLeft	The left side of the expression
aRight	The right side of the expression

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionBetweenString	(	in AString	aTableName,
		in AString	aSrcColumnName,
		in AString	aLeftValue,
		in AString	aRightValue
	)

sbISQLBuilderCriterionIn sbISQLWhereBuilder::createMatchCriterionIn	(	in AString	aTableName,
		in AString	aSrcColumnName
	)

Create a match criterion using the IN() operator.

Parameters

aTableName	The table name the column in the Criterion belongs to
aSrcColumnName	The name the column to use in the criterion

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionLong	(	in AString	aTableName,
		in AString	aSrcColumnName,
		in unsigned long	aMatchType,
		in long	aValue
	)

Create a match criterion with a long (32 bit) datatype.

Parameters

aTableName	The table name the column in the criterion belongs to
aSrcColumnName	The name of the column to use in the criterion
aMatchType	The criterion match type, must be one of the MATCH constant values
aValue	The long value to match against

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionLongLong	(	in AString	aTableName,
		in AString	aSrcColumnName,
		in unsigned long	aMatchType,
		in long long	aValue
	)

Create a match criterion with a long long (64 bit) datatype.

Parameters

aTableName	The table name the column in the criterion belongs to
aSrcColumnName	The name of the column to use in the criterion
aMatchType	The criterion match type, must be one of the MATCH constant values
aValue	The long long value to match against

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionNotBetweenString	(	in AString	aTableName,
		in AString	aSrcColumnName,
		in AString	aLeftValue,
		in AString	aRightValue
	)

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionNull	(	in AString	aTableName,
		in AString	aSrcColumnName,
		in unsigned long	aMatchType
	)

Create a match criterion that tests against the null value.

Parameters

aTableName	The table name the column in the Criterion belongs to
aSrcColumnName	The name the column to use in the criterion
aMatchType	The criterion match type, must be either MATCH_EQUALS or MATCH_NOTEQUALS

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionParameter	(	in AString	aTableName,
		in AString	aSrcColumnName,
		in unsigned long	aMatchType
	)

Create a match criterion that tests against a parameter placeholder.

Parameters

aTableName	The table name the column in the Criterion belongs to
aSrcColumnName	The name the column to use in the criterion
aMatchType	The criterion match type

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionString	(	in AString	aTableName,
		in AString	aSrcColumnName,
		in unsigned long	aMatchType,
		in AString	aValue
	)

Create a match criterion with an AString datatype.

Parameters

aTableName	The table name the column in the criterion belongs to
aSrcColumnName	The name the column to use in the criterion
aMatchType	The criterion match type, must be one of the MATCH constant values
aValue	The AString value to match agains

sbISQLBuilderCriterion sbISQLWhereBuilder::createMatchCriterionTable	(	in AString	aLeftTableName,
		in AString	aLeftColumnName,
		in unsigned long	aMatchType,
		in AString	aRightTableName,
		in AString	aRightColumnName
	)

Create a match criterion that tests against a table column.

Parameters

aLeftTableName	The table name on the left side of the match
aLeftColumnName	The column name on the right side of the match
aMatchType	The criterion match type
aRightTableName	The table name on the left side of the match
aRightColumnName	The column name on the right side of the match

sbISQLBuilderCriterion sbISQLWhereBuilder::createOrCriterion	(	in sbISQLBuilderCriterion	aLeft,
		in sbISQLBuilderCriterion	aRight
	)

Create a match criterion that is the logical OR of two critera.

Parameters

aLeft	The left side of the expression
aRight	The right side of the expression

void sbISQLWhereBuilder::removeCriterion ( in sbISQLBuilderCriterion aCriterion )

Remve a criteria constraint from the query.

Parameters

aCriterion The Criterion to remove

The documentation for this interface was generated from the following file:

/home/martin/dev/nightingale-hacking/components/sqlbuilder/public/sbISQLBuilder.idl

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation