Class ActorQueryOperationService

A comunica Service Query Operation Actor. It unwraps the SERVICE operation and executes it on the given source.

Hierarchy (View Summary)

ActorQueryOperationTypedMediated<Algebra.Service>
- ActorQueryOperationService

Constructors

constructor

new ActorQueryOperationService(
args: IActorQueryOperationServiceArgs,
): ActorQueryOperationService
Parameters
- args: IActorQueryOperationServiceArgs
Returns ActorQueryOperationService
Overrides ActorQueryOperationTypedMediated.constructor
- Defined in actor-query-operation-service/lib/ActorQueryOperationService.ts:39

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionQueryOperation,
    IActorTest,
    IQueryOperationResult,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionQueryOperation,
        IActorTest,
        IQueryOperationResult,
        undefined,
    >,
    IActionQueryOperation,
    IActorTest,
    IQueryOperationResult,
    undefined,
>

The bus this actor subscribes to.

`Readonly`forceSparqlEndpoint

forceSparqlEndpoint: boolean

`Readonly`httpInvalidator

httpInvalidator: ActorHttpInvalidateListenable

`Readonly`mediatorMergeBindingsContext

mediatorMergeBindingsContext: MediatorMergeBindingsContext

`Readonly`mediatorQueryOperation

mediatorQueryOperation: MediatorQueryOperation

`Readonly`mediatorQuerySourceIdentify

mediatorQuerySourceIdentify: MediatorQuerySourceIdentify

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly`operationName

operationName: string

Methods

`Protected`getDefaultLogData

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

handleHttpInvalidateEvent

handleHttpInvalidateEvent(action: IActionHttpInvalidate): void
Handles HTTP cache invalidation events.
Parameters
- action: IActionHttpInvalidate
  The invalidation action
Returns void
- Defined in actor-query-operation-service/lib/ActorQueryOperationService.ts:107

`Protected`logDebug

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

run

run(
action: IActionQueryOperation,
sideData: undefined,
): Promise<IQueryOperationResult>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionQueryOperation
  The action to run.
- sideData: undefined
Returns Promise<IQueryOperationResult>
A promise that resolves to the run result.
Inherited from ActorQueryOperationTypedMediated.run
- Defined in bus-query-operation/lib/ActorQueryOperationTyped.ts:44

runObservable

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

runOperation

runOperation(
operation: Service,
context: IActionContext,
): Promise<IQueryOperationResult>
Parameters
- operation: Service
- context: IActionContext
Returns Promise<IQueryOperationResult>
Overrides ActorQueryOperationTypedMediated.runOperation
- Defined in actor-query-operation-service/lib/ActorQueryOperationService.ts:55

test

test(action: IActionQueryOperation): Promise<TestResult<IActorTest, undefined>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionQueryOperation
  The action to test.
Returns Promise<TestResult<IActorTest, undefined>>
A promise that resolves to the test result.
Inherited from ActorQueryOperationTypedMediated.test
- Defined in bus-query-operation/lib/ActorQueryOperationTyped.ts:32

testOperation

testOperation(
operation: Service,
_context: IActionContext,
): Promise<TestResult<IActorTest>>
Parameters
- operation: Service
- _context: IActionContext
Returns Promise<TestResult<IActorTest>>
Overrides ActorQueryOperationTypedMediated.testOperation
- Defined in actor-query-operation-service/lib/ActorQueryOperationService.ts:48

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

Class ActorQueryOperationService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorQueryOperationService

Properties

ReadonlybeforeActors

Readonlybus

ReadonlyforceSparqlEndpoint

ReadonlyhttpInvalidator

ReadonlymediatorMergeBindingsContext

ReadonlymediatorQueryOperation

ReadonlymediatorQuerySourceIdentify

Readonlyname

Default

ReadonlyoperationName

Methods

ProtectedgetDefaultLogData

Parameters

Returns any

handleHttpInvalidateEvent

Parameters

Returns 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<IQueryOperationResult>

runObservable

Parameters

Returns Promise<IQueryOperationResult>

runOperation

Parameters

Returns Promise<IQueryOperationResult>

test

Parameters

Returns Promise<TestResult<IActorTest, undefined>>

testOperation

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns undefined | Logger

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`forceSparqlEndpoint

`Readonly`httpInvalidator

`Readonly`mediatorMergeBindingsContext

`Readonly`mediatorQueryOperation

`Readonly`mediatorQuerySourceIdentify

`Readonly`name

`Readonly`operationName

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger