Class ActorQuerySourceIdentifyHypermediaQpf

A comunica QPF Query Source Identify Hypermedia Actor.

Hierarchy (View Summary)

ActorQuerySourceIdentifyHypermedia
- ActorQuerySourceIdentifyHypermediaQpf

Implements

IActorQuerySourceIdentifyHypermediaQpfArgs

Constructors

constructor

new ActorQuerySourceIdentifyHypermediaQpf(
args: IActorQuerySourceIdentifyHypermediaQpfArgs,
): ActorQuerySourceIdentifyHypermediaQpf
Parameters
- args: IActorQuerySourceIdentifyHypermediaQpfArgs
Returns ActorQuerySourceIdentifyHypermediaQpf
Overrides ActorQuerySourceIdentifyHypermedia.constructor
- Defined in actor-query-source-identify-hypermedia-qpf/lib/ActorQuerySourceIdentifyHypermediaQpf.ts:36

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionQuerySourceIdentifyHypermedia,
    IActorQuerySourceIdentifyHypermediaTest,
    IActorQuerySourceIdentifyHypermediaOutput,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionQuerySourceIdentifyHypermedia,
        IActorQuerySourceIdentifyHypermediaTest,
        IActorQuerySourceIdentifyHypermediaOutput,
        undefined,
    >,
    IActionQuerySourceIdentifyHypermedia,
    IActorQuerySourceIdentifyHypermediaTest,
    IActorQuerySourceIdentifyHypermediaOutput,
    undefined,
>

The bus this actor subscribes to.

`Optional` `Readonly`graphUri

graphUri?: string

The URI that should be interpreted as graph URI

Default

{http://www.w3.org/ns/sparql-service-description#graph}

`Readonly`mediatorDereferenceRdf

mediatorDereferenceRdf: MediatorDereferenceRdf

The RDF dereference mediator

`Readonly`mediatorMergeBindingsContext

mediatorMergeBindingsContext: MediatorMergeBindingsContext

A mediator for creating binding context merge handlers

`Readonly`mediatorMetadata

mediatorMetadata: MediatorRdfMetadata

The metadata mediator

`Readonly`mediatorMetadataExtract

mediatorMetadataExtract: MediatorRdfMetadataExtract

The metadata extract mediator

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly`objectUri

objectUri: string

The URI that should be interpreted as object URI

Default

{http://www.w3.org/1999/02/22-rdf-syntax-ns#object}

`Readonly`predicateUri

predicateUri: string

The URI that should be interpreted as predicate URI

Default

{http://www.w3.org/1999/02/22-rdf-syntax-ns#predicate}

`Protected` `Readonly`sourceType

sourceType: string

`Readonly`subjectUri

subjectUri: string

The URI that should be interpreted as subject URI

Default

{http://www.w3.org/1999/02/22-rdf-syntax-ns#subject}

Methods

`Protected`createSource

createSource(
    url: string,
    metadata: Record<string, any>,
    context: IActionContext,
    bindingsRestricted: boolean,
    quads?: Stream<Quad>,
): Promise<QuerySourceQpf>
Parameters
- url: string
- metadata: Record<string, any>
- context: IActionContext
- bindingsRestricted: boolean
- Optionalquads: Stream<Quad>
Returns Promise<QuerySourceQpf>
- Defined in actor-query-source-identify-hypermedia-qpf/lib/ActorQuerySourceIdentifyHypermediaQpf.ts:84

`Protected`getDefaultLogData

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

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorQuerySourceIdentifyHypermedia.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 ActorQuerySourceIdentifyHypermedia.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 ActorQuerySourceIdentifyHypermedia.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 ActorQuerySourceIdentifyHypermedia.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 ActorQuerySourceIdentifyHypermedia.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 ActorQuerySourceIdentifyHypermedia.logWarn
- Defined in core/lib/Actor.ts:122

run

run(
action: IActionQuerySourceIdentifyHypermedia,
): Promise<IActorQuerySourceIdentifyHypermediaOutput>
Look for the search form
Parameters
- action: IActionQuerySourceIdentifyHypermedia
  the metadata to look for the form.
Returns Promise<IActorQuerySourceIdentifyHypermediaOutput>
A promise resolving to a hypermedia form.
Overrides ActorQuerySourceIdentifyHypermedia.run
- Defined in actor-query-source-identify-hypermedia-qpf/lib/ActorQuerySourceIdentifyHypermediaQpf.ts:72

runObservable

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

test

test(
action: IActionQuerySourceIdentifyHypermedia,
): Promise<TestResult<IActorQuerySourceIdentifyHypermediaTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionQuerySourceIdentifyHypermedia
  The action to test.
Returns Promise<TestResult<IActorQuerySourceIdentifyHypermediaTest>>
A promise that resolves to the test result.
Overrides ActorQuerySourceIdentifyHypermedia.test
- Defined in actor-query-source-identify-hypermedia-qpf/lib/ActorQuerySourceIdentifyHypermediaQpf.ts:40

testMetadata

testMetadata(
action: IActionQuerySourceIdentifyHypermedia,
): Promise<TestResult<IActorQuerySourceIdentifyHypermediaTest>>
Parameters
- action: IActionQuerySourceIdentifyHypermedia
Returns Promise<TestResult<IActorQuerySourceIdentifyHypermediaTest>>
Overrides ActorQuerySourceIdentifyHypermedia.testMetadata
- Defined in actor-query-source-identify-hypermedia-qpf/lib/ActorQuerySourceIdentifyHypermediaQpf.ts:49

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

Class ActorQuerySourceIdentifyHypermediaQpf

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorQuerySourceIdentifyHypermediaQpf

Properties

ReadonlybeforeActors

Readonlybus

Optional ReadonlygraphUri

Default

ReadonlymediatorDereferenceRdf

ReadonlymediatorMergeBindingsContext

ReadonlymediatorMetadata

ReadonlymediatorMetadataExtract

Readonlyname

Default

ReadonlyobjectUri

Default

ReadonlypredicateUri

Default

Protected ReadonlysourceType

ReadonlysubjectUri

Default

Methods

ProtectedcreateSource

Parameters

Returns Promise<QuerySourceQpf>

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

runObservable

Parameters

Returns Promise<IActorQuerySourceIdentifyHypermediaOutput>

test

Parameters

Returns Promise<TestResult<IActorQuerySourceIdentifyHypermediaTest>>

testMetadata

Parameters

Returns Promise<TestResult<IActorQuerySourceIdentifyHypermediaTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Optional` `Readonly`graphUri

`Readonly`mediatorDereferenceRdf

`Readonly`mediatorMergeBindingsContext

`Readonly`mediatorMetadata

`Readonly`mediatorMetadataExtract

`Readonly`name

`Readonly`objectUri

`Readonly`predicateUri

`Protected` `Readonly`sourceType

`Readonly`subjectUri

`Protected`createSource

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger