Class: RdfDataProvider

Defined in: src/data/rdf/rdfDataProvider.ts:92

Provides graph data from in-memory RDF/JS-compatible graph dataset.

Implements

• DataProvider

Constructors

Constructor

new RdfDataProvider(options): RdfDataProvider

Defined in: src/data/rdf/rdfDataProvider.ts:108

Parameters

Parameter	Type
options	RdfDataProviderOptions

Returns

RdfDataProvider

Properties

Property	Modifier	Type	Description
factory	readonly	DataFactory	Returns an RDF term factory to create RDF terms for identifiers and property values.

Methods

addGraph()

addGraph(quads): void

Defined in: src/data/rdf/rdfDataProvider.ts:135

Adds RDF/JS-compatible graph in a form of quads (triplets) to be able to query it via this provider's methods.

Parameters

Parameter	Type
quads	Iterable<Quad>

Returns

void

---

clear()

clear(): void

Defined in: src/data/rdf/rdfDataProvider.ts:154

Removes all previously added graphs to this provider so it becomes empty.

Returns

void

---

connectedLinkStats()

connectedLinkStats(params): Promise<DataProviderLinkCount[]>

Defined in: src/data/rdf/rdfDataProvider.ts:395

Gets connected link types of an element for exploration.

Parameters

Parameter	Type
params	{ elementId: ElementIri; inexactCount?: boolean; signal?: AbortSignal; }
params.elementId	ElementIri
params.inexactCount?	boolean
params.signal?	AbortSignal

Returns

Promise<DataProviderLinkCount[]>

Implementation of

DataProvider.connectedLinkStats

---

decodeTerm()

decodeTerm(iri): BlankNode | NamedNode<string>

Defined in: src/data/rdf/rdfDataProvider.ts:176

Decodes a previously encoded by RdfDataProvider.encodeTerm resource-like term (named node or blank) back from a plain string.

Parameters

Parameter	Type
iri	ElementIri | ElementTypeIri | LinkTypeIri | PropertyTypeIri

Returns

BlankNode | NamedNode<string>

See

RdfDataProvider.encodeTerm

---

elements()

elements(params): Promise<Map<ElementIri, ElementModel>>

Defined in: src/data/rdf/rdfDataProvider.ts:331

Gets the data for the specified elements.

Parameters

Parameter	Type
params	{ elementIds: readonly ElementIri[]; signal?: AbortSignal; }
params.elementIds	readonly ElementIri[]
params.signal?	AbortSignal

Returns

Promise<Map<ElementIri, ElementModel>>

Implementation of

DataProvider.elements

---

elementTypes()

elementTypes(params): Promise<Map<ElementTypeIri, ElementTypeModel>>

Defined in: src/data/rdf/rdfDataProvider.ts:267

Gets the data for the specified element types.

Parameters

Parameter	Type
params	{ classIds: readonly ElementTypeIri[]; signal?: AbortSignal; }
params.classIds	readonly ElementTypeIri[]
params.signal?	AbortSignal

Returns

Promise<Map<ElementTypeIri, ElementTypeModel>>

Implementation of

DataProvider.elementTypes

---

encodeTerm()

encodeTerm(term): string

Defined in: src/data/rdf/rdfDataProvider.ts:166

Encodes RDF/JS-compatible resource-like term (named node or blank) into a plain string:

• IRI (named node) value is returned as-is;
• blank node is value is prepended with a prefix urn:reactodia:blank:rdf:.

Parameters

Parameter	Type
term	BlankNode | NamedNode<string>

Returns

string

See

RdfDataProvider.decodeTerm

---

knownElementTypes()

knownElementTypes(params): Promise<ElementTypeGraph>

Defined in: src/data/rdf/rdfDataProvider.ts:182

Gets the structure and data for all known element types.

Parameters

Parameter	Type
params	{ signal?: AbortSignal; }
params.signal?	AbortSignal

Returns

Promise<ElementTypeGraph>

Implementation of

DataProvider.knownElementTypes

---

knownLinkTypes()

knownLinkTypes(params): Promise<LinkTypeModel[]>

Defined in: src/data/rdf/rdfDataProvider.ts:239

Gets the data and statistics for all known link types.

Parameters

Parameter	Type
params	{ signal?: AbortSignal; }
params.signal?	AbortSignal

Returns

Promise<LinkTypeModel[]>

Implementation of

DataProvider.knownLinkTypes

---

links()

links(params): Promise<LinkModel[]>

Defined in: src/data/rdf/rdfDataProvider.ts:351

Get all links between two specified sets of entities (bipartite graph links).

To get all links between all entities in the set, it is possible to pass the same set to both primary and secondary sets of elements.

Parameters

Parameter	Type
params	{ linkTypeIds?: readonly LinkTypeIri[]; primary: readonly ElementIri[]; secondary: readonly ElementIri[]; signal?: AbortSignal; }
params.linkTypeIds?	readonly LinkTypeIri[]
params.primary	readonly ElementIri[]
params.secondary	readonly ElementIri[]
params.signal?	AbortSignal

Returns

Promise<LinkModel[]>

Implementation of

DataProvider.links

---

linkTypes()

linkTypes(params): Promise<Map<LinkTypeIri, LinkTypeModel>>

Defined in: src/data/rdf/rdfDataProvider.ts:310

Gets the data for the specified link types.

Parameters

Parameter	Type
params	{ linkTypeIds: readonly LinkTypeIri[]; signal?: AbortSignal; }
params.linkTypeIds	readonly LinkTypeIri[]
params.signal?	AbortSignal

Returns

Promise<Map<LinkTypeIri, LinkTypeModel>>

Implementation of

DataProvider.linkTypes

---

lookup()

lookup(params): Promise<DataProviderLookupItem[]>

Defined in: src/data/rdf/rdfDataProvider.ts:440

Looks up elements with different filters:

• by an element type via elementTypeId;
• by a connected element via refElementId, refElementLinkId and linkDirection;
• by a text lookup via text;

Filters can be combined to produce an intersection of the results.

Parameters

Parameter	Type
params	DataProviderLookupParams

Returns

Promise<DataProviderLookupItem[]>

Implementation of

DataProvider.lookup

---

propertyTypes()

propertyTypes(params): Promise<Map<PropertyTypeIri, PropertyTypeModel>>

Defined in: src/data/rdf/rdfDataProvider.ts:291

Gets the data for the specified property types.

Parameters

Parameter	Type
params	{ propertyIds: readonly PropertyTypeIri[]; signal?: AbortSignal; }
params.propertyIds	readonly PropertyTypeIri[]
params.signal?	AbortSignal

Returns

Promise<Map<PropertyTypeIri, PropertyTypeModel>>

Implementation of

DataProvider.propertyTypes