CallQueryComponent | @lcap/nasl

数据查询

Hierarchy

LogicItem
- CallQueryComponent

Index

Constructors

constructor

Accessors

Constructors

constructor

new CallQueryComponent(source?: Partial<CallQueryComponent>): CallQueryComponent

Overrides LogicItem.constructor
Parameters
- Optional source: Partial<CallQueryComponent>
  
  需要合并的部分参数
Returns CallQueryComponent

Properties

Readonly JSON_EXCLUDED_KEYS

JSON_EXCLUDED_KEYS: Set<string>

toJSON 时需要去除的键，为了避免出现 CircularJSON

_mutable

_mutable: boolean = true

可修改标志，内部属性标记在构造函数结束后是否可修改

branchName

branchName: string = undefined

分支名称

changedTime

changedTime: number = undefined

变动时间

concept

concept: "CallQueryComponent" = 'CallQueryComponent'

产品概念

dataTreeNodeHidden

dataTreeNodeHidden: boolean = false

数据树节点是否显示前端 UI 状态

description

description: string = undefined

逻辑项描述

editable

editable: boolean = undefined

是否正在编辑前端 UI 状态

editing

editing: boolean = false

是否正在编辑前端 UI 状态

expanded

expanded: boolean = false

节点是否为展开状态前端 UI 状态

folded

folded: boolean = true

是否展开

from

from: QueryFromExpression = undefined

from

groupBy

groupBy: QueryGroupByExpression[] = []

groupBy

having

having: LogicItem = undefined

having

hidden

hidden: boolean = false

节点是否显示前端 UI 状态

id

id: string = ...

唯一 Id

isLeaf

isLeaf: boolean = false

是否为叶子节点前端 UI 状态

kind

kind: string = 'Statement'

kind

label

label: string = undefined

逻辑项标题

limit

limit: QueryLimitExpression = undefined

limit

loading

loading: boolean = false

是否正在请求前端 UI 状态

logicTreeNodeExpanded

logicTreeNodeExpanded: boolean = false

数据树节点是否展开前端 UI 状态

logicTreeNodeHidden

logicTreeNodeHidden: boolean = false

逻辑树节点是否显示前端 UI 状态

offsetX

offsetX: number = undefined

offsetX

offsetY

offsetY: number = undefined

offsetY

orderBy

orderBy: QueryOrderByExpression[] = []

orderBy

pageTreeNodeHidden

pageTreeNodeHidden: boolean = false

页面树节点是否显示前端 UI 状态

parentNode

parentNode: BaseNode = null

父节点

removable

removable: boolean = undefined

是否可以删除前端 UI 状态

select

select: QuerySelectExpression = undefined

select

sourceMap

sourceMap: SourceMap = undefined

用于挂 embeddedTS 的 sourceMap

tsErrorDetail

tsErrorDetail: Diagnostic = undefined

当前节点上报错详细信息

typeAnnotation

typeAnnotation: TypeAnnotation = undefined

类型

where

where: LogicItem = undefined

where

Accessors

app

get app(): App

Inherited from LogicItem.app

祖先 App

Returns App

logic

get logic(): Logic

Inherited from LogicItem.logic

祖先 Logic

Returns Logic

module

get module(): Module

Inherited from LogicItem.module

祖先 Module

Returns Module

process

get process(): Process

Inherited from LogicItem.process

祖先 Process

Returns Process

processElement

get processElement(): ProcessElement

Inherited from LogicItem.processElement

祖先 ProcessElement

Returns ProcessElement

rootNode

get rootNode(): BaseNode

Inherited from LogicItem.rootNode

根节点

Returns BaseNode

upperNode

get upperNode(): BaseNode

Inherited from LogicItem.upperNode

上层节点

Returns BaseNode

view

get view(): View

Inherited from LogicItem.view

祖先 View

Returns View

Methods

activeInside

activeInside(source: any, Ctor: any, parentNode: any, parentKey: string): any

Inherited from LogicItem.activeInside

激活 JSON 内部实例

Parameters
- source: any
- Ctor: any
- parentNode: any
- parentKey: string
Returns any

addParamsPrepare

addParamsPrepare(): Promise<any>

Inherited from LogicItem.addParamsPrepare

添加参数准备

Returns Promise<any>

addQueryGroupByExpressionInGroupBy

addQueryGroupByExpressionInGroupBy(queryGroupByExpressionOptions: Partial<QueryGroupByExpression>): QueryGroupByExpression
addQueryGroupByExpressionInGroupBy(queryGroupByExpression: QueryGroupByExpression): QueryGroupByExpression

添加查询分组

Parameters
- queryGroupByExpressionOptions: Partial<QueryGroupByExpression>
  
  查询分组参数
Returns QueryGroupByExpression
添加查询分组

Parameters
- queryGroupByExpression: QueryGroupByExpression
  
  已有的查询分组实例
Returns QueryGroupByExpression

addQueryOrderByExpressionInOrderBy

addQueryOrderByExpressionInOrderBy(queryOrderByExpressionOptions: Partial<QueryOrderByExpression>): QueryOrderByExpression
addQueryOrderByExpressionInOrderBy(queryOrderByExpression: QueryOrderByExpression): QueryOrderByExpression

添加查询排序子句

Parameters
- queryOrderByExpressionOptions: Partial<QueryOrderByExpression>
  
  查询排序子句参数
Returns QueryOrderByExpression
添加查询排序子句

Parameters
- queryOrderByExpression: QueryOrderByExpression
  
  已有的查询排序子句实例
Returns QueryOrderByExpression

changeName

changeName(newValue: string): Promise<any>

Inherited from LogicItem.changeName

重命名

Parameters
- newValue: string
Returns Promise<any>

create

create(parentParams: Params): void

Inherited from LogicItem.create

创建节点

Parameters
- parentParams: Params
Returns void

deepPick

deepPick(source: any, keys?: string[]): void

Inherited from LogicItem.deepPick
从对象中深度获取
example
比如一般后端返回只是添加了个 id
```
this.deepPick(result, ['id'])
```
Parameters
- source: any
- keys: string[] = []
Returns void

delete

delete(): void

Overrides LogicItem.delete

删除节点

Returns void

destroy

destroy(): void

Inherited from LogicItem.destroy

销毁从 Map 中删除点和子节点

Returns void

emit

emit(eventName: string, event?: EventPayload, target?: any): void

Inherited from LogicItem.emit

触发事件

Parameters
- eventName: string
  
  事件名
- Optional event: EventPayload
- Optional target: any
Returns void

findUsage

findUsage(): Promise<any>

Inherited from LogicItem.findUsage

查找引用

Returns Promise<any>

genActionListener

genActionListener(action: string): (($event: EventPayload) => void)

Inherited from LogicItem.genActionListener

为存储点生成行为监听器

Parameters
- action: string
Returns (($event: EventPayload) => void)
- - ($event: EventPayload): void
  - Parameters
    - $event: EventPayload
    Returns void

genSources

genSources(instance: BaseNode, filerFn?: ((source: Partial<BaseNode>) => {})): {}

Inherited from LogicItem.genSources

生成json

Parameters
- instance: BaseNode
- Optional filerFn: ((source: Partial<BaseNode>) => {})
  - - (source: Partial<BaseNode>): {}
    - Parameters
      - source: Partial<BaseNode>
      Returns {}
Returns {}

getAncestor

getAncestor(concept: string): BaseNode

Inherited from LogicItem.getAncestor

获取祖先节点

Parameters
- concept: string
Returns BaseNode

insertQueryGroupByExpressionInGroupByAt

insertQueryGroupByExpressionInGroupByAt(name: string, index: number): QueryGroupByExpression
insertQueryGroupByExpressionInGroupByAt(queryGroupByExpressionOptions: Partial<QueryGroupByExpression>, index: number): QueryGroupByExpression
insertQueryGroupByExpressionInGroupByAt(queryGroupByExpression: QueryGroupByExpression, index: number): QueryGroupByExpression

插入查询分组

Parameters
- name: string
  
  查询分组名称，如果不填会自动生成一个唯一名称
- index: number
Returns QueryGroupByExpression
插入查询分组

Parameters
- queryGroupByExpressionOptions: Partial<QueryGroupByExpression>
  
  查询分组参数
- index: number
Returns QueryGroupByExpression
插入查询分组

Parameters
- queryGroupByExpression: QueryGroupByExpression
  
  已有的查询分组实例
- index: number
Returns QueryGroupByExpression

insertQueryOrderByExpressionInOrderByAt

insertQueryOrderByExpressionInOrderByAt(queryOrderByExpressionOptions: Partial<QueryOrderByExpression>, index: number): QueryOrderByExpression
insertQueryOrderByExpressionInOrderByAt(queryOrderByExpression: QueryOrderByExpression, index: number): QueryOrderByExpression

插入查询排序子句

Parameters
- queryOrderByExpressionOptions: Partial<QueryOrderByExpression>
  
  查询排序子句参数
- index: number
Returns QueryOrderByExpression
插入查询排序子句

Parameters
- queryOrderByExpression: QueryOrderByExpression
  
  已有的查询排序子句实例
- index: number
Returns QueryOrderByExpression

instantiate

instantiate(source: any, parentNode: BaseNode, parentKey: string): any

Inherited from LogicItem.instantiate

实例化一个 JSON 由于有 from，只能先实例化父级，再实例化子级

Parameters
- source: any
- parentNode: BaseNode
- parentKey: string
Returns any

off

off(eventName: string, listener: EventListener): void

Inherited from LogicItem.off

取消监听事件

Parameters
- eventName: string
  
  事件名
- listener: EventListener
  
  监听器
Returns void

on

on(eventName: string, listener: EventListener): void

Inherited from LogicItem.on

监听事件

Parameters
- eventName: string
  
  事件名
- listener: EventListener
  
  监听器
Returns void

once

once(eventName: string, listener: EventListener): void

Inherited from LogicItem.once

只监听一次事件

Parameters
- eventName: string
  
  事件名
- listener: EventListener
  
  监听器
Returns void

prepareDelete

prepareDelete(): Promise<any>

Inherited from LogicItem.prepareDelete

准备删除

Returns Promise<any>

removeFrom

removeFrom(name: string): void
removeFrom(from: QueryFromExpression): void

删除查询 From 子句

Parameters
- name: string
  
  查询 From 子句名称
Returns void
删除查询 From 子句

Parameters
- from: QueryFromExpression
  
  已有的查询 From 子句实例
Returns void

removeHaving

removeHaving(name: string): void
removeHaving(having: LogicItem): void

删除逻辑项

Parameters
- name: string
  
  逻辑项名称
Returns void
删除逻辑项

Parameters
- having: LogicItem
  
  已有的逻辑项实例
Returns void

removeLimit

removeLimit(name: string): void
removeLimit(limit: QueryLimitExpression): void

删除查询分页子句

Parameters
- name: string
  
  查询分页子句名称
Returns void
删除查询分页子句

Parameters
- limit: QueryLimitExpression
  
  已有的查询分页子句实例
Returns void

removeQueryGroupByExpressionInGroupBy

removeQueryGroupByExpressionInGroupBy(name: string): void
removeQueryGroupByExpressionInGroupBy(queryGroupByExpression: QueryGroupByExpression): void

删除查询分组

Parameters
- name: string
  
  查询分组名称
Returns void
删除查询分组

Parameters
- queryGroupByExpression: QueryGroupByExpression
  
  已有的查询分组实例
Returns void

removeQueryOrderByExpressionInOrderBy

removeQueryOrderByExpressionInOrderBy(queryOrderByExpression: QueryOrderByExpression): void

删除查询排序子句

Parameters
- queryOrderByExpression: QueryOrderByExpression
  
  已有的查询排序子句实例
Returns void

removeSelect

removeSelect(name: string): void
removeSelect(select: QuerySelectExpression): void

删除查询选择子句

Parameters
- name: string
  
  查询选择子句名称
Returns void
删除查询选择子句

Parameters
- select: QuerySelectExpression
  
  已有的查询选择子句实例
Returns void

removeTypeAnnotation

removeTypeAnnotation(name: string): void
removeTypeAnnotation(typeAnnotation: TypeAnnotation): void

删除类型标注

Parameters
- name: string
  
  类型标注名称
Returns void
删除类型标注

Parameters
- typeAnnotation: TypeAnnotation
  
  已有的类型标注实例
Returns void

removeWhere

removeWhere(name: string): void
removeWhere(where: LogicItem): void

删除逻辑项

Parameters
- name: string
  
  逻辑项名称
Returns void
删除逻辑项

Parameters
- where: LogicItem
  
  已有的逻辑项实例
Returns void

setDescription

setDescription(description: string): void

Inherited from LogicItem.setDescription

设置逻辑项描述

Parameters
- description: string
Returns void

setFolded

setFolded(folded: boolean): void

Inherited from LogicItem.setFolded

设置是否展开

Parameters
- folded: boolean
Returns void

setFrom

setFrom(from: QueryFromExpression): void

设置from

Parameters
- from: QueryFromExpression
Returns void

setGroupBy

setGroupBy(groupBy: QueryGroupByExpression[]): void

设置groupBy

Parameters
- groupBy: QueryGroupByExpression[]
Returns void

setHaving

setHaving(having: LogicItem): void

设置having

Parameters
- having: LogicItem
Returns void

setLabel

setLabel(label: string): void

Inherited from LogicItem.setLabel

设置逻辑项标题

Parameters
- label: string
Returns void

setLimit

setLimit(limit: QueryLimitExpression): void

设置limit

Parameters
- limit: QueryLimitExpression
Returns void

setOrderBy

setOrderBy(orderBy: QueryOrderByExpression[]): void

设置orderBy

Parameters
- orderBy: QueryOrderByExpression[]
Returns void

setPosition

setPosition(offsetX: number, offsetY: number): Promise<void>

Inherited from LogicItem.setPosition

设置逻辑节点位置

Parameters
- offsetX: number
- offsetY: number
Returns Promise<void>

setSelect

setSelect(select: QuerySelectExpression): void

设置select

Parameters
- select: QuerySelectExpression
Returns void

setWhere

setWhere(where: LogicItem): void

设置where

Parameters
- where: LogicItem
Returns void

toEmbeddedTS

toEmbeddedTS(state?: TranslatorState): string

Overrides LogicItem.toEmbeddedTS

生成 TS 宿主语言代码

Parameters
- Optional state: TranslatorState
Returns string
生成的代码

toJS

toJS(state?: TranslatorState): string

Inherited from LogicItem.toJS

生成 JS 代码

Parameters
- Optional state: TranslatorState
  
  编译状态
Returns string
生成的代码

toJSON

toJSON(): {}

Inherited from LogicItem.toJSON

去除循环依赖，转为纯 JSON

Returns {}

toPlainJSON

toPlainJSON(parentKey?: string, excludedKeys?: string[]): any

Inherited from LogicItem.toPlainJSON

转为单层的 JSON

Parameters
- Optional parentKey: string
  
  外面的 key，提供给 JSON.stringify 使用
- excludedKeys: string[] = []
  
  需要额外排除的 keys
Returns any

toSummary

toSummary(): string

Inherited from LogicItem.toSummary

生成概要信息

Returns string

toTS

toTS(state?: TranslatorState): string

Inherited from LogicItem.toTS

生成 TS 代码

Parameters
- Optional state: TranslatorState
  
  编译状态
Returns string
生成的代码

update

update(__namedParameters: any): void

Inherited from LogicItem.update

更新节点

Parameters
- __namedParameters: any
Returns void

Static getDefaultOptions

getDefaultOptions(): any

Overrides LogicItem.getDefaultOptions

获取添加时的默认选项

Returns any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional source: Partial<CallQueryComponent>

Returns CallQueryComponent

Properties

Readonly JSON_EXCLUDED_KEYS

_mutable

branchName

changedTime

concept

dataTreeNodeHidden

description

editable

editing

expanded

folded

from

groupBy

having

hidden

id

isLeaf

kind

label

limit

loading

logicTreeNodeExpanded

logicTreeNodeHidden

offsetX

offsetY

orderBy

pageTreeNodeHidden

parentNode

removable

select

sourceMap

tsErrorDetail

typeAnnotation

where

Accessors

app

Returns App

logic

Returns Logic

module

Returns Module

process

Returns Process

processElement

Returns ProcessElement

rootNode

Returns BaseNode

upperNode

Returns BaseNode

view

Returns View

Methods

activeInside

Parameters

source: any

Ctor: any

parentNode: any

parentKey: string

Returns any

addParamsPrepare

Returns Promise<any>

addQueryGroupByExpressionInGroupBy

Parameters

queryGroupByExpressionOptions: Partial<QueryGroupByExpression>

Returns QueryGroupByExpression

Parameters

queryGroupByExpression: QueryGroupByExpression

Returns QueryGroupByExpression