Class OntologyEdge

Hierarchy

Model
- OntologyEdge

Implements

IOntologyEdge

Indexable

[x: string]: any

Constructors

constructor

new OntologyEdge(
    from?: IOntologyModel,
    relationship?: string,
    to?: IOntologyModel,
): OntologyEdge
Parameters
- Optionalfrom: IOntologyModel
- Optionalrelationship: string
- Optionalto: IOntologyModel
Returns OntologyEdge
Overrides Model.constructor
- Defined in src/models/ontology.edge.ts:28

Properties

`Optional`data

data?: unknown

`Optional`description

description?: string

expand

expand: number

failedModels

failedModels: Record<string, string[]> = {}

meta

meta: Meta = ...

models

models: OntologyModel[] = []

`Optional`name

name?: string

`Optional`parent

parent?: IModel

relationship

relationship: string = ''

to

to: Record<string, string[]> = {}

`Static`attributes

attributes: string[] = ...

`Static`checker

checker: ICheckerSuite = ...

`Static`endpoint

endpoint: string = '/2.1/ontology'

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 IOntologyEdge.addChildrenToStore
Inherited from Model.addChildrenToStore
- Defined in src/models/model.ts:73

create

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

delete

delete(): Promise<void>
Returns Promise<void>
Overrides Model.delete
- Defined in src/models/ontology.edge.ts:144

deleteBranch

deleteBranch(): Promise<void>
Returns Promise<void>
- Defined in src/models/ontology.edge.ts:153

fetchModels

fetchModels(): Promise<void>
Returns Promise<void>
- Defined in src/models/ontology.edge.ts:96

getAttributes

getAttributes(): string[]
Returns string[]
Overrides Model.getAttributes
- Defined in src/models/ontology.edge.ts:46

getClass

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

getParent

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

getType

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

getUrl

getUrl(): string
Returns string
Implementation of IOntologyEdge.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 IOntologyEdge.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 IOntologyEdge.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 IOntologyEdge.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 IOntologyEdge.removeChild
Inherited from Model.removeChild
- Defined in src/models/model.ts:66

removeModel

removeModel(to: IOntologyModel): boolean
Parameters
- to: IOntologyModel
Returns boolean
- Defined in src/models/ontology.edge.ts:77

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 IOntologyEdge.setParent
Inherited from Model.setParent
- Defined in src/models/model.ts:77

toJSON

toJSON(): JSONObject
Returns JSONObject
Implementation of IOntologyEdge.toJSON
Overrides Model.toJSON
- Defined in src/models/ontology.edge.ts:50

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(parameters: FetchRequest): Promise<OntologyEdge[]>
Parameters
- parameters: FetchRequest
Returns Promise<OntologyEdge[]>
Overrides Model.fetch
- Defined in src/models/ontology.edge.ts:184

`Static`fetchById

fetchById(id: string): Promise<undefined | OntologyEdge>
Parameters
- id: string
Returns Promise<undefined | OntologyEdge>
- Defined in src/models/ontology.edge.ts:164

`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