Class ActorRdfMetadataExtractShapetrees

A comunica Shapetrees RDF Metadata Extract Actor.

Hierarchy

ActorRdfMetadataExtract
- ActorRdfMetadataExtractShapetrees

Constructors

constructor

new ActorRdfMetadataExtractShapetrees(
args: IActorRdfMetadataExtractShapetreesArgs,
): ActorRdfMetadataExtractShapetrees
Parameters
- args: IActorRdfMetadataExtractShapetreesArgs
Returns ActorRdfMetadataExtractShapetrees
Overrides ActorRdfMetadataExtract.constructor
- Defined in packages/actor-rdf-metadata-extract-shapetrees/lib/ActorRdfMetadataExtractShapetrees.ts:35

Properties

`Readonly`beforeActors

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

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

`Readonly`bus

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

The bus this actor subscribes to.

`Readonly`mediatorDereferenceRdf

mediatorDereferenceRdf: MediatorDereferenceRdf

`Readonly`mediatorHttp

mediatorHttp: MediatorHttp

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly`queryEngine

queryEngine: QueryEngineBase

`Static` `Readonly`IRI_SHAPETREE

IRI_SHAPETREE: "http://www.w3.org/ns/shapetrees#ShapeTreeLocator" = 'http://www.w3.org/ns/shapetrees#ShapeTreeLocator'

`Static` `Readonly`IRI_SHAPETREE_OLD

IRI_SHAPETREE_OLD: "http://shapetrees.org/#ShapeTree" = 'http://shapetrees.org/#ShapeTree'

Methods

dereferenceShape

dereferenceShape(shapeIri: string, _context: IActionContext): Promise<Shape>
Dereference a shape
Parameters
- shapeIri: string
  The URL of a shape definition.
- _context: IActionContext
  An action context.
Returns Promise<Shape>
- Defined in packages/actor-rdf-metadata-extract-shapetrees/lib/ActorRdfMetadataExtractShapetrees.ts:191

dereferenceShapeTrees

dereferenceShapeTrees(
    shapeTreeReference: string,
    baseUrl: string,
    context: IActionContext,
): Promise<ShapeTree[]>
Dereference the given shape tree.
Parameters
- shapeTreeReference: string
  A shape tree URL.
- baseUrl: string
  The base URL for URI templates.
- context: IActionContext
  An action context.
Returns Promise<ShapeTree[]>
- Defined in packages/actor-rdf-metadata-extract-shapetrees/lib/ActorRdfMetadataExtractShapetrees.ts:139

discoverShapeTreeLocator

discoverShapeTreeLocator(headers?: Headers): undefined | string
Extracts the shape tree locator URL from the headers
Parameters
- Optionalheaders: Headers
  A headers record object
Returns undefined | string
- Defined in packages/actor-rdf-metadata-extract-shapetrees/lib/ActorRdfMetadataExtractShapetrees.ts:87

fetchShapeTreesLocatorShapeTrees

fetchShapeTreesLocatorShapeTrees(
shapeTreeLocatorUrl: string,
context: IActionContext,
): Promise<string[]>
Fetch all shapetrees identified by the given shape tree locator.
Parameters
- shapeTreeLocatorUrl: string
  A shape tree locator URL.
- context: IActionContext
  An action context.
Returns Promise<string[]>
- Defined in packages/actor-rdf-metadata-extract-shapetrees/lib/ActorRdfMetadataExtractShapetrees.ts:112

`Protected`getDefaultLogData

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

`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 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 ActorRdfMetadataExtract.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 ActorRdfMetadataExtract.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 ActorRdfMetadataExtract.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 ActorRdfMetadataExtract.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 ActorRdfMetadataExtract.logWarn
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:73

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 packages/actor-rdf-metadata-extract-shapetrees/lib/ActorRdfMetadataExtractShapetrees.ts:50

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 node_modules/@comunica/core/lib/Actor.d.ts:68

shapeTreeMatchesQuery

shapeTreeMatchesQuery(
    shapeTree: ShapeTree,
    query: Operation,
    pattern: Pattern,
): boolean
Check if the given shape tree matches with the current pattern in the global query.
Parameters
- shapeTree: ShapeTree
  A shape tree to match with the query and pattern.
- query: Operation
  The original query that is being executed.
- pattern: Pattern
  The current pattern that is being evaluated and traversed in.
Returns boolean
- Defined in packages/actor-rdf-metadata-extract-shapetrees/lib/ActorRdfMetadataExtractShapetrees.ts:233

test

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

`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 node_modules/@comunica/core/lib/Actor.d.ts:42

Class ActorRdfMetadataExtractShapetrees

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorRdfMetadataExtractShapetrees

Properties

ReadonlybeforeActors

Readonlybus

ReadonlymediatorDereferenceRdf

ReadonlymediatorHttp

Readonlyname

Default

ReadonlyqueryEngine

Static ReadonlyIRI_SHAPETREE

Static ReadonlyIRI_SHAPETREE_OLD

Methods

dereferenceShape

Parameters

Returns Promise<Shape>

dereferenceShapeTrees

Parameters

Returns Promise<ShapeTree[]>

discoverShapeTreeLocator

Parameters

Returns undefined | string

fetchShapeTreesLocatorShapeTrees

Parameters

Returns Promise<string[]>

ProtectedgetDefaultLogData

Parameters

Returns any

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>

shapeTreeMatchesQuery

Parameters

Returns boolean

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`mediatorDereferenceRdf

`Readonly`mediatorHttp

`Readonly`name

`Readonly`queryEngine

`Static` `Readonly`IRI_SHAPETREE

`Static` `Readonly`IRI_SHAPETREE_OLD

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger