Consultingwerk.OERA.Query.QueryString - SmartComponent Library

Namespace:

Consultingwerk.OERA.Query

Class

QueryString

Parent classes:

Progress.Lang.Object

Consultingwerk.OERA.Query.QueryString

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.OERA.Query.IThrowsErrorsOnInvalidSourceMapping

Inherited by:

Consultingwerk.OERA.Query.DSQueryString, Consultingwerk.OERA.Query.DSQueryStringForKeyValueTable, Consultingwerk.OERA.Query.DSQueryStringProcedural

File:	QueryString
Purpose:	Manage query string tranformation and manipulation.
	String based, need no handles or compilation.
	Manages a query string with field expressions and allows a caller
	to add these expressions to the correct tables in an existing query.
	The main purpose is to support query transformation from a query
	with field expressions against a domain table to a query expressed
	against physical tables.
	The mapping and transformation is optionally triggered by
	passing an object that implements IQueryMap as the second parameter.
	Parameters: pcQueryWhere complete query expression
	pQueryMap optional IQueryMap (columnSource, defaultQuery)
	Notes: This is a copied subset of ADM2's query manipulation with
	additional parsing.
	- The object is in a rather unfinished, unintentended and unplanned...
	- ADM methods and the parsing has overlaps and is rather disjoint.
	- extents... could be changed to classes, but
	- Several private variables, mcQueryWhere, mcTargetQuery,
	mcTargetTables serves no current purpose, except as a
	safety/debug support (afraid to loose control) ...
	(I will of course forget to remove this comment when they are
	removed, so it may not be true ..)
	- The passed pcQueryWhere goes through a rather crude form of parsing
	that may fail with too complex queries ...
	There is still an attempt to handle anything by just giving up and
	treat complex expressions as a single expression while the
	transformation continues.. . If it fails with expressions on
	functions with parenthesis try to add a parenthesis around
	functions that also have parenthesis (no promise..) or fix the code.
	- The passed query is expected to be a working (compilable) dynamic
	temp-table query with no database options like locking. Outer
	joins would not make sense in this context either.
	- It is crucial that all values are quoted to be correctly parsed,
	(also needed to handle non american numeric and date formats,
	assuming same session format settings here as when applied)
	- The transformation can split the expressions on different tables
	if they are using an AND operator. An expression against multiple
	tables with an OR operator between them will be added to the query
	entry of the last of the tables.
	- Allthough some of the code is based on the ADM, it is still meant
	as sample of query manipulation.
	There are alternatives to full parsing.
	The query syntax is after all is a subset of the ABL programming
	language. Maybe reconsider the design to see if some of the
	complexity could be better encapsulated in the data access or data
	source object. Even if this logic expects the query to be in
	compilable form it is not really necessary at this stage, so tokens
	and special patterns could be used to ease the
	transformation/mapping.

Options	Name	Purpose
+	AddQueryWhere (character, character, character)	Inserts a new expression to query's prepare string for a specified buffer.
-	CHARACTER BufferWhereClause (character, character)	Returns the complete query where clause for a specified buffer INCLUDING leading and trailing blanks. EXCLUDING commas and period.
+	CHARACTER BuildQueryString (handle)	Builds the QueryString for the Query
-	LOGICAL CanAddRefTables (character, integer, character)	Evaluates if pcRefTables can be added to piTableLevel entry in a pcTables ordered query
+	CHARACTER CheckIndex (handle)	Returns the Index information of the query used for a buffer
#	ClearQuery ()	Clears the internal state to allow parsing another query string
#	CHARACTER EscapeKnownFunction (character)	Escapes the brackets around known ABL functions in the query string
-	CHARACTER GetEvaluation (integer)
-	CHARACTER GetEvaluationTables (integer, character)
-	CHARACTER GetTableEvaluation (integer, integer, character)	Performs the Query evaluation for a table
-	CHARACTER InsertExpression (character, character, character)	Inserts an expression into ONE buffer's where-clause.
-	CHARACTER InsertString (character, character, integer, integer)	Workaround for temporary core bug
+	LOGICAL InsertToQuery (handle)	Insert the QueryString into the query
-	CHARACTER NewQuerySort (character, character)	/------------------------------------------------------------------------------ Purpose : Insert sort criteria (BY phrase) in a QueryString. Notes: @param pcQuery Query String to add sort to (current sort will be replaced) @param pcSort New sort expression @return The new query string ------------------------------------------------------------------------------/
#	ParseQuery (character)	Parses the logical buffer's target query and stores it for transformation to the datasource query.
#	ParseSortExpression (character)	Parses the Sort Expression
-	CHARACTER ResolveColumn (character, integer)
-	CHARACTER SortExpression (character)	Returns the sort expression of the passed querystring
-	CHARACTER TableEvaluation (integer, character)	Performs the Query evaluation for a table
-	CHARACTER WhereClauseBuffer (character)	Returns the buffername of a where clause expression. This function avoids problems with leading or double blanks in where clauses.

Options

Name

Purpose

AddQueryWhere (character, character, character)

Inserts a new expression to query's prepare string for a specified buffer.

CHARACTER BufferWhereClause (character, character)

Returns the complete query where clause for a specified buffer INCLUDING leading and trailing blanks. EXCLUDING commas and period.

CHARACTER BuildQueryString (handle)

Builds the QueryString for the Query

LOGICAL CanAddRefTables (character, integer, character)

Evaluates if pcRefTables can be added to piTableLevel entry in a pcTables ordered query

CHARACTER CheckIndex (handle)

Returns the Index information of the query used for a buffer

ClearQuery ()

Clears the internal state to allow parsing another query string

CHARACTER EscapeKnownFunction (character)

Escapes the brackets around known ABL functions in the query string

CHARACTER GetEvaluation (integer)

CHARACTER GetEvaluationTables (integer, character)

CHARACTER GetTableEvaluation (integer, integer, character)

Performs the Query evaluation for a table

CHARACTER InsertExpression (character, character, character)

Inserts an expression into ONE buffer's where-clause.

CHARACTER InsertString (character, character, integer, integer)

Workaround for temporary core bug

LOGICAL InsertToQuery (handle)

Insert the QueryString into the query

CHARACTER NewQuerySort (character, character)

/*------------------------------------------------------------------------------ Purpose : Insert sort criteria (BY phrase) in a QueryString. Notes: @param pcQuery Query String to add sort to (current sort will be replaced) @param pcSort New sort expression @return The new query string ------------------------------------------------------------------------------*/

ParseQuery (character)

Parses the logical buffer's target query and stores it for transformation to the datasource query.

ParseSortExpression (character)

Parses the Sort Expression

CHARACTER ResolveColumn (character, integer)

CHARACTER SortExpression (character)

Returns the sort expression of the passed querystring

CHARACTER TableEvaluation (integer, character)

Performs the Query evaluation for a table

CHARACTER WhereClauseBuffer (character)

Returns the buffername of a where clause expression. This function avoids problems with leading or double blanks in where clauses.

	Options	Name	Purpose
	+	QueryString (character, IQueryMap)	Constructor of the QueryString class

Options

Name

Purpose

QueryString (character, IQueryMap)

Constructor of the QueryString class

	Options	Name	Purpose
	+	LOGICAL FilterUsingInnerJoin	Instructs the Query-Builder in method BuildQueryString to remove an eventually present OUTER-JOIN keyword from the source default query when filtering on a ceratin table.
	+	LOGICAL ThrowErrorsOnInvalidSourceMapping	Get and sets if this class throws an error when the client query string contains columns that are not mapped to a data source column

Options

Name

Purpose

LOGICAL FilterUsingInnerJoin

Instructs the Query-Builder in method BuildQueryString to remove an eventually present OUTER-JOIN keyword from the source default query when filtering on a ceratin table.

LOGICAL ThrowErrorsOnInvalidSourceMapping

Get and sets if this class throws an error when the client query string contains columns that are not mapped to a data source column

PUBLIC AddQueryWhere (character, character, character)

PRIVATE CHARACTER BufferWhereClause (character, character)

PUBLIC CHARACTER BuildQueryString (handle)

PRIVATE LOGICAL CanAddRefTables (character, integer, character)

PUBLIC CHARACTER CheckIndex (handle)

PROTECTED ClearQuery ()

PROTECTED CHARACTER EscapeKnownFunction (character)

PRIVATE CHARACTER GetEvaluation (integer)

PRIVATE CHARACTER GetEvaluationTables (integer, character)

PRIVATE CHARACTER GetTableEvaluation (integer, integer, character)

PRIVATE CHARACTER InsertExpression (character, character, character)

PRIVATE CHARACTER InsertString (character, character, integer, integer)

PUBLIC LOGICAL InsertToQuery (handle)

PRIVATE CHARACTER NewQuerySort (character, character)

PROTECTED ParseQuery (character)

PROTECTED ParseSortExpression (character)

PRIVATE CHARACTER ResolveColumn (character, integer)

PRIVATE CHARACTER SortExpression (character)

PRIVATE CHARACTER TableEvaluation (integer, character)

PRIVATE CHARACTER WhereClauseBuffer (character)

PUBLIC QueryString (character, IQueryMap)

PUBLIC LOGICAL FilterUsingInnerJoin

PUBLIC LOGICAL ThrowErrorsOnInvalidSourceMapping