Skip to content

Class: SolidLdoDataset

A SolidLdoDataset has all the functionality of an LdoDataset with the added functionality of keeping track of fetched Solid Resources.

It is recommended to use the createSolidLdoDataset to initialize this class

Example

import { createSolidLdoDataset } from "@ldo/solid";
import { ProfileShapeType } from "./.ldo/profile.shapeTypes.ts"

// ...

const solidLdoDataset = createSolidLdoDataset();

const profileDocument = solidLdoDataset
  .getResource("https://example.com/profile");
await profileDocument.read();

const profile = solidLdoDataset
  .using(ProfileShapeType)
  .fromSubject("https://example.com/profile#me");

Hierarchy

  • LdoDataset

↳ SolidLdoDataset

Constructors

constructor

• new SolidLdoDataset(context, datasetFactory, transactionDatasetFactory, initialDataset?): SolidLdoDataset

Parameters

Name Type Description
context SolidLdoDatasetContext SolidLdoDatasetContext
datasetFactory DatasetFactory\<Quad, Quad, Dataset\<Quad, Quad>> An optional dataset factory
transactionDatasetFactory ITransactionDatasetFactory\<Quad> A factory for creating transaction datasets
initialDataset? Dataset\<Quad, Quad> A set of triples to initialize this dataset

Returns

SolidLdoDataset

Overrides

LdoDataset.constructor

Defined in

packages/solid/src/SolidLdoDataset.ts:51

Properties

context

• context: SolidLdoDatasetContext

Defined in

packages/solid/src/SolidLdoDataset.ts:43

dataset

• Protected dataset: DatasetCore\<Quad, Quad>

The main backing dataset

Inherited from

LdoDataset.dataset

Defined in

packages/dataset/src/ExtendedDataset.ts:22

datasetCoreFactory

• Protected datasetCoreFactory: DatasetCoreFactory\<Quad, Quad, DatasetCore\<Quad, Quad>>

A factory that generates datasets for the methods

Inherited from

LdoDataset.datasetCoreFactory

Defined in

packages/dataset/src/ExtendedDataset.ts:27

datasetFactory

• Protected datasetFactory: DatasetFactory\<Quad, Quad, Dataset\<Quad, Quad>>

DatasetFactory for creating new datasets

Inherited from

LdoDataset.datasetFactory

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:31

eventEmitter

• Protected eventEmitter: EventEmitter

The underlying event emitter

Inherited from

LdoDataset.eventEmitter

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:36

transactionDatasetFactory

• Protected transactionDatasetFactory: ITransactionDatasetFactory\<Quad>

The underlying dataset factory for creating transaction datasets

Inherited from

LdoDataset.transactionDatasetFactory

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:40

Accessors

size

• get size(): number

A non-negative integer that specifies the number of quads in the set.

Returns

number

Inherited from

LdoDataset.size

Defined in

packages/dataset/src/ExtendedDataset.ts:355

Methods

[iterator]

▸ [iterator](): Iterator\<Quad, Quad, undefined>

Returns an iterator

Returns

Iterator\<Quad, Quad, undefined>

Inherited from

LdoDataset.[iterator]

Defined in

packages/dataset/src/ExtendedDataset.ts:391

add

▸ add(quad): this

Adds the specified quad to the dataset. Existing quads, as defined in Quad.equals, will be ignored.

Parameters

Name Type
quad Quad

Returns

this

the dataset instance it was called on.

Inherited from

LdoDataset.add

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:141

addAll

▸ addAll(quads): this

Imports the quads into this dataset. This method differs from Dataset.union in that it adds all quads to the current instance, rather than combining quads and the current instance to create a new instance.

Parameters

Name Type
quads Quad[] | Dataset\<Quad, Quad>

Returns

this

the dataset instance it was called on.

Inherited from

LdoDataset.addAll

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:86

addListener

▸ addListener(eventName, listener): this

Alias for emitter.on(eventName, listener).

Parameters

Name Type
eventName QuadMatch
listener nodeEventListener\<Quad>

Returns

this

Inherited from

LdoDataset.addListener

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:248

bulk

▸ bulk(changed): this

Bulk add and remove triples

Parameters

Name Type
changed DatasetChanges\<Quad>

Returns

this

Inherited from

LdoDataset.bulk

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:100

contains

▸ contains(other): boolean

Returns true if the current instance is a superset of the given dataset; differently put: if the given dataset is a subset of, is contained in the current dataset. Blank Nodes will be normalized.

Parameters

Name Type
other Dataset\<Quad, Quad>

Returns

boolean

Inherited from

LdoDataset.contains

Defined in

packages/dataset/src/ExtendedDataset.ts:68

createData

▸ createData\<Type>(shapeType, subject, resource, ...additionalResources): Type

Shorthand for solidLdoDataset .usingType(shapeType) .write(...resources.map((r) => r.uri)) .fromSubject(subject);

Type parameters

Name Type
Type extends LdoBase

Parameters

Name Type Description
shapeType ShapeType\<Type> The shapetype to represent the data
subject string | SubjectNode A subject URI
resource Resource -
...additionalResources Resource[] -

Returns

Type

Defined in

packages/solid/src/SolidLdoDataset.ts:103

delete

▸ delete(quad): this

Removes the specified quad from the dataset. This method returns the dataset instance it was called on.

Parameters

Name Type
quad Quad

Returns

this

Inherited from

LdoDataset.delete

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:154

deleteMatches

▸ deleteMatches(subject?, predicate?, object?, graph?): this

This method removes the quads in the current instance that match the given arguments. The logic described in Quad Matching is applied for each quad in this dataset to select the quads which will be deleted.

Parameters

Name Type
subject? Term
predicate? Term
object? Term
graph? Term

Returns

this

the dataset instance it was called on.

Inherited from

LdoDataset.deleteMatches

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:121

difference

▸ difference(other): Dataset\<Quad, Quad>

Returns a new dataset that contains alls quads from the current dataset, not included in the given dataset.

Parameters

Name Type
other DatasetCore\<Quad, Quad>

Returns

Dataset\<Quad, Quad>

Inherited from

LdoDataset.difference

Defined in

packages/dataset/src/ExtendedDataset.ts:105

emit

▸ emit(eventName, changes): boolean

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Parameters

Name Type
eventName QuadMatch
changes DatasetChanges\<Quad>

Returns

boolean

true if the event had listeners, false otherwise.

Inherited from

LdoDataset.emit

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:262

equals

▸ equals(other): boolean

Returns true if the current instance contains the same graph structure as the given dataset.

Parameters

Name Type
other Dataset\<Quad, Quad>

Returns

boolean

Inherited from

LdoDataset.equals

Defined in

packages/dataset/src/ExtendedDataset.ts:121

eventNames

▸ eventNames(): QuadMatch[]

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

Returns

QuadMatch[]

Inherited from

LdoDataset.eventNames

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:272

every

▸ every(iteratee): boolean

Universal quantification method, tests whether every quad in the dataset passes the test implemented by the provided iteratee. This method immediately returns boolean false once a quad that does not pass the test is found. This method always returns boolean true on an empty dataset. Note: This method is aligned with Array.prototype.every() in ECMAScript-262.

Parameters

Name Type
iteratee (quad: Quad, dataset: this) => boolean

Returns

boolean

Inherited from

LdoDataset.every

Defined in

packages/dataset/src/ExtendedDataset.ts:140

filter

▸ filter(iteratee): Dataset\<Quad, Quad>

Creates a new dataset with all the quads that pass the test implemented by the provided iteratee. Note: This method is aligned with Array.prototype.filter() in ECMAScript-262.

Parameters

Name Type
iteratee (quad: Quad, dataset: this) => boolean

Returns

Dataset\<Quad, Quad>

Inherited from

LdoDataset.filter

Defined in

packages/dataset/src/ExtendedDataset.ts:154

forEach

▸ forEach(iteratee): void

Executes the provided iteratee once on each quad in the dataset. Note: This method is aligned with Array.prototype.forEach() in ECMAScript-262.

Parameters

Name Type
iteratee (quad: Quad, dataset: this) => void

Returns

void

Inherited from

LdoDataset.forEach

Defined in

packages/dataset/src/ExtendedDataset.ts:171

getMaxListeners

▸ getMaxListeners(): number

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

Returns

number

Inherited from

LdoDataset.getMaxListeners

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:281

getResource

▸ getResource(uri, options?): Container

Retireves a representation (either a LeafResource or a ContainerResource) of a Solid Resource at the given URI. This resource represents the current state of the resource: whether it is currently fetched or in the process of fetching as well as some information about it.

Parameters

Name Type Description
uri ContainerUri the URI of the resource
options? ResourceGetterOptions Special options for getting the resource

Returns

Container

a Leaf or Container Resource

Example

const profileDocument = solidLdoDataset
  .getResource("https://example.com/profile");

Defined in

packages/solid/src/SolidLdoDataset.ts:78

▸ getResource(uri, options?): Leaf

Parameters

Name Type
uri LeafUri
options? ResourceGetterOptions

Returns

Leaf

Defined in

packages/solid/src/SolidLdoDataset.ts:79

▸ getResource(uri, options?): Leaf | Container

Parameters

Name Type
uri string
options? ResourceGetterOptions

Returns

Leaf | Container

Defined in

packages/solid/src/SolidLdoDataset.ts:80

has

▸ has(quad): boolean

Determines whether a dataset includes a certain quad, returning true or false as appropriate.

Parameters

Name Type
quad Quad

Returns

boolean

Inherited from

LdoDataset.has

Defined in

packages/dataset/src/ExtendedDataset.ts:384

import

▸ import(stream): Promise\<SolidLdoDataset>

Imports all quads from the given stream into the dataset. The stream events end and error are wrapped in a Promise.

Parameters

Name Type
stream Stream\<Quad>

Returns

Promise\<SolidLdoDataset>

Inherited from

LdoDataset.import

Defined in

packages/dataset/src/ExtendedDataset.ts:182

intersection

▸ intersection(other): Dataset\<Quad, Quad>

Returns a new dataset containing alls quads from the current dataset that are also included in the given dataset.

Parameters

Name Type
other Dataset\<Quad, Quad>

Returns

Dataset\<Quad, Quad>

Inherited from

LdoDataset.intersection

Defined in

packages/dataset/src/ExtendedDataset.ts:199

listenerCount

▸ listenerCount(eventName): number

Returns the number of listeners listening to the event named eventName.

Parameters

Name Type
eventName QuadMatch

Returns

number

Inherited from

LdoDataset.listenerCount

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:288

listeners

▸ listeners(eventName): nodeEventListener\<Quad>[]

Returns a copy of the array of listeners for the event named eventName.

Parameters

Name Type
eventName QuadMatch

Returns

nodeEventListener\<Quad>[]

Inherited from

LdoDataset.listeners

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:295

map

▸ map(iteratee): Dataset\<Quad, Quad>

Returns a new dataset containing all quads returned by applying iteratee to each quad in the current dataset.

Parameters

Name Type
iteratee (quad: Quad, dataset: this) => Quad

Returns

Dataset\<Quad, Quad>

Inherited from

LdoDataset.map

Defined in

packages/dataset/src/ExtendedDataset.ts:217

match

▸ match(subject?, predicate?, object?, graph?): Dataset\<Quad, Quad>

This method returns a new dataset that is comprised of all quads in the current instance matching the given arguments. The logic described in Quad Matching is applied for each quad in this dataset to check if it should be included in the output dataset.

Parameters

Name Type
subject? null | Term
predicate? null | Term
object? null | Term
graph? null | Term

Returns

Dataset\<Quad, Quad>

a Dataset with matching triples

Inherited from

LdoDataset.match

Defined in

packages/dataset/src/ExtendedDataset.ts:340

off

▸ off(eventName, listener): void

Alias for emitter.removeListener()

Parameters

Name Type
eventName QuadMatch
listener nodeEventListener\<Quad>

Returns

void

Inherited from

LdoDataset.off

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:304

on

▸ on(eventName, listener): this

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

Parameters

Name Type
eventName QuadMatch
listener nodeEventListener\<Quad>

Returns

this

Inherited from

LdoDataset.on

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:314

once

▸ once(eventName, listener): this

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Parameters

Name Type
eventName QuadMatch
listener nodeEventListener\<Quad>

Returns

this

Inherited from

LdoDataset.once

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:330

prependListener

▸ prependListener(eventName, listener): this

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

Parameters

Name Type
eventName QuadMatch
listener nodeEventListener\<Quad>

Returns

this

Inherited from

LdoDataset.prependListener

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:341

prependOnceListener

▸ prependOnceListener(eventName, listener): this

Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

Parameters

Name Type
eventName QuadMatch
listener nodeEventListener\<Quad>

Returns

this

Inherited from

LdoDataset.prependOnceListener

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:352

rawListeners

▸ rawListeners(eventName): nodeEventListener\<Quad>[]

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

Parameters

Name Type
eventName QuadMatch

Returns

nodeEventListener\<Quad>[]

Inherited from

LdoDataset.rawListeners

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:406

reduce

▸ reduce\<A>(iteratee, initialValue?): A

This method calls the iteratee on each quad of the DatasetCore. The first time the iteratee is called, the accumulator value is the initialValue or, if not given, equals to the first quad of the Dataset. The return value of the iteratee is used as accumulator value for the next calls. This method returns the return value of the last iteratee call. Note: This method is aligned with Array.prototype.reduce() in ECMAScript-262.

Type parameters

Name Type
A unknown

Parameters

Name Type
iteratee (accumulator: A, quad: Quad, dataset: this) => A
initialValue? A

Returns

A

Inherited from

LdoDataset.reduce

Defined in

packages/dataset/src/ExtendedDataset.ts:234

removeAllListeners

▸ removeAllListeners(eventName): this

Removes all listeners, or those of the specified eventName.

Parameters

Name Type
eventName QuadMatch

Returns

this

Inherited from

LdoDataset.removeAllListeners

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:366

removeListener

▸ removeListener(eventName, listener): this

Removes the specified listener from the listener array for the event named eventName.

Parameters

Name Type
eventName QuadMatch
listener nodeEventListener\<Quad>

Returns

this

Inherited from

LdoDataset.removeListener

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:374

removeListenerFromAllEvents

▸ removeListenerFromAllEvents(listener): this

Removes the specified listener from the listener array for the event named eventName.

Parameters

Name Type
listener nodeEventListener\<Quad>

Returns

this

Inherited from

LdoDataset.removeListenerFromAllEvents

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:385

setMaxListeners

▸ setMaxListeners(n): this

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Parameters

Name Type
n number

Returns

this

Inherited from

LdoDataset.setMaxListeners

Defined in

packages/subscribable-dataset/src/SubscribableDataset.ts:398

some

▸ some(iteratee): boolean

Existential quantification method, tests whether some quads in the dataset pass the test implemented by the provided iteratee. Note: This method is aligned with Array.prototype.some() in ECMAScript-262.

Parameters

Name Type
iteratee (quad: Quad, dataset: this) => boolean

Returns

boolean

boolean true once a quad that passes the test is found.

Inherited from

LdoDataset.some

Defined in

packages/dataset/src/ExtendedDataset.ts:259

startTransaction

▸ startTransaction(): SolidLdoTransactionDataset

Returns

SolidLdoTransactionDataset

Overrides

LdoDataset.startTransaction

Defined in

packages/solid/src/SolidLdoDataset.ts:85

toArray

▸ toArray(): Quad[]

Returns the set of quads within the dataset as a host language native sequence, for example an Array in ECMAScript-262. Note: Since a DatasetCore is an unordered set, the order of the quads within the returned sequence is arbitrary.

Returns

Quad[]

Inherited from

LdoDataset.toArray

Defined in

packages/dataset/src/ExtendedDataset.ts:272

toCanonical

▸ toCanonical(): string

Returns an N-Quads string representation of the dataset, preprocessed with RDF Dataset Normalization algorithm.

Returns

string

Inherited from

LdoDataset.toCanonical

Defined in

packages/dataset/src/ExtendedDataset.ts:283

toStream

▸ toStream(): Stream\<Quad>

Returns a stream that contains all quads of the dataset.

Returns

Stream\<Quad>

Inherited from

LdoDataset.toStream

Defined in

packages/dataset/src/ExtendedDataset.ts:290

toString

▸ toString(): string

Returns an N-Quads string representation of the dataset. No prior normalization is required, therefore the results for the same quads may vary depending on the Dataset implementation.

Returns

string

Inherited from

LdoDataset.toString

Defined in

packages/dataset/src/ExtendedDataset.ts:311

union

▸ union(other): Dataset\<Quad, Quad>

Returns a new Dataset that is a concatenation of this dataset and the quads given as an argument.

Parameters

Name Type
other Dataset\<Quad, Quad>

Returns

Dataset\<Quad, Quad>

Inherited from

LdoDataset.union

Defined in

packages/dataset/src/ExtendedDataset.ts:319

usingType

▸ usingType\<Type>(shapeType): LdoBuilder\<Type>

Creates an LdoBuilder for a given shapeType

Type parameters

Name Type
Type extends LdoBase

Parameters

Name Type Description
shapeType ShapeType\<Type> A ShapeType

Returns

LdoBuilder\<Type>

A builder for the given type

Inherited from

LdoDataset.usingType

Defined in

packages/ldo/src/LdoDataset.ts:37