IRISLIB database
QueryInfo Class Reference

This is a server-class used to pass information specifying how to build a result set object. More...

Inheritance diagram for QueryInfo:
Collaboration diagram for QueryInfo:

Static Public Member Functions

 QuoteSQL (_.Library.String pVal, _.Library.String pType)
 Take a value and return an SQL literal (with quotes and. More...
 

Public Attributes

 columnExpression
 Optional SQL expression to use for a column, subcripted by column name:
More...
 
 columnName
 Name of column used to provide data. More...
 
 columns
 Names of columns within the query, subcripted by column number:
More...
 
 filterOps
 Set of column filter operations subscripted by column name:
More...
 
 filterTypes
 Set of column filter types subscripted by column name:
More...
 
 filters
 Set of column filter values subscripted by column name:
More...
 
 groupByClause
 Optional GROUP BY clause for tables in auto sql mode. More...
 
 orderByClause
 Optional ORDER BY clause for tables in auto sql mode. More...
 
 parms
 Set of query parameter values subscripted by parameter number:
More...
 
 queryExecuted
 Output property. More...
 
 queryText
 Output property. More...
 
 rowCount
 Output property. More...
 
 rows
 The number of rows that the component will display. More...
 
 sortColumn
 Optional name of column to sort results by. More...
 
 sortOrder
 Specifies direction of sorting, if any. More...
 
 tableName
 Name of table used to provide data. More...
 
 whereClause
 Optional WHERE clause for tables in auto sql mode. More...
 

Private Member Functions

_.Library.Status CreateSQL (_.Library.Boolean pComputeRowCount, _.ZEN.Auxiliary.QueryInfo pInfo)
 Utility method: construct a (very simple) SQL statement based on the. More...
 

Static Private Member Functions

_.Library.Boolean IsValidSQLName (_.Library.String pName)
 Test if pName is a valid SQL name.
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

This is a server-class used to pass information specifying how to build a result set object.


This is used by classes that inherit from the <class>querySource</class> class. Some of these properties are only relevant for tables.

Member Function Documentation

◆ CreateSQL()

_.Library.Status CreateSQL ( _.Library.Boolean  pComputeRowCount,
_.ZEN.Auxiliary.QueryInfo  pInfo 
)
private

Utility method: construct a (very simple) SQL statement based on the.

specifications contains within this object's properties. The resulting query is placed within the <property>queryText</property> property.

◆ QuoteSQL()

QuoteSQL ( _.Library.String  pVal,
_.Library.String  pType 
)
static

Take a value and return an SQL literal (with quotes and.

escaped quotes as needed).
pType is the "filter" type: if "date" quote as ODBC literal.

Member Data Documentation

◆ columnExpression

columnExpression

Optional SQL expression to use for a column, subcripted by column name:

..columnExpression(colname) = expr
This will be provided for tables that use auto sql mode.  

◆ columnName

columnName

Name of column used to provide data.

This is used for tables that are auto-generated when no other column information is available.  

◆ columns

columns

Names of columns within the query, subcripted by column number:

..columns(n) = colName
This will be provided for tables that use auto sql mode.  

◆ filterOps

filterOps

Set of column filter operations subscripted by column name:

..filterOps(colName) = op
Where op is an SQL operation: STARTSWITH, =, etc.  

◆ filterTypes

filterTypes

Set of column filter types subscripted by column name:

..filterTypes(colName) = type
 

◆ filters

filters

Set of column filter values subscripted by column name:

..filters(colName) = filterValue  

◆ groupByClause

groupByClause

Optional GROUP BY clause for tables in auto sql mode.

 

◆ orderByClause

orderByClause

Optional ORDER BY clause for tables in auto sql mode.

 

◆ parms

parms

Set of query parameter values subscripted by parameter number:

..parms(n) = value  

◆ queryExecuted

queryExecuted

Output property.


Set this property to true in OnCreateResultSet method to indicate that the newly created ResultSet has already been executed.  

◆ queryText

queryText

Output property.


This is also used for the output of the <method>CreateQuery</method> method.
When a query is executed, the text of the query (either sql or query name) is placed here (for diagnostic purposes).  

◆ rowCount

rowCount

Output property.


Query will place number of rows in query here if it wants to report this value to the client.  

◆ rows

rows

The number of rows that the component will display.

For a "snapshot" query this will be the size of the snapshot.  

◆ sortColumn

sortColumn

Optional name of column to sort results by.

If the table is in auto sql mode, then this is used as the first part of the generated ORDER BY clause.  

◆ sortOrder

sortOrder

Specifies direction of sorting, if any.

This applies to the column specified by <property>sortColumn</property>.  

◆ tableName

tableName

Name of table used to provide data.

This will be provided for tables that use auto sql mode.  

◆ whereClause

whereClause

Optional WHERE clause for tables in auto sql mode.