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 170
Members
_label : stringConstant Protected
The class label.
_name : stringConstant Protected
The class name.
dashboard : cdf.dashboard.DashboardProtected
A reference to the dashboard instance.
deepProperties : Array.<`string`>Constant Protected
A list of properties to be extended to the registered queries.
defaults : ObjectProtected
The default properties.
interfaces : ObjectProtected
The default interfaces.
Methods
buildQueryDefinition(overrides)Abstract
Builds the query definition object.
dispose()
Dispose the query 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: stringConstant Protected
The class label.
**Source:**queries/BaseQuery.js, line 50
Default Value:"Base Query"
_name: stringConstant Protected
The class name.
**Source:**queries/BaseQuery.js, line 35
Default Value:"baseQuery"
dashboard: cdf.dashboard.DashboardProtected
A reference to the dashboard instance.
**Source:**queries/BaseQuery.js, line 76
deepProperties: Array.<`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: ObjectProtected
The default properties.
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
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.
interfaces: ObjectProtected
The default interfaces.
Name
Default Value
Description
params : Object
Parameter interfaces.
reader : string
"propertiesObject"
Parameter reader.
validator : string
"isObjectOrPropertiesArray"
Parameter validator.
Name
Default Value
Description
reader : string
"propertiesObject"
Parameter reader.
validator : string
"isObjectOrPropertiesArray"
Parameter validator.
successCallback : Object
Success callback interfaces.
validator : string
"isFunction"
Success callback validator.
Name
Default Value
Description
validator : string
"isFunction"
Success callback validator.
errorCallback : Object
Error callback interfaces.
validator : string
"isFunction"
Error callback validator.
Name
Default Value
Description
validator : string
"isFunction"
Error callback validator.
pageSize : Object
Page size interfaces.
validator : string
"isPositive"
Page size validator.
Name
Default Value
Description
validator : string
"isPositive"
Page size validator.
**Source:**queries/BaseQuery.js, line 138
Name
Default Value
Description
params : Object
Parameter interfaces.
reader : string
"propertiesObject"
Parameter reader.
validator : string
"isObjectOrPropertiesArray"
Parameter validator.
Name
Default Value
Description
reader : string
"propertiesObject"
Parameter reader.
validator : string
"isObjectOrPropertiesArray"
Parameter validator.
successCallback : Object
Success callback interfaces.
validator : string
"isFunction"
Success callback validator.
Name
Default Value
Description
validator : string
"isFunction"
Success callback validator.
errorCallback : Object
Error callback interfaces.
validator : string
"isFunction"
Error callback validator.
Name
Default Value
Description
validator : string
"isFunction"
Error callback validator.
pageSize : Object
Page size interfaces.
validator : string
"isPositive"
Page size validator.
Name
Default Value
Description
validator : string
"isPositive"
Page size validator.
## Methods Details
buildQueryDefinition(overrides)Abstract
Builds the query definition object.
**Source:**queries/BaseQuery.js, line 217
overrides : objectOptional
Options that override the existing ones.
Name
Default Value
Summary
overrides : objectOptional
Options that override the existing ones.
dispose()
Dispose the query object.
**Source:**queries/BaseQuery.js, line 668
doQuery(successCallback, errorCallback)
Executes a server-side query.
**Source:**queries/BaseQuery.js, line 268
successCallback : functionOptional
Success callback.
errorCallback : functionOptional
Error callback.
Name
Default Value
Summary
successCallback : functionOptional
Success callback.
errorCallback : functionOptional
Error callback.
exportData()Abstract
Exports the data represented by the query.
**Source:**queries/BaseQuery.js, line 289
fetchData(params, successCallback, errorCallback) : Object
Fetches the data.
**Source:**queries/BaseQuery.js, line 350
params : Object
Parameters for the query.
successCallback : function
Success callback.
errorCallback : function
Error callback.
Object
The result of calling doQuery with the specified arguments.
InvalidInput
If the arguments are not correct.
Name
Default Value
Summary
params : Object
Parameters for the query.
successCallback : function
Success callback.
errorCallback : function
Error callback.
Name
Description
Object
The result of calling doQuery with the specified arguments.
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 253
callback : function
Callback to call if the query fails.
function
Error callback handler.
Name
Default Value
Summary
callback : function
Callback to call if the query fails.
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 183
prop : string
The property from where to get the options.
Object
Value for the option.
Name
Default Value
Summary
prop : string
The property from where to get the options.
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 580
targetPage : number
Index of the page to get, starting at index 0.
outsideCallback : function
Success callback to execute when the page is retrieved.
boolean | Object
false if the page is already the current one, otherwise returns the result of calling doQuery.
InvalidPage
If targetPage is not a positive number.
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.
Name
Description
boolean | Object
false if the page is already the current one, otherwise returns the result of calling doQuery.
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 230
callback : function
Callback to call after the query is successful.
function
Success callback handler.
Name
Default Value
Summary
callback : function
Callback to call after the query is successful.
Name
Description
function
Success callback handler.
init(opts)Abstract
Initialization function.
**Source:**queries/BaseQuery.js, line 206
opts : Object
The query definition options.
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 652
pageSize : number
Page Size.
outsideCallback : function
Success callback to execute after query is retrieved.
boolean | Object
false if pageSize is invalid, otherwise the result of calling doQuery.
InvalidPageSize
If the page size is not a positive number.
Name
Default Value
Summary
pageSize : number
Page Size.
outsideCallback : function
Success callback to execute after query is retrieved.
Name
Description
boolean | Object
false if pageSize is invalid, otherwise the result of calling doQuery.
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 432
Object
A deep copy of the the last result set obtained from the server after being processed by postFetch.
NoCachedResults
If there have not been previous calls to the server.
Name
Description
Object
A deep copy of the the last result set obtained from the server after being processed by postFetch.
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 416
Object
A deep copy of the last result set obtained from the server.
NoCachedResults
If there have not been previous calls to the server.
Name
Description
Object
A deep copy of the last result set obtained from the server.
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 534
outsideCallback : function
Success callback to execute when the next page of results is retrieved.
Object
The result of calling doQuery.
InvalidPageSize
If the page size option is not a positive number.
Name
Default Value
Summary
outsideCallback : function
Success callback to execute when the next page of results is retrieved.
Name
Description
Object
The result of calling doQuery.
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 624
page : number
Starting page index.
outsideCallback : function
Success callback to execute after the server-side query is processed.
boolean | Object
false if the query run is canceled, otherwise the result of calling doQuery.
Name
Default Value
Summary
page : number
Starting page index.
outsideCallback : function
Success callback to execute after the server-side query is processed.
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 555
outsideCallback : function
Success callback to execute when the previous page of results is retrieved.
Object
The result of calling doQuery.
AtBeginning
If current page is the first one.
Name
Default Value
Summary
outsideCallback : function
Success callback to execute when the previous page of results is retrieved.
Name
Description
Object
The result of calling doQuery.
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 449
outerCallback : function
Success callback.
Object
The result of calling the specified callback.
NoCachedResults
If there have not been previous calls to the server.
See also:reprocessResults
Name
Default Value
Summary
outerCallback : function
Success callback.
Name
Description
Object
The result of calling the specified callback.
Name
Description
NoCachedResults
If there have not been previous calls to the server.
reprocessResults(outsideCallback) : Object
Alias for reprocessLastResults.
**Source:**queries/BaseQuery.js, line 474
outsideCallback : function
Success callback.
Object
The result of calling the specified callback.
NoCachedResults
If there have not been previous calls to the server.
See also:reprocessLastResults
Name
Default Value
Summary
outsideCallback : function
Success callback.
Name
Description
Object
The result of calling the specified callback.
Name
Description
NoCachedResults
If there have not been previous calls to the server.
setAjaxOptions(newOptions)
Sets the jQuery.ajax options for the query.
**Source:**queries/BaseQuery.js, line 299
newOptions : Object
Ajax options to be added.
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 494
callback : function
The success callback function.
Name
Default Value
Summary
callback : function
The success callback function.
setErrorCallback(callback)
Sets the error callback for the query.
**Source:**queries/BaseQuery.js, line 504
callback : function
The error callback function.
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 194
prop : string
The property for which the value will be set.
value : Object
Value for the property.
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 638
pageSize : number
Page size to set.
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 602
targetPage : number
Index of the page to get.
boolean
true if the page is correctly set, false if the target page is already the selected one.
InvalidPage
If the page number is not a positive number.
Name
Default Value
Summary
targetPage : number
Index of the page to get.
Name
Description
boolean
true if the page is correctly set, false if the target page is already the selected one.
Name
Description
InvalidPage
If the page number is not a positive number.
setParameters(params)
Sets query parameters.
**Source:**queries/BaseQuery.js, line 484
params : Object
The query parameters.
Name
Default Value
Summary
params : Object
The query parameters.
setSearchPattern(pattern)
Sets the search pattern for the query.
**Source:**queries/BaseQuery.js, line 514
pattern : string
The search pattern.
Name
Default Value
Summary
pattern : string
The search pattern.
setSortBy(sortBy)Abstract
Sets the sorting options.
**Source:**queries/BaseQuery.js, line 322
sortBy : string
Sorting options.
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 334
sortBy : string
Sorting options.
outsideCallback : function
Post-sort callback.
Name
Default Value
Summary
sortBy : string
Sorting options.
outsideCallback : function
Post-sort callback.
Last updated
Was this helpful?