Class OntologyNode<T>

Type Parameters

T extends Record<string, unknown> = Record<string, string>

Hierarchy (View Summary)

Data<T>
- OntologyNode

Implements

IOntologyNode

Indexable

[x: string]: any

Index

Methods

Constructors

constructor

new OntologyNode<T extends Record<string, unknown> = Record<string, string>>(
name?: string,
nodeData?: T,
): OntologyNode<T>
Type Parameters
- T extends Record<string, unknown> = Record<string, string>
Parameters
- Optionalname: string
- OptionalnodeData: T
Returns OntologyNode<T>
Overrides Data.constructor
- Defined in src/models/ontology.node.ts:17

Properties

_secret_background

_secret_background: T = ...

data

data: T = ...

data_meta

data_meta: DataMeta = {}

edges

edges: OntologyEdge[] = []

expand

expand: number

`Optional`parent

parent?: IModel

parentEdges

parentEdges: OntologyEdge[] = []

`Static`attributes

attributes: string[] = ...

`Static`checker

checker: ICheckerSuite = ...

`Static`endpoint

endpoint: string = '/2.1/data'

`Static`streamCallback

streamCallback: StreamHandlerCallbacks = ...

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.
Inherited from Data.ontology
- 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.
Inherited from Data.ontology
- Defined in src/models/model.ontology.ts:42

Methods

_create

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

addChildrenToStore

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

addEdge

addEdge(edge: OntologyEdge): void
Parameters
- edge: OntologyEdge
Returns void
Implementation of IOntologyNode.addEdge
Inherited from Data.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 IOntologyNode.addParentEdge
Inherited from Data.addParentEdge
- Defined in src/models/model.ontology.ts:85

addTag

addTag(tag: string): Promise<boolean>
Parameters
- tag: string
Returns Promise<boolean>
Inherited from Data.addTag
- Defined in src/models/model.tags.ts:5

cancelOnChange

cancelOnChange(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.cancelOnChange
- Defined in src/models/model.stream.ts:210

cancelOnCreate

cancelOnCreate(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.cancelOnCreate
- Defined in src/models/model.stream.ts:218

cancelOnDelete

cancelOnDelete(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.cancelOnDelete
- Defined in src/models/model.stream.ts:214

cancelOnEvent

cancelOnEvent(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.cancelOnEvent
- Defined in src/models/model.stream.ts:206

clearAllCallbacks

clearAllCallbacks(): Promise<boolean>
Returns Promise<boolean>
Inherited from Data.clearAllCallbacks
- Defined in src/models/model.stream.ts:245

clearTags

clearTags(): Promise<boolean>
Returns Promise<boolean>
Inherited from Data.clearTags
- Defined in src/models/model.tags.ts:24

create

create(): Promise<void>
Returns Promise<void>
Inherited from Data.create
- Defined in src/models/model.permission.ts:82

createEdge

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

delete

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

deleteBranch

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

deleteEdge

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

deleteEdges

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

deleteModelFromEdge

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

entries

entries<K extends string | number | symbol>(): [K, T[K]][]
Type Parameters
- K extends string | number | symbol
Returns [K, T[K]][]
Inherited from Data.entries
- Defined in src/models/data.ts:104

findEdge

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

findEdges

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

get

get<K extends string | number | symbol>(
name: K,
secret?: boolean,
): undefined | T[K]
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
- secret: boolean = false
Returns undefined | T[K]
Inherited from Data.get
- Defined in src/models/data.ts:68

getAllEdges

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

getAttributes

getAttributes(): string[]
Returns string[]
Inherited from Data.getAttributes
- Defined in src/models/data.ts:43

getClass

getClass(): string
Returns string
Implementation of IOntologyNode.getClass
Overrides Data.getClass
- Defined in src/models/ontology.node.ts:24

getParent

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

getParentEdges

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

getSharedWith

getSharedWith(): Promise<any>
Returns Promise<any>
Inherited from Data.getSharedWith
- Defined in src/models/model.sharing.ts:51

getTags

getTags(): string[]
Returns string[]
Inherited from Data.getTags
- Defined in src/models/model.tags.ts:20

getType

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

getUrl

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

getVersion

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

handleStream

handleStream(event: StreamEvent): Promise<void>
Parameters
- event: StreamEvent
Returns Promise<void>
Inherited from Data.handleStream
- Defined in src/models/model.stream.ts:295

id

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

keys

keys<K extends string | number | symbol>(): K[]
Type Parameters
- K extends string | number | symbol
Returns K[]
Inherited from Data.keys
- Defined in src/models/data.ts:96

loadAllChildren

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

onChange

onChange(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.onChange
- Defined in src/models/model.stream.ts:173

onCreate

onCreate(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.onCreate
- Defined in src/models/model.stream.ts:195

onDelete

onDelete(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.onDelete
- Defined in src/models/model.stream.ts:184

onEvent

onEvent(callback: StreamCallback): Promise<boolean>
Parameters
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.onEvent
- Defined in src/models/model.stream.ts:162

parse

parse(json: JSONObject): boolean
Parameters
- json: JSONObject
Returns boolean
Implementation of IOntologyNode.parse
Inherited from Data.parse
- Defined in src/models/data.ts:152

parseChild

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

path

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

preserve

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

reload

reload(reloadAll?: boolean, defaultExpand?: number): Promise<boolean>
Parameters
- OptionalreloadAll: boolean
- OptionaldefaultExpand: number
Returns Promise<boolean>
Implementation of IOntologyNode.reload
Inherited from Data.reload
- Defined in src/models/model.permission.ts:267

reloadAndParse

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

remove

remove<K extends string | number | symbol>(name: K, secret?: boolean): void
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
- secret: boolean = false
Returns void
Inherited from Data.remove
- Defined in src/models/data.ts:86

removeChild

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

removeEdge

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

removeParentEdge

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

removeTag

removeTag(tag: string): Promise<boolean>
Parameters
- tag: string
Returns Promise<boolean>
Inherited from Data.removeTag
- Defined in src/models/model.tags.ts:11

restore

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

set

set<K extends string | number | symbol>(
    name: K,
    item: T[K],
    secret?: boolean,
): void
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
- item: T[K]
- secret: boolean = false
Returns void
Inherited from Data.set
- Defined in src/models/data.ts:51

setParent

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

shareWith

shareWith(user: string, restriction?: IRestriction): Promise<any>
Parameters
- user: string
- restriction: IRestriction = ...
Returns Promise<any>
Inherited from Data.shareWith
- Defined in src/models/model.sharing.ts:7

toJSON

toJSON(): JSONObject
Returns JSONObject
Implementation of IOntologyNode.toJSON
Inherited from Data.toJSON
- Defined in src/models/data.ts:174

transverse

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

unshareWith

unshareWith(user: string): Promise<any>
Parameters
- user: string
Returns Promise<any>
Inherited from Data.unshareWith
- Defined in src/models/model.sharing.ts:39

update

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

url

url(): string
Returns string
Inherited from Data.url
- Defined in src/models/data.ts:31

`Protected`usePutForUpdate

usePutForUpdate(): boolean
Returns boolean
Inherited from Data.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 Data.validate
- Defined in src/models/model.ts:97

values

values<K extends string | number | symbol>(): T[K][]
Type Parameters
- K extends string | number | symbol
Returns T[K][]
Inherited from Data.values
- Defined in src/models/data.ts:100

`Static`cancelCallback

cancelCallback(
    all: StreamHandlerCallbacks,
    type: "create" | "update" | "delete",
    callback: StreamHandler,
): Promise<boolean>
Parameters
- all: StreamHandlerCallbacks
- type: "create" | "update" | "delete"
- callback: StreamHandler
Returns Promise<boolean>
Inherited from Data.cancelCallback
- Defined in src/models/model.stream.ts:105

`Static`cancelOnChange

cancelOnChange<T>(this: new () => T, callback: StreamCallback): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.cancelOnChange
- Defined in src/models/model.stream.ts:142

`Static`cancelOnCreate

cancelOnCreate<T>(this: new () => T, callback: StreamCallback): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.cancelOnCreate
- Defined in src/models/model.stream.ts:132

`Static`cancelOnDelete

cancelOnDelete<T>(this: new () => T, callback: StreamCallback): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamCallback
Returns Promise<boolean>
Inherited from Data.cancelOnDelete
- Defined in src/models/model.stream.ts:152

`Static`fetch

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

`Static`fetchById

fetchById<T extends Record<string, unknown> = Record<string, unknown>>(
id: string,
): Promise<undefined | Data<T>>
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
Parameters
- id: string
Returns Promise<undefined | Data<T>>
Inherited from Data.fetchById
- Defined in src/models/data.ts:108

`Static`findByDataId

findByDataId<T extends Record<string, unknown> = Record<string, unknown>>(
id: string,
): Promise<Data<T>[]>
Finds instances of the Data model with a specific ID.
Type Parameters
- T extends Record<string, unknown> = Record<string, unknown>
Parameters
- id: string
  The ID to search for.
Returns Promise<Data<T>[]>
A Promise that resolves to an array of Data instances matching the provided ID.
Inherited from Data.findByDataId
- Defined in src/models/data.ts:134

`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 Data.fromArray
- Defined in src/models/model.ts:336

`Protected` `Static`generateOptions

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

`Static`getMetaFilterResult

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

`Static`onChange

onChange<T>(this: new () => T, callback: StreamHandler): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamHandler
Returns Promise<boolean>
Inherited from Data.onChange
- Defined in src/models/model.stream.ts:69

`Static`onCreate

onCreate<T>(this: new () => T, callback: StreamHandler): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamHandler
Returns Promise<boolean>
Inherited from Data.onCreate
- Defined in src/models/model.stream.ts:51

`Static`onDelete

onDelete<T>(this: new () => T, callback: StreamHandler): Promise<boolean>
Type Parameters
- T
Parameters
- this: new () => T
- callback: StreamHandler
Returns Promise<boolean>
Inherited from Data.onDelete
- Defined in src/models/model.stream.ts:87

`Static`request

request(
    options: {
        body?: JSONObject;
        create?: boolean;
        endpoint: string;
        message: string;
        params?: JSONObject;
        quantity: number | "all";
        readOnly?: boolean;
    },
): Promise<JSONObject[]>
Parameters
- options: {
      body?: JSONObject;
      create?: boolean;
      endpoint: string;
      message: string;
      params?: JSONObject;
      quantity: number | "all";
      readOnly?: boolean;
  }
Returns Promise<JSONObject[]>
Inherited from Data.request
- Defined in src/models/model.permission.ts:141

`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 Data.validateMethod
- Defined in src/models/model.ts:352

Class OntologyNode<T>

Type Parameters

Hierarchy (View Summary)

Implements

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OntologyNode<T>

Properties

_secret_background

data

data_meta

edges

expand

meta

Optionalparent

parentEdges

Staticattributes

Staticchecker

Staticendpoint

StaticstreamCallback

Accessors

ontology

Returns OntologyEdge[]

Remarks

Deprecated

Parameters

Returns void

Remarks

Deprecated

Methods

_create

Parameters

Returns Promise<void>

addChildrenToStore

Returns void

addEdge

Parameters

Returns void

addParentEdge

Parameters

Returns Promise<void>

addTag

Parameters

Returns Promise<boolean>

cancelOnChange

Parameters

Returns Promise<boolean>

cancelOnCreate

Parameters

Returns Promise<boolean>

cancelOnDelete

Parameters

Returns Promise<boolean>

cancelOnEvent

Parameters

Returns Promise<boolean>

clearAllCallbacks

Returns Promise<boolean>

clearTags

Returns Promise<boolean>

create

Returns Promise<void>

createEdge

Parameters

Returns Promise<OntologyEdge>

delete

Returns Promise<void>

deleteBranch

Returns Promise<void>

deleteEdge

Parameters

Returns Promise<void>

`Optional`parent

`Static`attributes

`Static`checker

`Static`endpoint

`Static`streamCallback