Class ActorExtractLinksSolidTypeIndex

A comunica Solid Type Index Extract Links Actor.

Hierarchy (View Summary)

ActorExtractLinks
- ActorExtractLinksSolidTypeIndex

Constructors

constructor

new ActorExtractLinksSolidTypeIndex(
args: IActorExtractLinksSolidTypeIndexArgs,
): ActorExtractLinksSolidTypeIndex
Parameters
- args: IActorExtractLinksSolidTypeIndexArgs
Returns ActorExtractLinksSolidTypeIndex
Overrides ActorExtractLinks.constructor
- Defined in packages/actor-extract-links-solid-type-index/lib/ActorExtractLinksSolidTypeIndex.ts:29

Properties

`Readonly`beforeActors

beforeActors: Actor<IActionExtractLinks, IActorTest, IActorExtractLinksOutput>[]

Actor that must be registered in the bus before this actor.

`Readonly`bus

bus: Bus<
    Actor<IActionExtractLinks, IActorTest, IActorExtractLinksOutput>,
    IActionExtractLinks,
    IActorTest,
    IActorExtractLinksOutput,
>

The bus this actor subscribes to.

`Readonly`mediatorDereferenceRdf

mediatorDereferenceRdf: MediatorDereferenceRdf

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly`queryEngine

queryEngine: QueryEngineBase

`Static` `Readonly`RDF_TYPE

RDF_TYPE: "http://www.w3.org/1999/02/22-rdf-syntax-ns#type" = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#type'

Methods

dereferenceTypeIndex

dereferenceTypeIndex(
typeIndex: string,
context: IActionContext,
): Promise<Record<string, ILink[]>>
Determine all entries within the given type index.
Parameters
- typeIndex: string
  The URL of a type index.
- context: IActionContext
  The context.
Returns Promise<Record<string, ILink[]>>
typeLinks A record mapping class URLs to an array of links.
- Defined in packages/actor-extract-links-solid-type-index/lib/ActorExtractLinksSolidTypeIndex.ts:114

extractTypeIndexLinks

extractTypeIndexLinks(metadata: Stream): Promise<Set<string>>
Extract links to type index from the metadata stream.
Parameters
- metadata: Stream
  A metadata quad stream.
Returns Promise<Set<string>>
- Defined in packages/actor-extract-links-solid-type-index/lib/ActorExtractLinksSolidTypeIndex.ts:87

fetchPredicateDomains

fetchPredicateDomains(predicateValue: string): Promise<string[]>
To fetch the rdf type from the vocabulary if the type is not already present.
Parameters
- predicateValue: string
  Predicate value from the query.
Returns Promise<string[]>
predicateTypeLinks A record mapping predicate URIs to it's domain.
- Defined in packages/actor-extract-links-solid-type-index/lib/ActorExtractLinksSolidTypeIndex.ts:183

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorExtractLinks.getDefaultLogData
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:69

getLinksMatchingQuery

getLinksMatchingQuery(
typeLinks: Record<string, ILink[]>,
query: Operation,
): Promise<ILink[]>
Determine all links that match with the current query pattern.
Parameters
- typeLinks: Record<string, ILink[]>
  The type index links.
- query: Operation
  The original query that is being executed.
Returns Promise<ILink[]>
- Defined in packages/actor-extract-links-solid-type-index/lib/ActorExtractLinksSolidTypeIndex.ts:209

linkPredicateDomains

linkPredicateDomains(
predicateSubjects: Record<string, Term>,
typeSubjects: Record<string, Term[]>,
): Promise<void>
To fetch the domain of the predicate.
Parameters
- predicateSubjects: Record<string, Term>
  A dictionary of predicate and its subjects from the query.
- typeSubjects: Record<string, Term[]>
  A dictionary of class type and its subjects from the query.
Returns Promise<void>
- Defined in packages/actor-extract-links-solid-type-index/lib/ActorExtractLinksSolidTypeIndex.ts:156

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logDebug
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:71

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logError
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:74

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logFatal
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:75

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logInfo
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:72

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logTrace
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:70

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorExtractLinks.logWarn
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:73

run

run(action: IActionExtractLinks): Promise<IActorExtractLinksOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionExtractLinks
  The action to run.
Returns Promise<IActorExtractLinksOutput>
A promise that resolves to the run result.
Overrides ActorExtractLinks.run
- Defined in packages/actor-extract-links-solid-type-index/lib/ActorExtractLinksSolidTypeIndex.ts:41

runObservable

runObservable(
action: IActionExtractLinks,
sideData: undefined,
): Promise<IActorExtractLinksOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionExtractLinks
  The action to run.
- sideData: undefined
Returns Promise<IActorExtractLinksOutput>
A promise that resolves to the run result.
Inherited from ActorExtractLinks.runObservable
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:68

test

test(action: IActionExtractLinks): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionExtractLinks
  The action to test.
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorExtractLinks.test
- Defined in packages/actor-extract-links-solid-type-index/lib/ActorExtractLinksSolidTypeIndex.ts:34

`Static`collectStream

collectStream(
metadata: Stream,
onQuad: (quad: Quad, links: ILink[]) => void,
): Promise<ILink[]>
A helper function to append links based on incoming quads.
Parameters
- metadata: Stream
  A metadata stream of quads.
- onQuad: (quad: Quad, links: ILink[]) => void
  A callback that will be invoked for each quad in the metadata stream. The second argument is the array of links that can be appended to.
Returns Promise<ILink[]>
Inherited from ActorExtractLinks.collectStream
- Defined in packages/bus-extract-links/lib/ActorExtractLinks.ts:32

`Static`getContextLogger

getContextLogger(context: IActionContext): undefined | Logger
Get the logger from the given context.
Parameters
- context: IActionContext
  An optional context.
Returns undefined | Logger
The logger or undefined.
Inherited from ActorExtractLinks.getContextLogger
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:42

Class ActorExtractLinksSolidTypeIndex

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorExtractLinksSolidTypeIndex

Properties

ReadonlybeforeActors

Readonlybus

ReadonlymediatorDereferenceRdf

Readonlyname

Default

ReadonlyqueryEngine

Static ReadonlyRDF_TYPE

Methods

dereferenceTypeIndex

Parameters

Returns Promise<Record<string, ILink[]>>

extractTypeIndexLinks

Parameters

Returns Promise<Set<string>>

fetchPredicateDomains

Parameters

Returns Promise<string[]>

ProtectedgetDefaultLogData

Parameters

Returns any

getLinksMatchingQuery

Parameters

Returns Promise<ILink[]>

linkPredicateDomains

Parameters

Returns Promise<void>

ProtectedlogDebug

Parameters

Returns void

ProtectedlogError

Parameters

Returns void

ProtectedlogFatal

Parameters

Returns void

ProtectedlogInfo

Parameters

Returns void

ProtectedlogTrace

Parameters

Returns void

ProtectedlogWarn

Parameters

Returns void

run

Parameters

Returns Promise<IActorExtractLinksOutput>

runObservable

Parameters

Returns Promise<IActorExtractLinksOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticcollectStream

Parameters

Returns Promise<ILink[]>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`mediatorDereferenceRdf

`Readonly`name

`Readonly`queryEngine

`Static` `Readonly`RDF_TYPE

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`collectStream

`Static`getContextLogger