Class SubjectImpl

The main subject implementation of the Subject interface which works with the LocalGraph

This class is only exported so that it's accessible to the graph.ts module.

Hierarchy

SubjectBase
- SubjectImpl

Implements

RemoteDataSpec<Subject>

Constructors

constructor

new SubjectImpl(id: SubjectId, graph: LocalGraph): SubjectImpl
Parameters
- id: SubjectId
- graph: LocalGraph
Returns SubjectImpl
Overrides SubjectBase.constructor
- Defined in fdr/dataspec.ts:500

Properties

`Readonly` changes

changes: PropertyChange[] = []

graph

graph: LocalGraph

`Readonly` id

id: SubjectId

`Protected` onPropertyChanged

onPropertyChanged: Subscription = ...

onReferentsChanged

onReferentsChanged: Subscription = ...

`Protected` properties

properties: null | object = null

`Protected` workingCopies

workingCopies: SubjectLightCopy[] = []

Accessors

query

get query(): {
    id: undefined;
    propertyValueIdentifier: {
        object: Literal | Subject | {
            id: SubjectId;
        };
        ontologyId: string;
        predicate: string;
        subject: {
            id: SubjectId;
        };
    };
    type: string;
} | {
    id: string;
    propertyValueIdentifier: undefined;
    type: string;
}
Returns {
    id: undefined;
    propertyValueIdentifier: {
        object: Literal | Subject | {
            id: SubjectId;
        };
        ontologyId: string;
        predicate: string;
        subject: {
            id: SubjectId;
        };
    };
    type: string;
} | {
    id: string;
    propertyValueIdentifier: undefined;
    type: string;
}
- Defined in fdr/dataspec.ts:505

ready

get ready(): boolean
Whether this dataspec is ready to use

Returns boolean
Implementation of RemoteDataSpec.ready

Overrides SubjectBase.ready
- Defined in fdr/dataspec.ts:526

Methods

addPropertyChangedCallback

addPropertyChangedCallback(callback: ((key: string) => void)): void
Parameters
- callback: ((key: string) => void)
  - - (key: string): void
    - Parameters
      
      key: string
      
      Returns void
Returns void
Inherited from SubjectBase.addPropertyChangedCallback
- Defined in fdr/dataspec.ts:465

addReferentsChangedCallback

addReferentsChangedCallback(callback: ((referent: Subject, key: string) => void)): void
Parameters
- callback: ((referent: Subject, key: string) => void)
  - - (referent: Subject, key: string): void
    - Parameters
      
      referent: Subject
      
      key: string
      
      Returns void
Returns void
Inherited from SubjectBase.addReferentsChangedCallback
- Defined in fdr/dataspec.ts:457

apply

apply(changes: PropertyChange[]): void
Parameters
- changes: PropertyChange[]
Returns void
Overrides SubjectBase.apply
- Defined in fdr/dataspec.ts:534

commit

commit(): Promise<void>
Commit changes performed to this DataSpec object to its source of truth

Returns Promise<void>
Implementation of RemoteDataSpec.commit

Overrides SubjectBase.commit
- Defined in fdr/dataspec.ts:608

delete

delete(prop: string, lang?: any, ...val: Subject[] | LiteralValue[]): Subject
Parameters
- prop: string
- Optional lang: any
- Rest ...val: Subject[] | LiteralValue[]
Returns Subject
Inherited from SubjectBase.delete
- Defined in fdr/dataspec.ts:198

`Protected` enqueueToChangeBuffer

enqueueToChangeBuffer(...change: PropertyChange[]): void
Enqueue a change to the buffer which will be sent to upstream sources of truth for synchronization
Parameters
- Rest ...change: PropertyChange[]
  
  the change to enqueue
Returns void
Inherited from SubjectBase.enqueueToChangeBuffer
- Defined in fdr/dataspec.ts:57

get

get(prop: string, lang?: string): null | Subject | LiteralValue
Returns
the (first) value of the given property with the given language (if set) or if no language is set or the language is optional and no values with the given language are present, the first value present
Parameters
- prop: string
- Optional lang: string
  
  the language of the requested values. If set, only values with the given language will be returned. If no values of the given language are present and the language is optional (lang ends with '?'), all the values will be returned. If not set, all the values will be returned
Returns null | Subject | LiteralValue
Inherited from SubjectBase.get
- Defined in fdr/dataspec.ts:168

getAll

getAll(prop: string, lang?: string): Subject[] | LiteralValue[]
Returns
an array consisting of all the values of the given property. If the values are string literals only values with the specified language are returned. Non string literals are transformed into js objects according to their set datatype. If threre are no values with the given language and teh
Parameters
- prop: string
- Optional lang: string
  
  the language of the requested values. If set, only values with the given language will be returned. If no values of the given language are present and the language is optional (lang ends with '?'), all the values will be returned. If not set, all the values will be returned
Returns Subject[] | LiteralValue[]
Inherited from SubjectBase.getAll
- Defined in fdr/dataspec.ts:118

getGraph

getGraph(): Graph
Returns Graph
Overrides SubjectBase.getGraph
- Defined in fdr/dataspec.ts:482

ingest

ingest(dataset: Dataset<Quad, Quad>): void
Ingest the quads from a dataset which are relevant to this Subject into this Subject's properties
Parameters
- dataset: Dataset<Quad, Quad>
Returns void
Implementation of RemoteDataSpec.ingest
- Defined in fdr/dataspec.ts:549

`Protected` notifyGraphAboutPropertyChange

notifyGraphAboutPropertyChange(changedProperties: string[]): void
Notify the graph that some properties have changed
Parameters
- changedProperties: string[]
  
  the changed properties
Returns void
Overrides SubjectBase.notifyGraphAboutPropertyChange
- Defined in fdr/dataspec.ts:494

notifyReferentsChanged

notifyReferentsChanged(referent: any, key: any): void
Parameters
- referent: any
- key: any
Returns void
Inherited from SubjectBase.notifyReferentsChanged
- Defined in fdr/dataspec.ts:453

`Protected` onlyWithLanguage

onlyWithLanguage(values: Literal[], lang: string): Literal[]
Parameters
- values: Literal[]
- lang: string
Returns Literal[]
Inherited from SubjectBase.onlyWithLanguage
- Defined in fdr/dataspec.ts:61

`Protected` parseLangString

parseLangString(lang?: string): {
language?: string;
languageIsOptional: boolean;
}
Parse the language string or if not set, parse the environment's default language setting

Returns
Parameters
- Optional lang: string
Returns {
language?: string;
languageIsOptional: boolean;
}
- Optional language?: string
- languageIsOptional: boolean
Inherited from SubjectBase.parseLangString
- Defined in fdr/dataspec.ts:70

propertyAsSubject

propertyAsSubject(propertyName: string, value: Subject | LiteralValue, lang?: string): Subject
Parameters
- propertyName: string
- value: Subject | LiteralValue
- Optional lang: string
Returns Subject
Inherited from SubjectBase.propertyAsSubject
- Defined in fdr/dataspec.ts:40

propertyNames

propertyNames(): string[]
Returns string[]
Inherited from SubjectBase.propertyNames
- Defined in fdr/dataspec.ts:210

removePropertyChangedCallback

removePropertyChangedCallback(callback: ((key: string) => void)): void
Parameters
- callback: ((key: string) => void)
  - - (key: string): void
    - Parameters
      
      key: string
      
      Returns void
Returns void
Inherited from SubjectBase.removePropertyChangedCallback
- Defined in fdr/dataspec.ts:469

removeReferentsChangedCallback

removeReferentsChangedCallback(callback: ((referent: Subject, key: string) => void)): void
Parameters
- callback: ((referent: Subject, key: string) => void)
  - - (referent: Subject, key: string): void
    - Parameters
      
      referent: Subject
      
      key: string
      
      Returns void
Returns void
Inherited from SubjectBase.removeReferentsChangedCallback
- Defined in fdr/dataspec.ts:461

`Protected` resolveName

resolveName(name: string): string
Parameters
- name: string
Returns string
Overrides SubjectBase.resolveName
- Defined in fdr/dataspec.ts:486

set

set(prop: string, lang?: string, ...object: Subject[] | LiteralValue[]): Subject
Parameters
- prop: string
- Optional lang: string
- Rest ...object: Subject[] | LiteralValue[]
Returns Subject
Inherited from SubjectBase.set
- Defined in fdr/dataspec.ts:175

setMore

setMore(prop: string, lang?: any, ...object: Subject[] | LiteralValue[]): Subject
Parameters
- prop: string
- Optional lang: any
- Rest ...object: Subject[] | LiteralValue[]
Returns Subject
Inherited from SubjectBase.setMore
- Defined in fdr/dataspec.ts:187

syncFromDownstream

syncFromDownstream(changes: PropertyChange[]): void
Parameters
- changes: PropertyChange[]
Returns void
Overrides SubjectBase.syncFromDownstream
- Defined in fdr/dataspec.ts:637

syncFromUpstream

syncFromUpstream(changes: PropertyChange[]): Promise<void>
Parameters
- changes: PropertyChange[]
Returns Promise<void>
Overrides SubjectBase.syncFromUpstream
- Defined in fdr/dataspec.ts:630

use

use(): Promise<Subject>
Returns Promise<Subject>
- Defined in fdr/dataspec.ts:530

workingCopy

workingCopy(reactivityDecorator?: (<T>(original: T) => T)): Subject
Construct a working copy of this dataspec.

Changes to a working copy will not be automatically applied to its backing object. In order to propagate the changes, the user needs to explicitly call WorkingCopy.commit()

When changes are applied to this object, they are automatically propagated to its working copies
Parameters
- Optional reactivityDecorator: (<T>(original: T) => T)
  
  optional function which will apply reactivity to the working copy. The function is expected to take the working copy, wrap it in a reactive proxy and return the wrapper. If specified, it will be invoked with the created working copy and the resulting object will be stored as a working copy. Alternatively the graph itself could allow for setting of a reactivity decorator with the same function
  - - <T>(original: T): T
    - Type Parameters
      
      T extends Subject<T>
      
      Parameters
      
      original: T
      
      Returns T
Returns Subject
Implementation of RemoteDataSpec.workingCopy

Overrides SubjectBase.workingCopy
- Defined in fdr/dataspec.ts:571

Class SubjectImpl

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: SubjectId

graph: LocalGraph

Returns SubjectImpl

Properties

Readonly changes

graph

Readonly id

Protected onPropertyChanged

onReferentsChanged

Protected properties

Protected workingCopies

Accessors

query

Returns { id: undefined; propertyValueIdentifier: { object: Literal | Subject | { id: SubjectId; }; ontologyId: string; predicate: string; subject: { id: SubjectId; }; }; type: string; } | { id: string; propertyValueIdentifier: undefined; type: string; }

ready

Returns boolean

Methods

addPropertyChangedCallback

Parameters

callback: ((key: string) => void)

Parameters

key: string

Returns void

Returns void

addReferentsChangedCallback

Parameters

callback: ((referent: Subject, key: string) => void)

Parameters

referent: Subject

key: string

Returns void

Returns void

apply

Parameters

changes: PropertyChange[]

Returns void

commit

Returns Promise<void>

delete

Parameters

prop: string

Optional lang: any

Rest ...val: Subject[] | LiteralValue[]

Returns Subject

Protected enqueueToChangeBuffer

Parameters

Rest ...change: PropertyChange[]

Returns void

get

Returns

Parameters

prop: string

Optional lang: string

Returns null | Subject | LiteralValue

getAll

Returns

Parameters

prop: string

Optional lang: string

Returns Subject[] | LiteralValue[]

getGraph

Returns Graph

ingest

Parameters

dataset: Dataset<Quad, Quad>

Returns void

Protected notifyGraphAboutPropertyChange

Parameters

changedProperties: string[]

`Readonly` changes

`Readonly` id

`Protected` onPropertyChanged

`Protected` properties

`Protected` workingCopies

Returns {
id: undefined;
propertyValueIdentifier: {
object: Literal | Subject | {
id: SubjectId;
};
ontologyId: string;
predicate: string;
subject: {
id: SubjectId;
};
};
type: string;
} | {
id: string;
propertyValueIdentifier: undefined;
type: string;
}

`Optional` lang: any

`Rest` ...val: Subject[] | LiteralValue[]

`Protected` enqueueToChangeBuffer

`Rest` ...change: PropertyChange[]

`Optional` lang: string

`Optional` lang: string

`Protected` notifyGraphAboutPropertyChange

`Protected` onlyWithLanguage

`Protected` parseLangString

`Optional` lang: string

Returns {
language?: string;
languageIsOptional: boolean;
}

`Optional` language?: string

`Optional` lang: string

`Protected` resolveName

`Optional` lang: string

`Rest` ...object: Subject[] | LiteralValue[]

`Optional` lang: any

`Rest` ...object: Subject[] | LiteralValue[]

`Optional` reactivityDecorator: (<T>(original: T) => T)