Query class
Represents Query.
- attributeExprTag
- clientListRequestHandler
- extraData
- isNewbie
- model
- serverListRequestHandler
- timezoneOffset
- addChangedCallback
- addColumn
- addColumnObj
- addConditionGroup
- addProcessCallback
- addSimpleCondition
- changeColumnType
- clear
- clearColumns
- clearConditions
- createColumn
- createCondition
- fireChangedEvent
- fireColumnsChangedEvent
- fireConditionsChangedEvent
- fireProcessEvent
- getColumnSortIndex
- getColumns
- getConditionsText
- getDescription
- getId
- getModel
- getName
- getOneValueForAttr
- getRootCondition
- getSortedColumns
- isEmptyColumns
- isEmptyConditions
- isEx
- isModified
- loadFromData
- loadFromDataOrJson
- loadFromJson
- loadModelData
- moveColumn
- regenerateId
- removeChangedCallback
- removeColumn
- removeColumns
- removeProcessCallback
- reset
- resetModified
- runThroughConditions
- setDefaultName
- setDescription
- setId
- setModel
- setName
- toJSON
- toJSONData
Constructors
Section titled “Constructors”constructor
Section titled “constructor”The default constructor. ⊕ new Query(model?: DataModel,data?: QueryData,options?: QueryOptions): Query
Parameters:
Section titled “Parameters:”- model: DataModel, Optional - The data model.
- data: QueryData, Optional - JSON representation object.
- options: QueryOptions, Optional - The options.
Public Properties
Section titled “Public Properties”attributeExprTag
Section titled “attributeExprTag”The attributec class name (Tag).
● attributeExprTag: ExprTag
clientListRequestHandler
Section titled “clientListRequestHandler”● clientListRequestHandler: any
extraData
Section titled “extraData”Contains user-defined extra data for current query.
● extraData: any
isNewbie
Section titled “isNewbie”● isNewbie: boolean
= true
The Data Model associated with this query.
● model: DataModel
serverListRequestHandler
Section titled “serverListRequestHandler”● serverListRequestHandler: any
timezoneOffset
Section titled “timezoneOffset”Current timezone offset (it’s sent to the server for proper date/time values processing).
● timezoneOffset: number
Public Methods
Section titled “Public Methods”addChangedCallback
Section titled “addChangedCallback”Add changed callback
▸ addChangedCallback(callback: (event: EqEvent) => void
): string
Parameters:
Section titled “Parameters:”- callback: (event: EqEvent) =>
void
- The callback ID.
Returns string
addColumn
Section titled “addColumn”Adds a new column with specified parameters
▸ addColumn(descriptor: ColumnDescriptor,author?: string
): Column
Parameters:
Section titled “Parameters:”- descriptor: ColumnDescriptor
- author:
string
, Optional - The author of this operation. This parameter is used in EasyQuery widgets only to indicate which of the initiates the change.
Returns Column
Example:
Section titled “Example:”query.addColumn({ attributeId: 'Customers.CompanyName', sortIndex: SortDirection.Ascending}});
addColumnObj
Section titled “addColumnObj”Adds a new column with specified index.
▸ addColumnObj(column: Column | Column[],index: any
,author: any
): void
Parameters:
Section titled “Parameters:”- column: Column | Column[] - The column or array of columns
- index:
any
- The index of new column - author:
any
- The author.
Returns void
Example:
Section titled “Example:”const column = new Column();column.caption = "Company name";
query.addColumn(column, 1)
addConditionGroup
Section titled “addConditionGroup”Adds a condition group - a group of simple conditions (predicates) linked by AND or OR
▸ addConditionGroup(descriptor: ConditionGroupDescriptor,addChildCondition?: boolean
): Condition
Parameters:
Section titled “Parameters:”- descriptor: ConditionGroupDescriptor - The descriptor of the new condition group.
- addChildCondition:
boolean
, Default value =true
Returns Condition - The new search condition.
addProcessCallback
Section titled “addProcessCallback”Add process callback
▸ addProcessCallback(callback: (event: EqEvent) => void
): string
Parameters:
Section titled “Parameters:”- callback: (event: EqEvent) =>
void
- The callback.
Returns string
addSimpleCondition
Section titled “addSimpleCondition”Adds a new simple condition (a predicate)
▸ addSimpleCondition(descriptor: SimpleConditionDescriptor): Condition
Parameters:
Section titled “Parameters:”- descriptor: SimpleConditionDescriptor - The descriptor which defines different parameters of the new condition
Returns Condition - The new condition.
changeColumnType
Section titled “changeColumnType”Changes column to Aggregate function, custom expression or simple column.
▸ changeColumnType(column: Column,tag: ExprTag,args?: any
): void
Parameters:
Section titled “Parameters:”- column: Column - The column to change.
- tag: ExprTag - New column expression tag.
- args:
any
, Optional - The arguments (Contains aggregate function id)
Returns void
Clears query (all conditions and columns).
▸ clear(): void
Returns void
clearColumns
Section titled “clearColumns”Clears all columns in query
▸ clearColumns(): void
Returns void
clearConditions
Section titled “clearConditions”Clears all conditions in query.
▸ clearConditions(): void
Returns void
createColumn
Section titled “createColumn”▸ createColumn(): Column
Returns Column
createCondition
Section titled “createCondition”▸ createCondition(tag?: CondTag): Condition
Parameters:
Section titled “Parameters:”- tag: CondTag, Default value =
CondTag.Simple
Returns Condition
fireChangedEvent
Section titled “fireChangedEvent”Fires change event.
▸ fireChangedEvent(data?: QueryChangeEventData,postpone?: number
,wasModified?: boolean
): void
Parameters:
Section titled “Parameters:”-
data: QueryChangeEventData, Optional - The data.
-
postpone:
number
, Default value =0
- The postpone. -
wasModified:
boolean
, Default value =true
Returns void
fireColumnsChangedEvent
Section titled “fireColumnsChangedEvent”▸ fireColumnsChangedEvent(action?: QueryChangeAction,column?: Column | Column[]): void
Parameters:
Section titled “Parameters:”- action: QueryChangeAction, Optional
- column: Column | Column[], Optional
Returns void
fireConditionsChangedEvent
Section titled “fireConditionsChangedEvent”▸ fireConditionsChangedEvent(action?: QueryChangeAction,condition?: Condition | Condition[]): void
Parameters:
Section titled “Parameters:”- action: QueryChangeAction, Optional
- condition: Condition | Condition[], Optional
Returns void
fireProcessEvent
Section titled “fireProcessEvent”Fires process event.
▸ fireProcessEvent(data: any
): void
Parameters:
Section titled “Parameters:”- data:
any
- The data.
Returns void
getColumnSortIndex
Section titled “getColumnSortIndex”Gets Colummn sorting index.
▸ getColumnSortIndex(col: Column): number
Parameters:
Section titled “Parameters:”- col: Column - The column.
Returns number
getColumns
Section titled “getColumns”Get array of columns.
▸ getColumns(): Column[]
Returns Column[]
getConditionsText
Section titled “getConditionsText”Retruns conditions text
▸ getConditionsText(): string
Returns string
getDescription
Section titled “getDescription”Gets description of the query.
▸ getDescription(): string
Returns string
Gets query ID.
▸ getId(): string
Returns string
- The ID>
getModel
Section titled “getModel”Gets DataModel object associated with this query.
▸ getModel(): DataModel
Returns DataModel
getName
Section titled “getName”Gets name of the query.
▸ getName(): string
Returns string
getOneValueForAttr
Section titled “getOneValueForAttr”Gets one value for the attribute
▸ getOneValueForAttr(attrId: string
): string
Parameters:
Section titled “Parameters:”- attrId:
string
- The attribute ID.
Returns string
getRootCondition
Section titled “getRootCondition”Gets root predicate
▸ getRootCondition(): Condition
Returns Condition
getSortedColumns
Section titled “getSortedColumns”Gets array of columns used in sorting
▸ getSortedColumns(): Column[]
Returns Column[]
isEmptyColumns
Section titled “isEmptyColumns”Checks wether query does not contains any column.
▸ isEmptyColumns(): boolean
Returns boolean
isEmptyConditions
Section titled “isEmptyConditions”Checks wether query does not contains any condtion.
▸ isEmptyConditions(): boolean
Returns boolean
▸ isEx(): boolean
Returns boolean
isModified
Section titled “isModified”▸ isModified(): boolean
Returns boolean
loadFromData
Section titled “loadFromData”▸ loadFromData(data: QueryData,changeStatus?: boolean
): void
Parameters:
Section titled “Parameters:”- data: QueryData
- changeStatus:
boolean
, Default value =true
Returns void
loadFromDataOrJson
Section titled “loadFromDataOrJson”Sets data to the query.
▸ loadFromDataOrJson(data: QueryData | string
,changeStatus?: boolean
): void
Parameters:
Section titled “Parameters:”- data: QueryData |
string
- JSON representation object or JSON string - changeStatus:
boolean
, Default value =true
- Indicate whether we should change the “isModified” status (by default ==true
)
Returns void
loadFromJson
Section titled “loadFromJson”Loads query from JSON.
▸ loadFromJson(json: string
,changeStatus?: boolean
): void
Parameters:
Section titled “Parameters:”-
json:
string
- The JSON string. -
changeStatus:
boolean
, Default value =true
Returns void
loadModelData
Section titled “loadModelData”Loads data model.
▸ loadModelData(model: ModelPlainData | string
): void
Parameters:
Section titled “Parameters:”- model: ModelPlainData |
string
- JSON representation object or JSON string.
Returns void
moveColumn
Section titled “moveColumn”Moves the column with specified index to another position.
▸ moveColumn(index1: number
,index2: number
): void
Parameters:
Section titled “Parameters:”- index1:
number
- The index of the column that should be moved. - index2:
number
- The index of the position the column should be moved to
Returns void
regenerateId
Section titled “regenerateId”Regenerates current query ID.
▸ regenerateId(): void
Returns void
removeChangedCallback
Section titled “removeChangedCallback”Remove changed callback
▸ removeChangedCallback(callbackId: string
): void
Parameters:
Section titled “Parameters:”- callbackId:
string
- The callback ID.
Returns void
removeColumn
Section titled “removeColumn”Removes the column.
▸ removeColumn(column: Column,author: any
): void
Parameters:
Section titled “Parameters:”- column: Column - The column to be removed.
- author:
any
- The author
Returns void
removeColumns
Section titled “removeColumns”Removes several columns passed as array.
▸ removeColumns(columnsToRemove: Column[],author: any
): void
Parameters:
Section titled “Parameters:”- columnsToRemove: Column[] - The list of columns to be removed.
- author:
any
- The author.
Returns void
removeProcessCallback
Section titled “removeProcessCallback”Remove process callback
▸ removeProcessCallback(callbackId: string
): void
Parameters:
Section titled “Parameters:”- callbackId:
string
- The callback ID.
Returns void
▸ reset(silent?: boolean
): void
Parameters:
Section titled “Parameters:”- silent:
boolean
, Default value =true
Returns void
resetModified
Section titled “resetModified”▸ resetModified(): void
Returns void
runThroughConditions
Section titled “runThroughConditions”Runs through condition with this callback.
▸ runThroughConditions(processCondition: (cond: Condition) => void
): void
Parameters:
Section titled “Parameters:”- processCondition: (cond: Condition) =>
void
- The function to process condition.
Returns void
setDefaultName
Section titled “setDefaultName”▸ setDefaultName(): string
Returns string
setDescription
Section titled “setDescription”Sets description of the query
▸ setDescription(description: string
): void
Parameters:
Section titled “Parameters:”- description:
string
- New description.
Returns void
Sets query ID.
▸ setId(id: string
): void
Parameters:
Section titled “Parameters:”- id:
string
- New Query ID.
Returns void
setModel
Section titled “setModel”Sets DataModel object associated with this query.
▸ setModel(model: DataModel): void
Parameters:
Section titled “Parameters:”- model: DataModel - The data model.
Returns void
setName
Section titled “setName”Sets name of the query
▸ setName(name: string
): void
Parameters:
Section titled “Parameters:”- name:
string
- New name.
Returns void
toJSON
Section titled “toJSON”Returns JSON representation of this query.
▸ toJSON(): string
Returns string
toJSONData
Section titled “toJSONData”Returns JSON representation of this query.
▸ toJSONData(): QueryData
Returns QueryData
Protected Methods
Section titled “Protected Methods”createSimpleConditionObject
Section titled “createSimpleConditionObject”▸ createSimpleConditionObject(attr: EntityAttr,operator: Operator,inputValues: string
| Array
<string
>): Condition
Parameters:
Section titled “Parameters:”- attr: EntityAttr
- operator: Operator
- inputValues:
string
|Array
<string
>
Returns Condition