Class OntologyModel

Hierarchy (View Summary)

Model
- OntologyModel
  - SubUser

Implements

IOntologyModel

Indexable

[x: string]: any

Constructors

constructor

new OntologyModel(
    type: string,
    expand?: number,
    version?: string,
): OntologyModel
Parameters
- type: string
- expand: number = 0
- version: string = '2.1'
Returns OntologyModel
Inherited from Model.constructor
- Defined in src/models/model.ts:31

Properties

edges

edges: OntologyEdge[] = []

expand

expand: number

meta

meta: Meta = ...

`Optional`parent

parent?: IModel

parentEdges

parentEdges: OntologyEdge[] = []

`Static`checker

checker: ICheckerSuite = ...

Accessors

ontology

get ontology(): OntologyEdge[]
Get the ontology edges of the current object.

Returns OntologyEdge[]
The ontology edges of the current object.

Remarks
This is here for backwards compatibility.

Deprecated
Should use edges instead.
- Defined in src/models/model.ontology.ts:31
set ontology(edges: OntologyEdge[]): void
Set the ontology edges of the current object.
Parameters
- edges: OntologyEdge[]
  The ontology edges to set.
Returns void
Remarks
This is here for backwards compatibility.

Deprecated
Should use edges instead.
- Defined in src/models/model.ontology.ts:42

Methods

_create

_create(params?: JSONObject): Promise<void>
Parameters
- params: JSONObject = {}
Returns Promise<void>
Inherited from Model._create
- Defined in src/models/model.ts:110

addChildrenToStore

addChildrenToStore(): void
Returns void
Implementation of IOntologyModel.addChildrenToStore
Inherited from Model.addChildrenToStore
- Defined in src/models/model.ts:73

addEdge

addEdge(edge: OntologyEdge): void
Parameters
- edge: OntologyEdge
Returns void
Implementation of IOntologyModel.addEdge
- Defined in src/models/model.ontology.ts:50

addParentEdge

addParentEdge(params: IOntologyEdge, to: IOntologyModel): Promise<void>
Parameters
- params: IOntologyEdge
- to: IOntologyModel
Returns Promise<void>
Implementation of IOntologyModel.addParentEdge
- Defined in src/models/model.ontology.ts:85

create

create(params?: JSONObject): Promise<void>
Parameters
- params: JSONObject = {}
Returns Promise<void>
Inherited from Model.create
- Defined in src/models/model.ts:143

createEdge

createEdge(params: IEdge): Promise<OntologyEdge>
Parameters
- params: IEdge
Returns Promise<OntologyEdge>
Implementation of IOntologyModel.createEdge
- Defined in src/models/model.ontology.ts:55

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from Model.delete
- Defined in src/models/model.ts:239

deleteBranch

deleteBranch(): Promise<void>
Returns Promise<void>
Implementation of IOntologyModel.deleteBranch
- Defined in src/models/model.ontology.ts:166

deleteEdge

deleteEdge(params: IEdge): Promise<void>
Parameters
- params: IEdge
Returns Promise<void>
Implementation of IOntologyModel.deleteEdge
- Defined in src/models/model.ontology.ts:113

deleteEdges

deleteEdges(): Promise<void>
Returns Promise<void>
- Defined in src/models/model.ontology.ts:106

deleteModelFromEdge

deleteModelFromEdge(params: IEdge): Promise<void>
Parameters
- params: IEdge
Returns Promise<void>
Implementation of IOntologyModel.deleteModelFromEdge
- Defined in src/models/model.ontology.ts:122

findEdge

findEdge(params: IEdge): Promise<undefined | OntologyEdge>
Parameters
- params: IEdge
Returns Promise<undefined | OntologyEdge>
- Defined in src/models/model.ontology.ts:152

findEdges

findEdges(relationship: string): Promise<OntologyEdge[]>
Parameters
- relationship: string
Returns Promise<OntologyEdge[]>
- Defined in src/models/model.ontology.ts:147

getAllEdges

getAllEdges(_force?: boolean): Promise<IOntologyEdge[]>
Parameters
- Optional_force: boolean
Returns Promise<IOntologyEdge[]>
Implementation of IOntologyModel.getAllEdges
- Defined in src/models/model.ontology.ts:192

getAttributes

getAttributes(): string[]
Returns string[]
Inherited from Model.getAttributes
- Defined in src/models/model.ts:69

getClass

getClass(): string
Returns string
Implementation of IOntologyModel.getClass
Inherited from Model.getClass
- Defined in src/models/model.ts:57

getParent

getParent(): undefined | IModel
Returns undefined | IModel
Implementation of IOntologyModel.getParent
Inherited from Model.getParent
- Defined in src/models/model.ts:82

getParentEdges

getParentEdges(): IOntologyEdge[]
Returns IOntologyEdge[]
Implementation of IOntologyModel.getParentEdges
- Defined in src/models/model.ontology.ts:46

getType

getType(): string
Returns string
Implementation of IOntologyModel.getType
Inherited from Model.getType
- Defined in src/models/model.ts:41

getUrl

getUrl(): string
Returns string
Implementation of IOntologyModel.getUrl
Inherited from Model.getUrl
- Defined in src/models/model.ts:101

getVersion

getVersion(): string
Returns string
Inherited from Model.getVersion
- Defined in src/models/model.ts:45

id

id(): string
Returns string
Implementation of IOntologyModel.id
Inherited from Model.id
- Defined in src/models/model.ts:37

loadAllChildren

loadAllChildren(json: null | JSONObject, reloadAll?: boolean): Promise<void>
Parameters
- json: null | JSONObject
- reloadAll: boolean = false
Returns Promise<void>
Inherited from Model.loadAllChildren
- Defined in src/models/model.ts:198

parse

parse(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Implementation of IOntologyModel.parse
Inherited from Model.parse
- Defined in src/models/model.ts:252

parseChild

parseChild(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Inherited from Model.parseChild
- Defined in src/models/model.ts:267

path

path(): string
Returns string
Inherited from Model.path
- Defined in src/models/model.ts:53

preserve

preserve(): void
Returns void
Inherited from Model.preserve
- Defined in src/models/model.ts:87

reload

reload(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>
Parameters
- OptionalreloadAll: boolean
- defaultExpand: number = 0
Returns Promise<boolean>
Implementation of IOntologyModel.reload
Inherited from Model.reload
- Defined in src/models/model.ts:226

reloadAndParse

reloadAndParse(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>
Parameters
- OptionalreloadAll: boolean
- defaultExpand: number = 0
Returns Promise<boolean>
Inherited from Model.reloadAndParse
- Defined in src/models/model.ts:205

removeChild

removeChild(_: IModel): void
Parameters
- _: IModel
Returns void
Implementation of IOntologyModel.removeChild
Inherited from Model.removeChild
- Defined in src/models/model.ts:66

removeEdge

removeEdge(edge: IModel): void
Parameters
- edge: IModel
Returns void
Implementation of IOntologyModel.removeEdge
- Defined in src/models/model.ontology.ts:136

removeParentEdge

removeParentEdge(edge: IOntologyEdge): void
Parameters
- edge: IOntologyEdge
Returns void
Implementation of IOntologyModel.removeParentEdge
- Defined in src/models/model.ontology.ts:100

restore

restore(): void
Returns void
Inherited from Model.restore
- Defined in src/models/model.ts:90

setParent

setParent(parent?: IModel): void
Parameters
- Optionalparent: IModel
Returns void
Implementation of IOntologyModel.setParent
Inherited from Model.setParent
- Defined in src/models/model.ts:77

toJSON

toJSON(customKeys?: string[]): JSONObject
Parameters
- OptionalcustomKeys: string[]
Returns JSONObject
Implementation of IOntologyModel.toJSON
Inherited from Model.toJSON
- Defined in src/models/model.ts:271

transverse

transverse(path: string, getAll?: boolean): Promise<IOntologyModel[]>
Parameters
- path: string
- OptionalgetAll: boolean
Returns Promise<IOntologyModel[]>
- Defined in src/models/model.ontology.ts:207

update

update(customKeys?: string[]): Promise<boolean>
Parameters
- OptionalcustomKeys: string[]
Returns Promise<boolean>
Inherited from Model.update
- Defined in src/models/model.ts:179

url

url(): string
Returns string
Inherited from Model.url
- Defined in src/models/model.ts:49

`Protected`usePutForUpdate

usePutForUpdate(): boolean
Returns boolean
Inherited from Model.usePutForUpdate
- Defined in src/models/model.ts:61

`Protected`validate

validate(name: string, params: any): void
Parameters
- name: string
- params: any
Returns void
Inherited from Model.validate
- Defined in src/models/model.ts:97

`Static`fetch

fetch(params: FetchRequest): Promise<JSONObject[]>
Parameters
- params: FetchRequest
Returns Promise<JSONObject[]>
Inherited from Model.fetch
- Defined in src/models/model.ts:297

`Static`fromArray

fromArray<T>(
    this: new () => T,
    json: JSONObject[],
    parent?: IModel,
): (string | T)[]
Type Parameters
- T
Parameters
- this: new () => T
- json: JSONObject[]
- Optionalparent: IModel
Returns (string | T)[]
Inherited from Model.fromArray
- Defined in src/models/model.ts:336

`Protected` `Static`generateOptions

generateOptions(params?: JSONObject): JSONObject
Parameters
- Optionalparams: JSONObject
Returns JSONObject
Inherited from Model.generateOptions
- Defined in src/models/model.ts:384

`Static`getMetaFilterResult

getMetaFilterResult(_filter?: Filter): string
Parameters
- Optional_filter: Filter
Returns string
Inherited from Model.getMetaFilterResult
- Defined in src/models/model.ts:93

`Static`validateMethod

validateMethod(
    type: undefined | string,
    name: string,
    params: any,
    isStatic?: boolean,
): void
Parameters
- type: undefined | string
- name: string
- params: any
- isStatic: boolean = false
Returns void
Inherited from Model.validateMethod
- Defined in src/models/model.ts:352