@easyquery/core 7.2.3 → 7.2.4-rc01

package/dist/lib/dm/data_model.d.ts

@@ -1,330 +1,330 @@
-import { DataType, MetaData, ValueEditor } from '@easydata/core';
-import { AggrFunction } from './aggr_function';
-import { Operator, Operand } from './operator';
-import { Entity, EntityAttr } from './entity';
-import { EqValueEditor } from './value_editor';
-import { Link } from './link';
-import { DataKind } from '../types/data_kind';
-import { Query } from '../query/query';
-import { ModelPlainData } from './dto/dm_data';
-import { Tree } from '../common/tree';
-/**
- * Operator descriptor.
- */
-export interface OperatorDescriptor {
-    id: string;
-    expr?: string;
-    format: string;
-    caption: string;
-    paramCount?: number;
-    kind?: DataKind;
-    appliedTypes?: DataType[];
-}
-/**
- * Represents a data model
- */
-export declare class DataModel extends MetaData {
-    /**The list of operators. */
-    operators: Operator[];
-    /** The root entity. */
-    rootEntity: Entity;
-    /** The list of aggregate functions. */
-    aggrFunctions: AggrFunction[];
-    /** The list of value editors. */
-    editors: EqValueEditor[];
-    /** The list of links. It is used in odata broker. */
-    links: Link[];
-    private dateMacros;
-    private timeMacros;
-    protected mainEntity: Entity | null;
-    readonly nullAttribute: EntityAttr;
-    readonly nullOperator: Operator;
-    /** The default constructor. */
-    constructor();
-    /**
-     * Gets the main entity of model
-     * @return The main entity.
-     */
-    getMainEntity(): Entity;
-    /**
-     * Loads data model from JSON.
-     * @param stringJson The JSON string.
-     */
-    loadFromJSON(stringJson: string): void;
-    /**
-     * Loads data model from its JSON representation object.
-     * @param data The JSON representation object.
-     */
-    loadFromData(data: ModelPlainData): void;
-    /**
-     * Gets the data model object.
-     * @returns Tha data model.
-     */
-    getObject(): DataModel;
-    /**
-     * Sets data to data model.
-     * @param model Its JSON representation object or JSON string.
-     */
-    setData(model: ModelPlainData | string): void;
-    /**
-     * Creates entity.
-     * @param parent The parent entity.
-     * @returns The Entity.
-     */
-    createEntity(parent?: Entity): Entity;
-    /**
-     * Creates entity attribute.
-     * @param parent The parent entity.
-     * @returns The entity attribute.
-     */
-    createEntityAttr(parent?: Entity): EntityAttr;
-    /**
-     * Creates new EqValueEditor
-     * @returns An instance of EqValueEditor class
-     */
-    createValueEditor(): ValueEditor;
-    /**
-     * Creates query.
-     * @returns The Query.
-     */
-    createQuery(): Query;
-    /**
-     * Gets root entity of the data model.
-     * @returns The root entity.
-     */
-    getRootEntity(): Entity;
-    /**
-     * Finds editor by its ID.
-     * @param editorId The editor ID.
-     * @returns The value editor or `null`.
-     */
-    getEditorById(editorId: string): EqValueEditor | null;
-    /**
-     * Gets entity attribute by its ID.
-     * This function runs through all attributes inside specified model (it's root entity and all its sub-entities).
-     * @param attrId The attribute ID.
-     * @returns The attribute or `null`.
-     */
-    getAttributeById(attrId: string): EntityAttr | null;
-    /**
-    * Gets entity attribute by its ID.
-    * This function runs through all attributes inside specified model (it's root entity and all its sub-entities).
-    * @param attrId The attribute ID.
-    * @returns The attribute or `nullAttribute`.
-    */
-    getAttributeByIdSafe(attrId: any): EntityAttr;
-    /**
-     * Checks wether attribute contains such property.
-     * @param attrId The attribute ID.
-     * @param propName The property name.
-     * @returns `true` if the attribute contains the property, otherwise `false`.
-     */
-    checkAttrProperty(attrId: string, propName: string): boolean;
-    /**
-     * Gets entity attribute by its ID.
-     * This function runs through all attributes inside specified entity and all its sub-entities.
-     * @param entity
-     * @param attrId
-     * @returns The attribute or `null`.
-     */
-    getEntityAttrById(entity: Entity, attrId: string): EntityAttr | null;
-    private _listByEntityWithFilter;
-    private _listByEntity;
-    /**
-     * Clears data model.
-     */
-    clear(): void;
-    /**
-     * Add or update an operator.
-     * @param desc The operator descriptor.
-     * @returns The operator.
-     */
-    addOrUpdateOperator(desc: OperatorDescriptor): Operator;
-    /**
-     * Removes an operator.
-     * @param id The id.
-     * @param soft If `false` - removes operators from model and attributes. Otherwise only
-     * from attributes.
-     */
-    removeOperator(id: string, soft?: boolean): void;
-    /**
-     * Get operators for data type.
-     * @param type The data type
-     * @return The array of operator ids.
-     */
-    getOperatorIdsByDataType(type: DataType): string[];
-    /**
-     * Builds entities tree used in query.
-     * @param query The query.
-     */
-    buildQueryPath(query: Query): Tree<Entity>;
-    private createTreeNodeFromEntity;
-    /**
-     * Get Entities used in query.
-     * @param query The query.
-     */
-    getEntitiesInQuery(query: Query): Entity[];
-    findAggrFunctionById(funcId: string): AggrFunction | null;
-    private fillEntitiesByCondtionGroup;
-    private addEntityByExpression;
-    /**
-     * Finds link between two entities.
-     * @param entityFrom The entity `from`.
-     * @param entityTo The entity `to`.
-     * @return The link.
-     */
-    findLink(entityFrom: Entity, entityTo: Entity): Link | null;
-    /**
-     * Get links with the entity.
-     * @param entity The entity.
-     * @return The link.
-     */
-    getLinksByEntity(entity: Entity): Link[];
-    /**
-     * Gets entities tree.
-     * @param opts The options.
-     * @param filterFunc The filter function.
-     * Takes two parameters, Entity and EntityAttr (second parameter will be null for entities), and returns boolean (true if the corresponding entity or attribute).
-     * @returns The tree of the entities and their attributes according to options and the filter function
-     */
-    getEntitiesTree(opts: any, filterFunc?: (ent: Entity, attr: EntityAttr) => boolean): any;
-    /**
-     * Gets entities tree due to filter.
-     * @param filterFunc The filter function.
-     * Takes two parameters, Entity and EntityAttr (second parameter will be null for entities), and returns boolean (true if the corresponding entity or attribute).
-     * @returns The tree of the entities and their attributes according to the filter function
-     */
-    getEntitiesTreeWithFilter(filterFunc: any): Entity[];
-    /**
-     * Finds full entity path by attribute
-     * @param attrId The attribute id.
-     * @param sep The separator.
-     * @returns The path.
-     */
-    getFullEntityPathByAttr(attrId: string, sep: string): string;
-    /**
-    * Finds entity path by attribute
-    * @param entity The entity.
-    * @param attrId The attribute id.
-    * @param sep The separator.
-    * @param root The root option.
-    * @returns The path.
-    */
-    getEntityPathByAttr(entity: Entity, attrId: string, sep: string, root: boolean): string;
-    /**
-     * Gets the attribute text.
-     * @param attr The attribute.
-     * @param format The format.
-     * @returns Formatted text.
-     */
-    getAttributeText(attr: EntityAttr, format: string): string;
-    getFirstUICAttr(): EntityAttr;
-    /**
-     * Gets first `UIC` attribute in specified entity
-     * (`UIC` stands for `use in conditions` - so such attribute can be used in conditions)
-     * @param entity Entity object to search our attribute in.
-     * @returns The entity attribute or `null`
-     */
-    private getFirstUICAttrInEntity;
-    /**
-     * Scans model's entity tree and calls the callback functions for each attribute and entity.
-     * @param processAttribute The callback function which is called for each attribute in model's entity tree.
-     * The processed attribute is passed in the first function parameter.
-     * @param processEntity The callback function which is called for each entity in tree.
-     * The processed entity is passed in the first function parameter.
-     */
-    runThroughEntities(processAttribute?: (attr: EntityAttr, opts: any) => void, processEntity?: (entity: Entity, opts: any) => void): void;
-    /**
-     * Finds first attribute by filter.
-     * @param filterFunc The filter function. Takes EntityAttr object in parameter and returns boolean
-     */
-    getFirstAttributeByFilter(filterFunc: (attr: EntityAttr) => boolean): EntityAttr;
-    /**
-     * Finds operator in model by its ID.
-     * This function runs through all operators inside specified model and returns the one with specified ID.
-     * @param operatorId An operator ID.
-     * @returns The operator or `null`.
-     */
-    findOperatorById(operatorId: string): Operator | null;
-    /**
-     * Finds operator in model by its ID.
-     * his function runs through all operators inside specified model and returns the one with specified ID.
-     * @param operatorId Operator ID.
-     * @returns The operator or special `NullOperator` object if operator is not found.
-     */
-    getOperatorById(operatorId: string): Operator;
-    getDefaultOperatorIdForAttr(attr: EntityAttr): string;
-    /**
-     * Gets caption of the aggregate function.
-     * @param funcId The function id.
-     * @returns The caption.
-     */
-    getAggrFunctionCaption(funcId: string): string;
-    /**
-     * Gets format of the aggregate function.
-     * @param funcId The function id.
-     * @returns The caption.
-     */
-    getAggrFunctionFormat(funcId: string): string;
-    /**
-     * Gets default operator for an attribute.
-     * @param attr The attribute.
-     * @returns The operator.
-     */
-    getDefaultOperatorForAttr(attr: EntityAttr): Operator;
-    /**
-     * Gets operand.
-     * @param attr The attribute.
-     * @param operator The operator.
-     * @param index The index.
-     * @returns The operand.
-     */
-    getOperand(attr: EntityAttr, operator: Operator, index: number): Operand;
-    /**
-     * Gets the list of aggegate functions.
-     * @returns AN array of aggregate functions.
-     */
-    getAggrFunctions(): AggrFunction[];
-    /**
-     * Checks wether macro value is date.
-     * @param macroExpr The macro value.
-     * @retruns `true` if the macro value is date, otherwise `false`.
-     */
-    isDateMacro(macroExpr: string, macroProcessor?: (macroId: any) => void): boolean;
-    /**
-     * Checks whether the expression passed in the parameter is an time macro.
-     * @param macroExpr The macro expression
-     * @retruns `true` if the expression is a time macro (like Now), otherwise `false`.
-     */
-    isTimeMacro(macroExpr: string, macroProcessor?: (macroId: any) => void): boolean;
-    /**
-     * Gets date by its macro value.
-     * @param macroExpr The macro value.
-     * @returns The date or `null`
-     */
-    getDateMacroValue(macroExpr: string): Date | null;
-    /**
-    * Gets the date value by a macro expression of the expression itself.
-    * @param macroExpr The macro value.
-    * @returns The date or macro valu.
-    */
-    getDateOrMacroValue(macroExpr: string): string | Date;
-    /**
-    * Gets time by its macro value.
-    * @param macroExpr The macro value.
-    * @returns The date or `null`.
-    */
-    getTimeMacroValue(macroExpr: string): Date | null;
-    /**
-     * Gets time or macro by macro value.
-     * @param macroValue The macro value.
-     * @returns The time or macro valu.
-     */
-    getTimeOrMacroValue(time: string): string | Date;
-    getAllDateMacros(): string[];
-    /**
-     * Gets all time marcos.
-     * @returns The array of marcos
-     */
-    getAllTimeMacros(): string[];
-}
+import { DataType, MetaData, ValueEditor } from '@easydata/core';
+import { AggrFunction } from './aggr_function';
+import { Operator, Operand } from './operator';
+import { Entity, EntityAttr } from './entity';
+import { EqValueEditor } from './value_editor';
+import { Link } from './link';
+import { DataKind } from '../types/data_kind';
+import { Query } from '../query/query';
+import { ModelPlainData } from './dto/dm_data';
+import { Tree } from '../common/tree';
+/**
+ * Operator descriptor.
+ */
+export interface OperatorDescriptor {
+    id: string;
+    expr?: string;
+    format: string;
+    caption: string;
+    paramCount?: number;
+    kind?: DataKind;
+    appliedTypes?: DataType[];
+}
+/**
+ * Represents a data model
+ */
+export declare class DataModel extends MetaData {
+    /**The list of operators. */
+    operators: Operator[];
+    /** The root entity. */
+    rootEntity: Entity;
+    /** The list of aggregate functions. */
+    aggrFunctions: AggrFunction[];
+    /** The list of value editors. */
+    editors: EqValueEditor[];
+    /** The list of links. It is used in odata broker. */
+    links: Link[];
+    private dateMacros;
+    private timeMacros;
+    protected mainEntity: Entity | null;
+    readonly nullAttribute: EntityAttr;
+    readonly nullOperator: Operator;
+    /** The default constructor. */
+    constructor();
+    /**
+     * Gets the main entity of model
+     * @return The main entity.
+     */
+    getMainEntity(): Entity;
+    /**
+     * Loads data model from JSON.
+     * @param stringJson The JSON string.
+     */
+    loadFromJSON(stringJson: string): void;
+    /**
+     * Loads data model from its JSON representation object.
+     * @param data The JSON representation object.
+     */
+    loadFromData(data: ModelPlainData): void;
+    /**
+     * Gets the data model object.
+     * @returns Tha data model.
+     */
+    getObject(): DataModel;
+    /**
+     * Sets data to data model.
+     * @param model Its JSON representation object or JSON string.
+     */
+    setData(model: ModelPlainData | string): void;
+    /**
+     * Creates entity.
+     * @param parent The parent entity.
+     * @returns The Entity.
+     */
+    createEntity(parent?: Entity): Entity;
+    /**
+     * Creates entity attribute.
+     * @param parent The parent entity.
+     * @returns The entity attribute.
+     */
+    createEntityAttr(parent?: Entity): EntityAttr;
+    /**
+     * Creates new EqValueEditor
+     * @returns An instance of EqValueEditor class
+     */
+    createValueEditor(): ValueEditor;
+    /**
+     * Creates query.
+     * @returns The Query.
+     */
+    createQuery(): Query;
+    /**
+     * Gets root entity of the data model.
+     * @returns The root entity.
+     */
+    getRootEntity(): Entity;
+    /**
+     * Finds editor by its ID.
+     * @param editorId The editor ID.
+     * @returns The value editor or `null`.
+     */
+    getEditorById(editorId: string): EqValueEditor | null;
+    /**
+     * Gets entity attribute by its ID.
+     * This function runs through all attributes inside specified model (it's root entity and all its sub-entities).
+     * @param attrId The attribute ID.
+     * @returns The attribute or `null`.
+     */
+    getAttributeById(attrId: string): EntityAttr | null;
+    /**
+    * Gets entity attribute by its ID.
+    * This function runs through all attributes inside specified model (it's root entity and all its sub-entities).
+    * @param attrId The attribute ID.
+    * @returns The attribute or `nullAttribute`.
+    */
+    getAttributeByIdSafe(attrId: any): EntityAttr;
+    /**
+     * Checks wether attribute contains such property.
+     * @param attrId The attribute ID.
+     * @param propName The property name.
+     * @returns `true` if the attribute contains the property, otherwise `false`.
+     */
+    checkAttrProperty(attrId: string, propName: string): boolean;
+    /**
+     * Gets entity attribute by its ID.
+     * This function runs through all attributes inside specified entity and all its sub-entities.
+     * @param entity
+     * @param attrId
+     * @returns The attribute or `null`.
+     */
+    getEntityAttrById(entity: Entity, attrId: string): EntityAttr | null;
+    private _listByEntityWithFilter;
+    private _listByEntity;
+    /**
+     * Clears data model.
+     */
+    clear(): void;
+    /**
+     * Add or update an operator.
+     * @param desc The operator descriptor.
+     * @returns The operator.
+     */
+    addOrUpdateOperator(desc: OperatorDescriptor): Operator;
+    /**
+     * Removes an operator.
+     * @param id The id.
+     * @param soft If `false` - removes operators from model and attributes. Otherwise only
+     * from attributes.
+     */
+    removeOperator(id: string, soft?: boolean): void;
+    /**
+     * Get operators for data type.
+     * @param type The data type
+     * @return The array of operator ids.
+     */
+    getOperatorIdsByDataType(type: DataType): string[];
+    /**
+     * Builds entities tree used in query.
+     * @param query The query.
+     */
+    buildQueryPath(query: Query): Tree<Entity>;
+    private createTreeNodeFromEntity;
+    /**
+     * Get Entities used in query.
+     * @param query The query.
+     */
+    getEntitiesInQuery(query: Query): Entity[];
+    findAggrFunctionById(funcId: string): AggrFunction | null;
+    private fillEntitiesByCondtionGroup;
+    private addEntityByExpression;
+    /**
+     * Finds link between two entities.
+     * @param entityFrom The entity `from`.
+     * @param entityTo The entity `to`.
+     * @return The link.
+     */
+    findLink(entityFrom: Entity, entityTo: Entity): Link | null;
+    /**
+     * Get links with the entity.
+     * @param entity The entity.
+     * @return The link.
+     */
+    getLinksByEntity(entity: Entity): Link[];
+    /**
+     * Gets entities tree.
+     * @param opts The options.
+     * @param filterFunc The filter function.
+     * Takes two parameters, Entity and EntityAttr (second parameter will be null for entities), and returns boolean (true if the corresponding entity or attribute).
+     * @returns The tree of the entities and their attributes according to options and the filter function
+     */
+    getEntitiesTree(opts: any, filterFunc?: (ent: Entity, attr: EntityAttr) => boolean): any;
+    /**
+     * Gets entities tree due to filter.
+     * @param filterFunc The filter function.
+     * Takes two parameters, Entity and EntityAttr (second parameter will be null for entities), and returns boolean (true if the corresponding entity or attribute).
+     * @returns The tree of the entities and their attributes according to the filter function
+     */
+    getEntitiesTreeWithFilter(filterFunc: any): Entity[];
+    /**
+     * Finds full entity path by attribute
+     * @param attrId The attribute id.
+     * @param sep The separator.
+     * @returns The path.
+     */
+    getFullEntityPathByAttr(attrId: string, sep: string): string;
+    /**
+    * Finds entity path by attribute
+    * @param entity The entity.
+    * @param attrId The attribute id.
+    * @param sep The separator.
+    * @param root The root option.
+    * @returns The path.
+    */
+    getEntityPathByAttr(entity: Entity, attrId: string, sep: string, root: boolean): string;
+    /**
+     * Gets the attribute text.
+     * @param attr The attribute.
+     * @param format The format.
+     * @returns Formatted text.
+     */
+    getAttributeText(attr: EntityAttr, format: string): string;
+    getFirstUICAttr(): EntityAttr;
+    /**
+     * Gets first `UIC` attribute in specified entity
+     * (`UIC` stands for `use in conditions` - so such attribute can be used in conditions)
+     * @param entity Entity object to search our attribute in.
+     * @returns The entity attribute or `null`
+     */
+    private getFirstUICAttrInEntity;
+    /**
+     * Scans model's entity tree and calls the callback functions for each attribute and entity.
+     * @param processAttribute The callback function which is called for each attribute in model's entity tree.
+     * The processed attribute is passed in the first function parameter.
+     * @param processEntity The callback function which is called for each entity in tree.
+     * The processed entity is passed in the first function parameter.
+     */
+    runThroughEntities(processAttribute?: (attr: EntityAttr, opts: any) => void, processEntity?: (entity: Entity, opts: any) => void): void;
+    /**
+     * Finds first attribute by filter.
+     * @param filterFunc The filter function. Takes EntityAttr object in parameter and returns boolean
+     */
+    getFirstAttributeByFilter(filterFunc: (attr: EntityAttr) => boolean): EntityAttr;
+    /**
+     * Finds operator in model by its ID.
+     * This function runs through all operators inside specified model and returns the one with specified ID.
+     * @param operatorId An operator ID.
+     * @returns The operator or `null`.
+     */
+    findOperatorById(operatorId: string): Operator | null;
+    /**
+     * Finds operator in model by its ID.
+     * his function runs through all operators inside specified model and returns the one with specified ID.
+     * @param operatorId Operator ID.
+     * @returns The operator or special `NullOperator` object if operator is not found.
+     */
+    getOperatorById(operatorId: string): Operator;
+    getDefaultOperatorIdForAttr(attr: EntityAttr): string;
+    /**
+     * Gets caption of the aggregate function.
+     * @param funcId The function id.
+     * @returns The caption.
+     */
+    getAggrFunctionCaption(funcId: string): string;
+    /**
+     * Gets format of the aggregate function.
+     * @param funcId The function id.
+     * @returns The caption.
+     */
+    getAggrFunctionFormat(funcId: string): string;
+    /**
+     * Gets default operator for an attribute.
+     * @param attr The attribute.
+     * @returns The operator.
+     */
+    getDefaultOperatorForAttr(attr: EntityAttr): Operator;
+    /**
+     * Gets operand.
+     * @param attr The attribute.
+     * @param operator The operator.
+     * @param index The index.
+     * @returns The operand.
+     */
+    getOperand(attr: EntityAttr, operator: Operator, index: number): Operand;
+    /**
+     * Gets the list of aggegate functions.
+     * @returns AN array of aggregate functions.
+     */
+    getAggrFunctions(): AggrFunction[];
+    /**
+     * Checks wether macro value is date.
+     * @param macroExpr The macro value.
+     * @retruns `true` if the macro value is date, otherwise `false`.
+     */
+    isDateMacro(macroExpr: string, macroProcessor?: (macroId: any) => void): boolean;
+    /**
+     * Checks whether the expression passed in the parameter is an time macro.
+     * @param macroExpr The macro expression
+     * @retruns `true` if the expression is a time macro (like Now), otherwise `false`.
+     */
+    isTimeMacro(macroExpr: string, macroProcessor?: (macroId: any) => void): boolean;
+    /**
+     * Gets date by its macro value.
+     * @param macroExpr The macro value.
+     * @returns The date or `null`
+     */
+    getDateMacroValue(macroExpr: string): Date | null;
+    /**
+    * Gets the date value by a macro expression of the expression itself.
+    * @param macroExpr The macro value.
+    * @returns The date or macro valu.
+    */
+    getDateOrMacroValue(macroExpr: string): string | Date;
+    /**
+    * Gets time by its macro value.
+    * @param macroExpr The macro value.
+    * @returns The date or `null`.
+    */
+    getTimeMacroValue(macroExpr: string): Date | null;
+    /**
+     * Gets time or macro by macro value.
+     * @param macroValue The macro value.
+     * @returns The time or macro valu.
+     */
+    getTimeOrMacroValue(time: string): string | Date;
+    getAllDateMacros(): string[];
+    /**
+     * Gets all time marcos.
+     * @returns The array of marcos
+     */
+    getAllTimeMacros(): string[];
+}