com.hcl.domino.dql

Interface QueryResultsProcessor

public interface QueryResultsProcessor

Aggregates, computes, sorts, and formats collections of documents across any set of Domino databases.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	QueryResultsProcessor.Categorized
static class	QueryResultsProcessor.Hidden
static class	QueryResultsProcessor.QRPOptions Results processing options
static class	QueryResultsProcessor.SortOrder

Method Summary

Modifier and Type	Method and Description
void	addColumn(String name) Convenience method to add an unsorted column to the processor
void	addFormula(String formula, String columnname, String resultsname) Provides Domino formula language to override the data used to generate values for a particular sort column and an input collection or set of collections.
void	addNoteIds(Database parentDb, Collection<Integer> noteIds, String resultsname) Adds note ids from a database to the query results processor
void	addSortColumn(String name, String title, QueryResultsProcessor.SortOrder sortorder, QueryResultsProcessor.Hidden ishidden, QueryResultsProcessor.Categorized iscategorized) Creates a single column of values to be returned when QueryResultsProcessor execute is performed.
void	executeToJSON(Appendable appendable, Set<QueryResultsProcessor.QRPOptions> options) Processes the input collections in the manner specified by the Sort Columns, overriding field values with formulas specified via addFormula calls, and returns JSON output. The JSON syntax produced by execution conforms to JSON RFC 8259. All results are output under the “StreamedResults” top element key.
Reader	executeToJSON(Set<QueryResultsProcessor.QRPOptions> options) Processes the input collections in the manner specified by the Sort Columns, overriding field values with formulas specified via addFormula calls, and returns JSON output. The JSON syntax produced by execution conforms to JSON RFC 8259. All results are output under the “StreamedResults” top element key.

Method Detail

addColumn

void addColumn(String name)

Convenience method to add an unsorted column to the processor

Parameters:

name - programmatic column name

addSortColumn

void addSortColumn(String name,
                   String title,
                   QueryResultsProcessor.SortOrder sortorder,
                   QueryResultsProcessor.Hidden ishidden,
                   QueryResultsProcessor.Categorized iscategorized)

Creates a single column of values to be returned when QueryResultsProcessor execute is performed. Values for the column can be generated from a field, or a formula. Sorting order, categorization and hidden attributes determine the returned stream of results entries.
Sort columns span all input result sets and databases taking part in the QueryResultsProcessor.

Parameters:

name - The unique (within a QueryResultsProcessor instance) programmatic name of the column. If there is no override using the addFormula method call, the name provided will be treated as a field name in each database involved in the QueryResultsProcessor object. In JSON output, the name value is used the element name for each returned entry.
Values in the name field can specify aggregate functions. These functions require categorized columns and return computed numerical values across sets of results within a category. For aggregate functions requiring a name as an argument, the name can be overridden just as for a name without an aggregate function. For more information on aggregate functions, see the description of the isCategorized parameter.

title - The display title of the column. Used only in generated views, the title is the UI column header.

sortorder - A constant to indicate how the column should be sorted. Values are sorted case and accent insensitively by default. Multiple sort columns can have sort orders, and each order specified is sequentially applied in the order of addSortColumn calls. Field lists (multiply-occurring field values) are compared processed using field occurrences from first to last sequentially.

ishidden - Sorts by a column value without returning the value. If true, the column cannot have a sort order of QueryResultsProcessor.SortOrder.UNORDERED and cannot have an iscategorized value of true.

iscategorized - Categorized columns have a single entry returned for each unique value with entries containing that value nested under it. In JSON results, these nested entries are represented in arrays under each categorized unique value.
Multiply-occurring fields (i.e. lists) are not allowed to be categorized.
A categorized column creates values for any preceding uncategorized column in addition to the categorized column. Categorized columns can nest to create subcategories.

addFormula

void addFormula(String formula,
                String columnname,
                String resultsname)

Provides Domino formula language to override the data used to generate values for a particular sort column and an input collection or set of collections. Since input collections can be created from different databases, design differences can be adjusted using addFormula to have homogenous values in the output.

Parameters:

formula - Formula language string to be evaluated in order to supply the values for a sort column

columnname - String value responding the programmatic name of the sort column whose values are to be generated using the formula language supplied

resultsname - Used to specify the input collection names to which will use the formula language to generate sort column values. Wildcards may be specified to map to multiple input collection names.

executeToJSON

void executeToJSON(Appendable appendable,
                   Set<QueryResultsProcessor.QRPOptions> options)

Processes the input collections in the manner specified by the Sort Columns, overriding field values with formulas specified via addFormula calls, and returns JSON output.

The JSON syntax produced by execution conforms to JSON RFC 8259.
All results are output under the “StreamedResults” top element key. For categorized results, all nested details are output under the “Documents” key.
Special keys “@nid” for NoteID and “@DbPath” are output so results can be acted upon on a document basis.
Fields that are lists on documents (multiply-occurring) are output as JSON arrays of like type.

Parameters:

appendable - the execution result is written in JSON format into this Appendable in small chunks

options - options to tweak the JSON output or null/empty for default format

executeToJSON

Reader executeToJSON(Set<QueryResultsProcessor.QRPOptions> options)

Processes the input collections in the manner specified by the Sort Columns, overriding field values with formulas specified via addFormula calls, and returns JSON output.

The JSON syntax produced by execution conforms to JSON RFC 8259.
All results are output under the “StreamedResults” top element key. For categorized results, all nested details are output under the “Documents” key.
Special keys “@nid” for NoteID and “@DbPath” are output so results can be acted upon on a document basis.
Fields that are lists on documents (multiply-occurring) are output as JSON arrays of like type.

Parameters:

options - options to tweak the JSON output or null/empty for default format

Returns:

reader to receive the the JSON data

addNoteIds

void addNoteIds(Database parentDb,
                Collection<Integer> noteIds,
                String resultsname)

Adds note ids from a database to the query results processor

Parameters:

parentDb - database that contains the documents

noteIds - note ids, e.g. an IDTable

resultsname - A unique name (to the QueryResultsProcessor instance) of the input. This name is used in returned entries when the origin of results is desired and in addFormula method calls to override the data used to create sorted column values.