Skip to main content
Pentaho Documentation

BaseQuery

cdf.queries. BaseQuery

Static
Abstract

Defines the base query type used by default by any dashboard.

While loading this class's module, the static function setBaseQuery is executed in order to make this class the default base query class for any dashboard.

Additional query types might extend from this class, if no valid constructor is provided during the new query type registration.

Please use the dashboard function getQuery to create new queries.

Source: queries/BaseQuery.js, line 169

Members

Name Description
_label :  string
Constant
Protected

The class label.

_name :  string
Constant
Protected

The class name.

dashboard :  cdf.dashboard.Dashboard
Protected

A reference to the dashboard instance.

deepProperties :  Array.<<code>string>
Constant
Protected

A list of properties to be extended to the registered queries.

defaults :  Object
Protected

The default properties.

interfaces :  Object
Protected

The default interfaces.

Methods

Name Description
buildQueryDefinition(overrides)
Abstract

Builds the query definition object.

doQuery(successCallback, errorCallback)

Executes a server-side query.

exportData()
Abstract

Exports the data represented by the query.

fetchData(params, successCallback, errorCallback) : Object

Fetches the data.

getErrorHandler(callback) : function

Gets the error callback handler.

getOption(prop) : Object

Gets an option (fallback for when the OptionManager is not available).

getPage(targetPage, outsideCallback) : boolean | Object

Gets the set of results for the page at index targetPage (0-indexed).

getSuccessHandler(callback) : function

Gets the success callback handler.

init(opts)
Abstract

Initialization function.

initPage(pageSize, outsideCallback) : boolean | Object

Sets the page size and gets the first page of results.

lastProcessedResults() : Object

Gets the last retrieved result after being processed by postFetch.

lastResults() : Object

Gets the last retrieved result.

nextPage(outsideCallback) : Object

Gets the next page of results, as controlled by the pageSize option.

pageStartingAt(page, outsideCallback) : boolean | Object

Runs the query, setting a starting page before doing so.

previousPage(outsideCallback) : Object

Gets the previous page of results, as controlled by the pageSize option.

reprocessLastResults(outerCallback) : Object

Reruns the success callback on the last retrieved result set from the server.

reprocessResults(outsideCallback) : Object

Alias for reprocessLastResults.

setAjaxOptions(newOptions)

Sets the jQuery.ajax options for the query.

setCallback(callback)

Sets the success callback for the query.

setErrorCallback(callback)

Sets the error callback for the query.

setOption(prop, value)

Sets an option (fallback for when the OptionManager is not available).

setPageSize(pageSize)

Sets the page size.

setPageStartingAt(targetPage) : boolean

Sets the starting page for later executions of the query.

setParameters(params)

Sets query parameters.

setSearchPattern(pattern)

Sets the search pattern for the query.

setSortBy(sortBy)
Abstract

Sets the sorting options.

sortBy(sortBy, outsideCallback)
Abstract

Sorts the data and executes a callback.

Members Details

_label:  string
Constant
Protected

The class label.

Source: queries/BaseQuery.js, line 50

Default Value: "Base Query"

_name:  string
Constant
Protected

The class name.

Source: queries/BaseQuery.js, line 35

Default Value: "baseQuery"

dashboard:  cdf.dashboard.Dashboard
Protected

A reference to the dashboard instance.

Source: queries/BaseQuery.js, line 76

deepProperties:  Array.<<code>string>
Constant
Protected

A list of properties to be extended to the registered queries that do not provide their own constructor function.

Source: queries/BaseQuery.js, line 67

Default Value:

["defaults","interfaces"]

See also: registerQuery

defaults:  Object
Protected

The default properties.

Properties:
Name Default Value Description
successCallback : function

Default success callback.

errorCallback : function

Default error callback.

lastResultSet : Object null

The last resultset returned by the query.

lastProcessedResultSet : Object null

The last resultset returned by the query and processed.

page : number 0

The page number.

pageSize : number 0

The page size.

params : Object {}

The query parameters.

ajaxOptions : Object {async:false,type:"POST"}

The jQuery.ajax options for the query.

url : string ""

The target URL.

Source: queries/BaseQuery.js, line 94

interfaces:  Object
Protected

The default interfaces.

Properties:
Name Default Value Description
params : Object

Parameter interfaces.

Properties:
Name Default Value Description
reader : string "propertiesObject"

Parameter reader.

validator : string "isObjectOrPropertiesArray"

Parameter validator.

successCallback : Object

Success callback interfaces.

Properties:
Name Default Value Description
validator : string "isFunction"

Success callback validator.

errorCallback : Object

Error callback interfaces.

Properties:
Name Default Value Description
validator : string "isFunction"

Error callback validator.

pageSize : Object

Page size interfaces.

Properties:
Name Default Value Description
validator : string "isPositive"

Page size validator.

Source: queries/BaseQuery.js, line 137

Methods Details

buildQueryDefinition(overrides)
Abstract

Builds the query definition object.

Source: queries/BaseQuery.js, line 216

Parameters:
Name Default Value Summary
overrides : object
Optional

Options that override the existing ones.

doQuery(successCallback, errorCallback)

Executes a server-side query.

Source: queries/BaseQuery.js, line 267

Parameters:
Name Default Value Summary
successCallback : function
Optional

Success callback.

errorCallback : function
Optional

Error callback.

exportData()
Abstract

Exports the data represented by the query.

Source: queries/BaseQuery.js, line 288

fetchData(params, successCallback, errorCallback) : Object

Fetches the data.

Source: queries/BaseQuery.js, line 349

Parameters:
Name Default Value Summary
params : Object

Parameters for the query.

successCallback : function

Success callback.

errorCallback : function

Error callback.

Returns:
Name Description
Object

The result of calling doQuery with the specified arguments.

Throws:
Name Description
InvalidInput

If the arguments are not correct.

getErrorHandler(callback) : function

Gets the error callback handler that executes the provided callback when the query fails to execute.

Source: queries/BaseQuery.js, line 252

Parameters:
Name Default Value Summary
callback : function

Callback to call if the query fails.

Returns:
Name Description
function

Error callback handler.

getOption(prop) : Object

Gets an option (fallback for when the OptionManager is not available).

Source: queries/BaseQuery.js, line 182

Parameters:
Name Default Value Summary
prop : string

The property from where to get the options.

Returns:
Name Description
Object

Value for the option.

getPage(targetPage, outsideCallback) : boolean | Object

Gets the set of results for the page at index targetPage (0-indexed).

Source: queries/BaseQuery.js, line 579

Parameters:
Name Default Value Summary
targetPage : number

Index of the page to get, starting at index 0.

outsideCallback : function

Success callback to execute when the page is retrieved.

Returns:
Name Description
boolean | Object

false if the page is already the current one, otherwise returns the result of calling doQuery.

Throws:
Name Description
InvalidPage

If targetPage is not a positive number.

getSuccessHandler(callback) : function

Gets the success callback handler that executes the provided callback when the query executes successfully.

Source: queries/BaseQuery.js, line 229

Parameters:
Name Default Value Summary
callback : function

Callback to call after the query is successful.

Returns:
Name Description
function

Success callback handler.

init(opts)
Abstract

Initialization function.

Source: queries/BaseQuery.js, line 205

Parameters:
Name Default Value Summary
opts : Object

The query definition options.

initPage(pageSize, outsideCallback) : boolean | Object

Sets the page size and gets the first page of results.

Source: queries/BaseQuery.js, line 651

Parameters:
Name Default Value Summary
pageSize : number

Page Size.

outsideCallback : function

Success callback to execute after query is retrieved.

Returns:
Name Description
boolean | Object

false if pageSize is invalid, otherwise the result of calling doQuery.

Throws:
Name Description
InvalidPageSize

If the page size is not a positive number.

lastProcessedResults() : Object

Gets the last retrieved result after being processed by postFetch.

Source: queries/BaseQuery.js, line 431

Returns:
Name Description
Object

A deep copy of the the last result set obtained from the server after being processed by postFetch.

Throws:
Name Description
NoCachedResults

If there have not been previous calls to the server.

lastResults() : Object

Gets the last retrieved result.

Source: queries/BaseQuery.js, line 415

Returns:
Name Description
Object

A deep copy of the last result set obtained from the server.

Throws:
Name Description
NoCachedResults

If there have not been previous calls to the server.

nextPage(outsideCallback) : Object

Gets the next page of results, as controlled by the pageSize option.

Source: queries/BaseQuery.js, line 533

Parameters:
Name Default Value Summary
outsideCallback : function

Success callback to execute when the next page of results is retrieved.

Returns:
Name Description
Object

The result of calling doQuery.

Throws:
Name Description
InvalidPageSize

If the page size option is not a positive number.

pageStartingAt(page, outsideCallback) : boolean | Object

Runs the query, setting a starting page before doing so. If the starting page matches the already selected one, the query run is canceled and false is returned.

Source: queries/BaseQuery.js, line 623

Parameters:
Name Default Value Summary
page : number

Starting page index.

outsideCallback : function

Success callback to execute after the server-side query is processed.

Returns:
Name Description
boolean | Object

false if the query run is canceled, otherwise the result of calling doQuery.

previousPage(outsideCallback) : Object

Gets the previous page of results, as controlled by the pageSize option.

Source: queries/BaseQuery.js, line 554

Parameters:
Name Default Value Summary
outsideCallback : function

Success callback to execute when the previous page of results is retrieved.

Returns:
Name Description
Object

The result of calling doQuery.

Throws:
Name Description
AtBeginning

If current page is the first one.

reprocessLastResults(outerCallback) : Object

Reruns the success callback on the last retrieved result set from the server.

Source: queries/BaseQuery.js, line 448

Parameters:
Name Default Value Summary
outerCallback : function

Success callback.

Returns:
Name Description
Object

The result of calling the specified callback.

Throws:
Name Description
NoCachedResults

If there have not been previous calls to the server.

See also: reprocessResults

reprocessResults(outsideCallback) : Object

Alias for reprocessLastResults.

Source: queries/BaseQuery.js, line 473

Parameters:
Name Default Value Summary
outsideCallback : function

Success callback.

Returns:
Name Description
Object

The result of calling the specified callback.

Throws:
Name Description
NoCachedResults

If there have not been previous calls to the server.

See also: reprocessLastResults

setAjaxOptions(newOptions)

Sets the jQuery.ajax options for the query.

Source: queries/BaseQuery.js, line 298

Parameters:
Name Default Value Summary
newOptions : Object

Ajax options to be added.

setCallback(callback)

Sets the success callback for the query.

Source: queries/BaseQuery.js, line 493

Parameters:
Name Default Value Summary
callback : function

The success callback function.

setErrorCallback(callback)

Sets the error callback for the query.

Source: queries/BaseQuery.js, line 503

Parameters:
Name Default Value Summary
callback : function

The error callback function.

setOption(prop, value)

Sets an option (fallback for when the OptionManager is not available).

Source: queries/BaseQuery.js, line 193

Parameters:
Name Default Value Summary
prop : string

The property for which the value will be set.

value : Object

Value for the property.

setPageSize(pageSize)

Sets the page size.

Source: queries/BaseQuery.js, line 637

Parameters:
Name Default Value Summary
pageSize : number

Page size to set.

setPageStartingAt(targetPage) : boolean

Sets the starting page for later executions of the query.

Source: queries/BaseQuery.js, line 601

Parameters:
Name Default Value Summary
targetPage : number

Index of the page to get.

Returns:
Name Description
boolean

true if the page is correctly set, false if the target page is already the selected one.

Throws:
Name Description
InvalidPage

If the page number is not a positive number.

setParameters(params)

Sets query parameters.

Source: queries/BaseQuery.js, line 483

Parameters:
Name Default Value Summary
params : Object

The query parameters.

setSearchPattern(pattern)

Sets the search pattern for the query.

Source: queries/BaseQuery.js, line 513

Parameters:
Name Default Value Summary
pattern : string

The search pattern.

setSortBy(sortBy)
Abstract

Sets the sorting options.

Source: queries/BaseQuery.js, line 321

Parameters:
Name Default Value Summary
sortBy : string

Sorting options.

sortBy(sortBy, outsideCallback)
Abstract

Sorts the data, specifying a callback that will be called after the sorting takes place.

Source: queries/BaseQuery.js, line 333

Parameters:
Name Default Value Summary
sortBy : string

Sorting options.

outsideCallback : function

Post-sort callback.