the main structurePermalink

Property RelationshipsPermalink

MetaView operates the same as MetaTable.
The difference is that if _baseEntity is specified, if add(name) column is added, the ‘column’ registers a reference, ‘MetaColumn’ is registered in ‘column’ of baseEntity. Add(name, collection?) If you specify ‘collection’ when adding a column, the reference is registered in ‘columns’, ‘MetaColumn’ is registered in the specified ‘collecton’.

Class diagram

an inheritance relationshipPermalink

Class diagram

a key elementPermalink

PropertiesPermalink

MethodPermalink

Detailed descriptionPermalink

Key PropertiesPermalink

viewNamePermalink

This is the name of the meta view.

Copy codetype viewName = string;

columnsPermalink

Collection of columns in the view.

Copy codetype columns = MetaTableColumnCollection;

rowsPermalink

Data (low) collection of tables.

Copy codetype rows = MetaRowCollection;

_baseEntityPermalink

Default entity.

Copy codetype _baseEntity = BaseEntity;

_metaSetPermalink

This is the meta set to which the table belongs.

Copy codetype _metaSet = MetaSet;

_guidPermalink

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

Copy codetype _guid: string;

_typePermalink

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

Copy codetype _type: Function;

Key MethodsPermalink

clone()Permalink

Create and return a deep copy of the current object.

Copy codetype clone() => MetaTable;

• return : This is a replica of the current object.

copy()Permalink

Copy the target column.

Copy codetype copy = (
    filter: (row, idx, entity) => boolean | string[], arguments<string>, 
    cols?: string[] | arguments<string>
) => MetaView;

• filter :
  • Function type is the callback function that selects the column.
  • Type string[] is the name of the column to copy.
• cols : The name of the column to copy, valid only if the filter is a Function type.

Example: Using filter, cols

Copy codevar table = new MetaTable('t1');

// ... Add columns, aa, bb, cc, e, and rows
var temp = table.copy(
    (row, idx, entity) => { return (idx % 2) > 0; },
    ['aa', 'bb']
);

• Temp is copied only if the row indexes of the columns ‘aa’ and ‘bbb’ are odd.

Example: Using cols only

Copy codevar table = new MetaTable('t1');

// ... Add columns, aa, bb, cc, e, and rows 

var temp = table.copy(
    ['aa', 'bb']
);

• Temp copies the entire row of columns ‘aa’ and ‘bbb’.

transformSchema()Permalink

Converts a given serialization object to a schema object.

Copy codetype transformSchema = (oGuid: object) => object; // static

• oGuid : object obtained by getObject().

clear()Permalink

Initializes all data in the entity.

Copy codetype clear = () => void;

reset()Permalink

Initializes the entity’s columns and data.

Copy codetype reset = () => void;

newRow()Permalink

Create and return a new row that matches the column structure.

Copy codetype newRow = () => MetaRow;

• return : This is the MetaRow object created.

  getValue()Permalink

Returns the value of the > column as a MetaRow type object.

Copy codetype getValue = () => MetaRow;

• return : MetaRow object with the value of the column set.

setValue()Permalink

Set the MetaRow value to the value in the column.

Copy codetype setValue = (row: MetaRow) => void;

• row : MetaRow object to be set.

merge()Permalink

Merges the given entity with the current entity.

Copy codetype merge = (target: BaseEntity, option: number, matchType?: boolean) => void;

• target : The target entity to merge.
• option : Merge option.
• matchType : Whether or not a row validation exists. (Default: false)

select()Permalink

Look up the row according to the given callback function.

Copy codetype select = (
    filter: (row, idx, entity) => boolean | string[], | arguments<string>,
    cols?: string[] | arguments<string>
) => MetaView;

• filter :
  • Function type is the callback function that selects the column.
  • Type string[] is the name of the column to copy.
• cols : The name of the column to copy, valid only if the filter is a Function type.

Example: Using filter, cols

Copy codevar table = new MetaTable('t1');

// ... Add columns, aa, bb, cc, e, and rows 

var temp = table.copy(
    (row, idx, entity) => { return (idx % 2) > 0; },
    ['aa', 'bb']
);

• The temp view is copied only if the row indexes of the columns ‘aa’, ‘bbb’ are odd.

Example: Using cols only

Copy codevar table = new MetaTable('t1');

// ... Add columns, aa, bb, cc, e, and rows 

var temp = table.copy(
    ['aa', 'bb']
);

• The temp view copies the entire row of columns ‘aa’ and ‘bbb’.

load()Permalink

Imports the given object to the current entity, initializes the existing data and loads the new data.

Copy codetype load = (obj: object | string, parse?: Function) => void;

• obj : The object to be called.
• pas : parser function. (Optional)

output()Permalink

Outputs the current entity as a serialized string.

Copy codetype output = (vOpt: number, stringify?: Function, space?: string) => string;

• vOpt : Optional (0, 1, 2)
• stringify : This is a user-defined parser function. (Optional)
• space : A blank string to be used in the output. (Optional)

read()Permalink

Reads the given object as an entity. Follow JSON schema rules.

Copy codetype read = (obj: object, option: number) => void;

• obj : object to be read.
• option : Read option (default: 3)

Copy codevar schema1 = { 
    table: { 
        columns: {}, 
        rows: {} 
    }
};

var schema1 = { 
    columns: {...}, 
    rows: {} 
};

readSchema()Permalink

Reads the given schema object as the current entity.

Copy codetype readSchema = (obj: object, createRow?: boolean) => void;

• obj : Schema object to be read.
• createRow : If true, add the column by row[0] (default: false)

readData()Permalink

Reads only rows that exist on a given object.

Copy codetype readData = (obj: object) => void;

• obj : The object to be read.

write()Permalink

Returns the current entity after converting it to an object of schema type.

Copy codetype write = (vOpt?: number) => object;

• vOpt : Optional (default: 0)
• return : Object of schema type.

writeSchema()Permalink

Returns the schema of the current entity by converting it to an object of schema type.

Copy codetype writeData = (vOpt?: number): object;

• vOpt : Optional (default: 0)
• return : Object of schema type.

writeData()Permalink

Returns the data of the current entity by converting it into an object of schema type.

Copy codetype writeData = (vOpt?: number) => object;

• vOpt : Optional (default: 0)
• return : Object of schema type.

getObject()Permalink

Obtain the current object as a guide type object. (Circular references are replaced by $ref values.)

Copy codetype getObject = (vOpt?: number, owned?: object | Array<object>) => object;

• vOpt : Import option; default is 0.
  • opt=0: Reference structure (_guid:Yes, $ref:Yes)
  • opt=1: Redundant structure (_guid:Yes, $ref:Yes)
  • opt=2 : Non-tidal structure (_guid: No, $ref: No)
• aged : The parent objects that currently own the object. The default is an empty object.
• return —Returns serialized objects.

Copy codea.getObject(2) == b.getObject(2)

setObject()Permalink

Set the Guid type object to the current object. (The object will be reset.)

Copy codetype setObject = (oGuid: object, origin?: object) => void;

• oGuid : Object of the guid type to serialize.
• origin : This is the original object that sets the current object. The default is oGuid.

equal()Permalink

Compare the current object with the specified object.

Copy codetype equal (target: object) => boolean;

• return —Returns whether the two objects are identical.

getTypes()Permalink

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

Copy codetype getTypes = () => Array<Function>;

• return : Returns the array of generator functions.

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

instanceOf()Permalink

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

Copy codetype instanceOf = (target: object | string) => boolean;

• target : The type of object to be checked (object or string).
• return —Returns whether this is an instance of the specified type.