Class ActorRdfMetadataExtractVoid

A comunica Void RDF Metadata Extract Actor.

Hierarchy (View Summary)

ActorRdfMetadataExtract
- ActorRdfMetadataExtractVoid

Index

Constructors

constructor

new ActorRdfMetadataExtractVoid(
args: IActorRdfMetadataExtractVoidArgs,
): ActorRdfMetadataExtractVoid
Parameters
- args: IActorRdfMetadataExtractVoidArgs
Returns ActorRdfMetadataExtractVoid
Overrides ActorRdfMetadataExtract.constructor
- Defined in actor-rdf-metadata-extract-void/lib/ActorRdfMetadataExtractVoid.ts:27

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionRdfMetadataExtract,
    IActorTest,
    IActorRdfMetadataExtractOutput,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionRdfMetadataExtract,
        IActorTest,
        IActorRdfMetadataExtractOutput,
        undefined,
    >,
    IActionRdfMetadataExtract,
    IActorTest,
    IActorRdfMetadataExtractOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Static` `Readonly`SPARQL_SD

SPARQL_SD: "http://www.w3.org/ns/sparql-service-description#" = 'http://www.w3.org/ns/sparql-service-description#'

`Static` `Readonly`VOID

VOID: "http://rdfs.org/ns/void#" = 'http://rdfs.org/ns/void#'

Methods

collectFromMetadata

collectFromMetadata(stream: Stream<Quad>): Promise<Store<Quad>>
Collect all the VoID-related quads from the metadata stream. The purpose of this is to avoid storing unrelated data present in the metadata stream.
Parameters
- stream: Stream<Quad>
  The metadata Quad stream.
Returns Promise<Store<Quad>>
An RDF/JS in-memory store containing all the VoID-related quads.
- Defined in actor-rdf-metadata-extract-void/lib/ActorRdfMetadataExtractVoid.ts:50

getDatasets

getDatasets(store: Store<Quad>, source: string): Promise<IDataset[]>
Parameters
- store: Store<Quad>
- source: string
Returns Promise<IDataset[]>
- Defined in actor-rdf-metadata-extract-void/lib/ActorRdfMetadataExtractVoid.ts:69

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorRdfMetadataExtract.getDefaultLogData
- Defined in core/lib/Actor.ts:95

getVocabularies

getVocabularies(
store: Store<Quad>,
identifier: NamedNode<string> | BlankNode,
): Promise<undefined | string[]>
Parameters
- store: Store<Quad>
- identifier: NamedNode<string> | BlankNode
Returns Promise<undefined | string[]>
- Defined in actor-rdf-metadata-extract-void/lib/ActorRdfMetadataExtractVoid.ts:128

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logDebug
- Defined in core/lib/Actor.ts:108

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logError
- Defined in core/lib/Actor.ts:129

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logFatal
- Defined in core/lib/Actor.ts:136

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logInfo
- Defined in core/lib/Actor.ts:115

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logTrace
- Defined in core/lib/Actor.ts:101

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logWarn
- Defined in core/lib/Actor.ts:122

run

run(action: IActionRdfMetadataExtract): Promise<IActorRdfMetadataExtractOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionRdfMetadataExtract
  The action to run.
Returns Promise<IActorRdfMetadataExtractOutput>
A promise that resolves to the run result.
Overrides ActorRdfMetadataExtract.run
- Defined in actor-rdf-metadata-extract-void/lib/ActorRdfMetadataExtractVoid.ts:37

runObservable

runObservable(
action: IActionRdfMetadataExtract,
sideData: undefined,
): Promise<IActorRdfMetadataExtractOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionRdfMetadataExtract
  The action to run.
- sideData: undefined
Returns Promise<IActorRdfMetadataExtractOutput>
A promise that resolves to the run result.
Inherited from ActorRdfMetadataExtract.runObservable
- Defined in core/lib/Actor.ts:87

test

test(_action: IActionRdfMetadataExtract): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionRdfMetadataExtract
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorRdfMetadataExtract.test
- Defined in actor-rdf-metadata-extract-void/lib/ActorRdfMetadataExtractVoid.ts:33

`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 ActorRdfMetadataExtract.getContextLogger
- Defined in core/lib/Actor.ts:56

Class ActorRdfMetadataExtractVoid

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorRdfMetadataExtractVoid

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

Static ReadonlySPARQL_SD

Static ReadonlyVOID

Methods

collectFromMetadata

Parameters

Returns Promise<Store<Quad>>

getDatasets

Parameters

Returns Promise<IDataset[]>

ProtectedgetDefaultLogData

Parameters

Returns any

getVocabularies

Parameters

Returns Promise<undefined | string[]>

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<IActorRdfMetadataExtractOutput>

runObservable

Parameters

Returns Promise<IActorRdfMetadataExtractOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Static` `Readonly`SPARQL_SD

`Static` `Readonly`VOID

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger