Schema

new Schema()

Geml schema class.

Source:

lang/Schema.js, line 4

Members

comment :string

Source:

lang/Schema.js, line 79

Type:

string

datasets :object

Datasets, dataset = entity + relations + projection

Source:

lang/Schema.js, line 25

Type:

object

displayName :string

Source:

lang/Schema.js, line 85

Type:

string

entities :object.<string, Entity>

Entities in this schema, map of <entityName, entityObject>

Source:

lang/Schema.js, line 19

Type:

object.<string, Entity>

info :object

Raw metadata

Source:

lang/Schema.js, line 63

Type:

object

linker :Linker

Linker to process this schema

Source:

lang/Schema.js, line 45

Type:

Linker

name :string

Name of this entity

Source:

lang/Schema.js, line 51

Type:

string

types :object.<String, Object>

Types in this schema, map of <typeName, typeInfo>

Source:

lang/Schema.js, line 13

Type:

object.<String, Object>

views :object

Views, view = dataset + filters

Source:

lang/Schema.js, line 31

Type:

object

xemlModule :object

Owner geml module

Source:

lang/Schema.js, line 57

Type:

object

Methods

addEntity(entity) → {Schema}

Add an entity into the schema

Source:

lang/Schema.js, line 149

Parameters:

Name	Type	Description
`entity`	`Entity`

Returns:

Type:: Schema

addType(type, typeLocation) → {Schema}

Add an type into the schema

Source:

lang/Schema.js, line 121

Parameters:

Name	Type	Description
`type`	`*`
`typeLocation`	`*`

Returns:

Type:: Schema

addView(view) → {Schema}

Add a view into the schema

Source:

lang/Schema.js, line 175

Parameters:

Name	Type	Description
`view`	`View`

Returns:

Type:: Schema

clone() → {Schema}

Clone the schema

Source:

lang/Schema.js, line 240

Returns:

Type:: Schema

ensureGetEntity(refererModule, entityName)

Source:

lang/Schema.js, line 219

Parameters:

Name	Type	Description
`refererModule`	`*`
`entityName`	`*`

getDocumentHierachy(fromModule, datasetName) → {object}

Get a document hierarchy

Source:

lang/Schema.js, line 189

Parameters:

Name	Type	Description
`fromModule`	`object`
`datasetName`	`string`

Returns:

Type:: object

getReferencedEntity(refererModule, entityName) → {Entity}

Get the referenced entity, add it into schema if not in schema

Source:

lang/Schema.js, line 204

Parameters:

Name	Type	Description
`refererModule`	`object`
`entityName`	`string`

Returns:

Type:: Entity

hasEntity(entityName) → {boolean}

Check whether a entity with given name is in the schema

Source:

lang/Schema.js, line 140

Parameters:

Name	Type	Description
`entityName`	`string`

Returns:

Type:: boolean

hasView(viewName) → {boolean}

Check whether a view with given name is in the schema

Source:

lang/Schema.js, line 166

Parameters:

Name	Type	Description
`viewName`	`string`

Returns:

Type:: boolean

link() → {Schema}

Start linking this schema

Source:

lang/Schema.js, line 70

Returns:

Type:: Schema

toJSON() → {object}

Translate the schema into a plain JSON object

Source:

lang/Schema.js, line 261

Returns:

Type:: object

Schema

new Schema(linker, name, info)

Source:

lang/Schema.js, line 38

Parameters:

Name	Type	Description
`linker`	`Linker`
`name`	`string`
`info`	`object`

Members

comment :string

Source:

lang/Schema.js, line 79

Type:

string

datasets :object

Datasets, dataset = entity + relations + projection

Source:

lang/Schema.js, line 25

Type:

object

displayName :string

Source:

lang/Schema.js, line 85

Type:

string

entities :object.<string, Entity>

Entities in this schema, map of <entityName, entityObject>

Source:

lang/Schema.js, line 19

Type:

object.<string, Entity>

info :object

Raw metadata

Source:

lang/Schema.js, line 63

Type:

object

linker :Linker

Linker to process this schema

Source:

lang/Schema.js, line 45

Type:

Linker

name :string

Name of this entity

Source:

lang/Schema.js, line 51

Type:

string

types :object.<String, Object>

Types in this schema, map of <typeName, typeInfo>

Source:

lang/Schema.js, line 13

Type:

object.<String, Object>

views :object

Views, view = dataset + filters

Source:

lang/Schema.js, line 31

Type:

object

xemlModule :object

Owner geml module

Source:

lang/Schema.js, line 57

Type:

object

Methods

addEntity(entity) → {Schema}

Add an entity into the schema

Source:

lang/Schema.js, line 149

Parameters:

Name	Type	Description
`entity`	`Entity`

Returns:

Type:: Schema

addType(type, typeLocation) → {Schema}

Add an type into the schema

Source:

lang/Schema.js, line 121

Parameters:

Name	Type	Description
`type`	`*`
`typeLocation`	`*`

Returns:

Type:: Schema

addView(view) → {Schema}

Add a view into the schema

Source:

lang/Schema.js, line 175

Parameters:

Name	Type	Description
`view`	`View`

Returns:

Type:: Schema

clone() → {Schema}

Clone the schema

Source:

lang/Schema.js, line 240

Returns:

Type:: Schema

ensureGetEntity(refererModule, entityName)

Source:

lang/Schema.js, line 219

Parameters:

Name	Type	Description
`refererModule`	`*`
`entityName`	`*`

getDocumentHierachy(fromModule, datasetName) → {object}

Get a document hierarchy

Source:

lang/Schema.js, line 189

Parameters:

Name	Type	Description
`fromModule`	`object`
`datasetName`	`string`

Returns:

Type:: object

getReferencedEntity(refererModule, entityName) → {Entity}

Get the referenced entity, add it into schema if not in schema

Source:

lang/Schema.js, line 204

Parameters:

Name	Type	Description
`refererModule`	`object`
`entityName`	`string`

Returns:

Type:: Entity

hasEntity(entityName) → {boolean}

Check whether a entity with given name is in the schema

Source:

lang/Schema.js, line 140

Parameters:

Name	Type	Description
`entityName`	`string`

Returns:

Type:: boolean

hasView(viewName) → {boolean}

Check whether a view with given name is in the schema

Source:

lang/Schema.js, line 166

Parameters:

Name	Type	Description
`viewName`	`string`

Returns:

Type:: boolean

link() → {Schema}

Start linking this schema

Source:

lang/Schema.js, line 70

Returns:

Type:: Schema

toJSON() → {object}

Translate the schema into a plain JSON object

Source:

lang/Schema.js, line 261

Returns:

Type:: object