Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.plugins
Class QueryHelper

WEB-INF.cftags.component
        coldbox.system.FrameworkSupertype
            coldbox.system.Plugin
                coldbox.system.plugins.QueryHelper

public class QueryHelper
extends Plugin
extends Plugin

A query helper plugin.

Constructor Summary
`init(any controller)`

Method Summary
`private query`	`QrySetCell(query qryFrom, query qryTo, array ArrayCols, numeric FromRowNumber, numeric ToRowNumber)` Insert value into query
`query`	`doInnerJoin(query qryLeft, query qryRight, string LeftJoinColumn, string RightJoinColumn, [string OrderByElement=''], [boolean CaseSensitive='false'])` Return inner-joined Query
`query`	`doLeftOuterJoin(query qryLeft, query qryRight, string LeftJoinColumn, string RightJoinColumn, [string OrderByElement=''], [boolean CaseSensitive='false'])` Return left outer-joined Query
`query`	`doQueryAppend(query qryFrom, query qryTo)` Append Query1 into Query2
`query`	`filterNull(query qry, string field, [string null='NULL'])` Filters a query by NULL
`query`	`filterQuery(query qry, string field, string value, [string cfsqltype='cf_sql_varchar'], [boolean list='false'])` Filters a query by the given value
`string`	`getCSV(query qry, [string delimiter=','])` returns query in delimited text file format
`any`	`getColumnArray(query qry, string ColumnName)` Returns an array of the values
`numeric`	`getCountDistinct(query qry, string ColumnName)` Returns total/count disninct values
`numeric`	`getRowNumber(query qry, string ColumnValue, string ColumnName)` Returns the row number of the first match
`private string`	`getUnMatchedElements(string FirstList, string secondList)` Returns element which are only present in second-list
`private any`	`getUniqueElements(string FirstList, string secondList)` Returns unique elements from two list
`query`	`querySim(string queryData)` First line are the query columns separated by commas
`query`	`sortQuery(query qry, string sortBy, [string sortOrder='ASC'])` Sorts a query by the given field
`query`	`sortQueryNoCase(query qry, string sortBy, [string sortOrder='ASC'])` Sorts a query by the given field non-case

Methods inherited from class coldbox.system.Plugin
`getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL`

Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class coldbox.system.FrameworkSupertype

$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(any controller)

Parameters:: controller

Method Detail

QrySetCell

private query QrySetCell(query qryFrom, query qryTo, array ArrayCols, numeric FromRowNumber, numeric ToRowNumber)

Insert value into query

doInnerJoin

public query doInnerJoin(query qryLeft, query qryRight, string LeftJoinColumn, string RightJoinColumn, [string OrderByElement=''], [boolean CaseSensitive='false'])

Return inner-joined Query

doLeftOuterJoin

public query doLeftOuterJoin(query qryLeft, query qryRight, string LeftJoinColumn, string RightJoinColumn, [string OrderByElement=''], [boolean CaseSensitive='false'])

Return left outer-joined Query

doQueryAppend

public query doQueryAppend(query qryFrom, query qryTo)

Append Query1 into Query2

filterNull

public query filterNull(query qry, string field, [string null='NULL'])

Filters a query by NULL

filterQuery

public query filterQuery(query qry, string field, string value, [string cfsqltype='cf_sql_varchar'], [boolean list='false'])

Filters a query by the given value

getCSV

public string getCSV(query qry, [string delimiter=','])

returns query in delimited text file format

getColumnArray

public any getColumnArray(query qry, string ColumnName)

Returns an array of the values

getCountDistinct

public numeric getCountDistinct(query qry, string ColumnName)

Returns total/count disninct values

getRowNumber

public numeric getRowNumber(query qry, string ColumnValue, string ColumnName)

Returns the row number of the first match

getUnMatchedElements

private string getUnMatchedElements(string FirstList, string secondList)

Returns element which are only present in second-list

getUniqueElements

private any getUniqueElements(string FirstList, string secondList)

Returns unique elements from two list

querySim

public query querySim(string queryData)

First line are the query columns separated by commas. Then do a consecuent rows separated by line breaks separated by | to denote columns.

sortQuery

public query sortQuery(query qry, string sortBy, [string sortOrder='ASC'])

Sorts a query by the given field

sortQueryNoCase

public query sortQueryNoCase(query qry, string sortBy, [string sortOrder='ASC'])

Sorts a query by the given field non-case

Overview

Package