Home Reference Source
public class | source

Coalescence

Extends:

Resource → Coalescence

Coalescence model

Member Summary

Public Members
public
public get

Checks whether the coalescence resource defines an abstract template (coalescence of abstract lyphs or materials)

Method Summary

Public Methods
public

createInstances(parentGroup: *, modelClasses: *)

Replicates coalescences defined on abstract lyphs to their subtypes

public

Validate whether the lyphs in the coalescence template are allowed to coalesce (e.g., lyph layers cannot coalesce with their container, etc.)

Inherited Summary

From class Resource
public static get

Model: *

public static

fromJSON(json: Object, modelClasses: Object, entitiesByID: Map<string, Resource>): Resource

Creates a Resource object from its JSON specification

public

id: *

public

assignPathProperties(modelClasses: Object)

Assign properties to the objects specified with the help of JSON path expressions in the resource 'assign' statements

public

assignPathRelationships(modelClasses: Object, entitiesByID: Map<string, Resource>)

Create relationships defined with the help of JSON path expressions in the resource 'assign' statements

public

containsMaterial(materialID: *): * | void | T

Checks if the current resource carries a material.

public

Assign properties to resources specified with the help of JSON path expressions in the resource 'interpolate' statements

public

isSubtypeOf(supertypeID: *): boolean

Checks if the current resource is derived from The method makes more sense for lyphs, but it is useful to be able to test any resource, this simplifies filtering

public

replaceIDs(modelClasses: Object, entitiesByID: Map<string, Resource>)

Replace IDs with object references

public

Waiting list keeps objects that refer to unresolved model resources.

public

syncRelationship(key: string, spec: Object, modelClasses: Object)

Synchronize a relationship field of the resource with its counterpart (auto-fill a field that is involved into a bi-directional relationship based on its partial definition, i.e., A.child = B yields B.parent = A).

public

syncRelationships(modelClasses: Object, entitiesByID: Map<string, Resource>)

Synchronize all relationship properties of the resource

public

toJSON(depth: *, initDepth: *): *

Prepare a circular resource object to be serialized in JSON.

Public Members

public inactive: boolean source

public get isTemplate: boolean: * source

Checks whether the coalescence resource defines an abstract template (coalescence of abstract lyphs or materials)

Return:

boolean

Public Methods

public createInstances(parentGroup: *, modelClasses: *) source

Replicates coalescences defined on abstract lyphs to their subtypes

Params:

NameTypeAttributeDescription
parentGroup *

global group/graph (to refer to other resources)

modelClasses *

model resource classes

public validate() source

Validate whether the lyphs in the coalescence template are allowed to coalesce (e.g., lyph layers cannot coalesce with their container, etc.)