Class: CompositeDataProvider

Defined in: data/composite/composite.ts:55

Provides graph data by combining results from multiple other data providers.

Implements

• DataProvider

Constructors

Constructor

new CompositeDataProvider(options): CompositeDataProvider

Defined in: data/composite/composite.ts:58

Parameters

Parameter	Type
options	CompositeDataProviderOptions

Returns

CompositeDataProvider

Properties

Property	Modifier	Type
providers	readonly	readonly DataProviderDefinition[]

Accessors

factory

Get Signature

get factory(): DataFactory

Defined in: data/composite/composite.ts:63

Returns an RDF term factory to create RDF terms for identifiers and property values.

Returns

DataFactory

Returns an RDF term factory to create RDF terms for identifiers and property values.

Implementation of

DataProvider.factory

Methods

connectedLinkStats()

connectedLinkStats(params): Promise<DataProviderLinkCount[]>

Defined in: data/composite/composite.ts:131

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

---

elements()

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

Defined in: data/composite/composite.ts:115

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: data/composite/composite.ts:94

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

---

knownElementTypes()

knownElementTypes(params): Promise<ElementTypeGraph>

Defined in: data/composite/composite.ts:82

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: data/composite/composite.ts:88

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: data/composite/composite.ts:122

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: data/composite/composite.ts:108

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: data/composite/composite.ts:139

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: data/composite/composite.ts:101

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

---

requestWithMerge()

requestWithMerge<R>(method, merge): Promise<R>

Defined in: data/composite/composite.ts:71

Type Parameters

Type Parameter
R

Parameters

Parameter	Type
method	(provider) => Promise<R>
merge	(results) => R

Returns

Promise<R>