Class BaseBindCommandAbstract

An abstract class that defines a binding command. This class manages the execution of bind commands and related actions.

Hierarchy (view full)

Constructors

constructor

Properties

_guid _model _name _outputs _type bind cbBegin cbBind cbEnd cbOutput cbResult cbValid output outputOptions valid _NS _PARAM _UNION

Methods

_onExecute _onExecuted addColumn addColumnValue clone equal execute getObject getTypes instanceOf newOutput release removeOutput setColumn setObject

Constructors

constructor

Properties

_guid

_guid: string

Unique identifier of the object (GUID). Uniquely identifies the object.

_model

_model: BaseBindModel

_name

_name: string

The name of the element, which acts as a unique identifier for the MetaElement.

_outputs

_outputs: MetaViewCollection

Collection that stores output results.

_type

_type: Function

The generator function of the object. The function used when the object was created.

bind

bind: MetaView

Bind target MetaView object.

cbBegin

cbBegin: ((cmd: BaseBindCommand) => void)

The callback function that is called at the start of execution.

Type declaration

    • (cmd): void

    • Parameters

      Returns void

cbBind

cbBind: ((bind: MetaView, cmd: BaseBindCommand, setup: object) => void)

Callback function called before bind.

Type declaration

    • (bind, cmd, setup): void

    • Parameters

      • bind: MetaView

        object 'MetaView' to be transmitted.

      • cmd: BaseBindCommand

        current bind command object.

      • setup: object

        setting object.

      Returns void

cbEnd

cbEnd: ((status: object, cmd: BaseBindCommand, response: object) => void)

Callback function called after execution is complete.

Type declaration

    • (status, cmd, response): void

    • Parameters

      • status: object

        Status information.

      • cmd: BaseBindCommand

        current bind command object.

      • response: object

        response object.

      Returns void

cbOutput

cbOutput: ((views: MetaViewCollection, cmd: BaseBindCommand, response: object) => void)

A callback function that outputs binding results. It is mainly used for the output of lists.

Type declaration

    • (views, cmd, response): void

    • Parameters

      Returns void

cbResult

cbResult: ((data: object, cmd: BaseBindCommand, response: object) => object)

A callback function that handles binding results. It is mainly used for processing result data.

Type declaration

    • (data, cmd, response): object

    • Parameters

      • data: object

        Bind result data.

      • cmd: BaseBindCommand

        current bind command object.

      • response: object

        response object.

      Returns object

      Processed result data.

cbValid

cbValid: ((valid: MetaView, cmd: BaseBindCommand) => boolean)

Callback function called before valid.

Type declaration

    • (valid, cmd): boolean

    • Parameters

      Returns boolean

      A boolean value indicating the result of the examination.

output

output: MetaView

Dynamic added output MetaView object.

outputOptions

outputOptions: object

Output attribute options.

  • 0: Except
  • 1: Import rows of all columns
  • 2: Import only rows of existing columns
  • 3: Import only the row of existing curums, set value

valid

valid: MetaView

MetaView object to be examined.

Static Readonly_NS

_NS: string

Indicates the namespace.

Default

'Meta'

Static Readonly_PARAM

_PARAM: []

List of parameters used for the constructor.

Default

['name']

Static Readonly_UNION

_UNION: []

List of implemented interfaces.

Default

[IElement]

Methods

_onExecute

_onExecuted

addColumn

  • addColumn(column, views, bTable?): void

  • Adds a column and maps it to the specified view.

    Parameters

    • column: string | MetaColumn

      This column object is to be registered. It could be a string or 'MetaColumn' object.

    • views: string | string[]

      The name of the view entity to be added; it can be a string or an array of strings.

    • OptionalbTable: string | MetaTable

      (Optional) Default table object or table name to be mapped.

    Returns void

addColumnValue

  • addColumnValue(name, value, views?, bTable?): void

  • Add columns and values and map them to the specified view.

    Parameters

    • name: string

      The name of the column.

    • value: any

      column value.

    • Optionalviews: string | string[]

      (Optional) Name of the view entity to be added.

    • OptionalbTable: string | MetaTable

      (Optional) Default table object or table name to be mapped.

    Returns void

clone

  • clone(...args): this

  • Replicate the current object.

    Parameters

    • Rest...args: any[]

      Additional argument to be used for replication.

    Returns this

    Returns a replicated object.

equal

  • equal(target): boolean

  • Compare the current object with the specified object.

    Parameters

    • target: object

      the object to be compared to.

    Returns boolean

    Returns whether the two objects are the same.

Abstractexecute

getObject

  • getObject(vOpt?, owned?): object

  • Returns the current object as a serialized object. Serialization replaces cyclic references with values of '$ref', and depending on the serialization options, you can select reference structures, redundant structures, and non-contrast structures.

    Parameters

    • OptionalvOpt: number

      Serialization option. Default is '0'.

      • 0: Reference structure (_guid: Yes, $ref: Yes)
      • 1: Redundant structure (_guid: Yes, $ref: Yes)
      • 2: Non-tidal rescue (_guid: no, $ref: no)
    • Optionalowned: object | object[]

    Returns object

    serialized object.

    Example

    const serializedObj = element.getObject(2);
    console.log(serializedObj); // serialized object output

getTypes

  • getTypes(): Function[]

  • Returns the creators of the current object and all the creators of the prototype chain to the array.

    Returns Function[]

    Returns the array of generator functions.

    Example

    const types = obj.getTypes();
    console.log(types); // [Function: MetaObject]

instanceOf

  • instanceOf(target): boolean

  • Verify that the current object is an instance of the specified type (including _UNION)

    Parameters

    • target: string | object

      The type of object to be checked (object or string).

    Returns boolean

    Returns whether it is an instance of the specified type.

newOutput

  • newOutput(name?): void

  • Adds a view entity to use for the output. The default name is 'output' + _outputs.count.

    Parameters

    • Optionalname: string

      (Optional) The name of the view to be referenced additionally.

    Returns void

release

  • release(name, views): void

  • Release the column from the target entity.

    Parameters

    • name: string | string[]

      The column name or array of names to release.

    • views: string | string[]

      The name or array of view entities to be disabled.

    Returns void

removeOutput

  • removeOutput(name): boolean

  • Delete the output view.

    Parameters

    • name: string

      Name of the view to delete.

    Returns boolean

    A boolean value indicating successful deletion.

setColumn

  • setColumn(name, views): void

  • Set the column.

    Parameters

    • name: string | string[]

      column name or array of names.

    • views: string | string[]

      An array of view names or names to set.

    Returns void

    Example

    e.read.setColumn(['idx', 'addr'], 'valid');

setObject

  • setObject(oGuid, origin?): any

  • Initialize the current object using the serialized object. In this process, the object is initialized, and the state of the object is restored based on the serialized object (oGuid).

    Parameters

    • oGuid: object

      serialized object.

    • Optionalorigin: object

      Original object. Default is 'oGuid'.

    Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Methods