Class ActorQueryOperation`Abstract`

A comunica actor for query-operation events.

Actor types:

Input: IActionQueryOperation: A SPARQL Algebra operation.
Test:
Output: IActorQueryOperationOutput: A bindings stream.

See

IActionQueryOperation
IQueryOperationResult

Hierarchy (view full)

Actor<IActionQueryOperation, IActorTest, IQueryOperationResult>
- ActorQueryOperation
  - ActorQueryOperationTyped

Constructors

`Protected` constructor

new ActorQueryOperation(args): ActorQueryOperation
Parameters
- args: IActorQueryOperationArgs
Returns ActorQueryOperation
Default Nested
bus
Overrides Actor.constructor
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:45

Properties

`Readonly` beforeActors

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

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

`Readonly` bus

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

The bus this actor subscribes to.

`Readonly` name

name: string

The name for this actor.

Default

{<rdf:subject>}

Methods

deinitialize

deinitialize(): Promise<any>
Deinitialize this actor. This should be used for cleaning up things when the application is shut down, such as closing files and removing temporary files.

Returns Promise<any>
A promise that resolves when the actor has been deinitialized.
Inherited from Actor.deinitialize
- Defined in packages/core/lib/Actor.ts:106

`Protected` getDefaultLogData

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

initialize

initialize(): Promise<any>
Initialize this actor. This should be used for doing things that take a while, such as opening files.

Returns Promise<any>
A promise that resolves when the actor has been initialized.
Inherited from Actor.initialize
- Defined in packages/core/lib/Actor.ts:95

`Protected` logDebug

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

`Protected` logError

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

`Protected` logFatal

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

`Protected` logInfo

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

`Protected` logTrace

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

`Protected` logWarn

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

`Abstract` run

run(action): 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.
Returns Promise<IQueryOperationResult>
A promise that resolves to the run result.
Inherited from Actor.run
- Defined in packages/core/lib/Actor.ts:73

runObservable

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

`Abstract` test

test(action): Promise<IActorTest>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionQueryOperation
  The action to test.
Returns Promise<IActorTest>
A promise that resolves to the test result.
Inherited from Actor.test
- Defined in packages/core/lib/Actor.ts:62

`Static` assignOperationSource

assignOperationSource<O>(operation, source): O
Assign a source wrapper to the given operation. The operation is copied and returned.
Type Parameters
- O extends Operation
Parameters
- operation: O
  An operation.
- source: IQuerySourceWrapper<IQuerySource>
  A source wrapper.
Returns O
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:219

`Static` createExistenceResolver

createExistenceResolver(context, mediatorQueryOperation, bindingsFactory): ((expr, bindings) => Promise<boolean>)
Create an existence resolver for usage within an expression context.
Parameters
- context: IActionContext
  An action context.
- mediatorQueryOperation: MediatorQueryOperation
  A query operation mediator.
- bindingsFactory: BindingsFactory
  The bindings factory.
Returns ((expr, bindings) => Promise<boolean>)
- - (expr, bindings): Promise<boolean>
  - Parameters
    - expr: ExistenceExpression
    - bindings: Bindings
    Returns Promise<boolean>
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:165

`Static` doesShapeAcceptOperation

doesShapeAcceptOperation(shape, operation, options?): boolean
Check if the given shape accepts the given query operation.
Parameters
- shape: FragmentSelectorShape
  A shape to test the query operation against.
- operation: Operation
  A query operation to test.
- Optional options: {
  filterBindings?: boolean;
  joinBindings?: boolean;
  }
  Additional options to consider.
  - Optional filterBindings?: boolean
    If additional bindings will be pushed down to the source for filtering.
  - Optional joinBindings?: boolean
    If additional bindings will be pushed down to the source for joining.
Returns boolean
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:246

`Static` getAsyncExpressionContext

getAsyncExpressionContext(context, mediatorQueryOperation, bindingsFactory): IAsyncExpressionContext
Create an options object that can be used to construct a expression-evaluator asynchronous evaluator.
Parameters
- context: IActionContext
  An action context.
- mediatorQueryOperation: MediatorQueryOperation
  A query query operation mediator for resolving exists.
- bindingsFactory: BindingsFactory
  The bindings factory.
Returns IAsyncExpressionContext
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:146

`Protected` `Static` getBaseExpressionContext

getBaseExpressionContext(context): IBaseExpressionContext
Parameters
- context: IActionContext
Returns IBaseExpressionContext
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:104

`Static` getContextLogger

getContextLogger(context): undefined | Logger
Get the logger from the given context.
Parameters
- context: IActionContext
  An optional context.
Returns undefined | Logger
The logger or undefined.
Inherited from Actor.getContextLogger
- Defined in packages/core/lib/Actor.ts:51

`Static` getExpressionContext

getExpressionContext(context, _mediatorQueryOperation?): ISyncExpressionContext
Create an options object that can be used to construct a expression-evaluator synchronous evaluator.
Parameters
- context: IActionContext
  An action context.
- Optional _mediatorQueryOperation: MediatorQueryOperation
  An optional query query operation mediator. If defined, the existence resolver will be defined as exists.
Returns ISyncExpressionContext
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:132

`Static` getOperationSource

getOperationSource(operation): undefined | IQuerySourceWrapper<IQuerySource>
Obtain the query source attached to the given operation.
Parameters
- operation: Operation
  An algebra operation.
Returns undefined | IQuerySourceWrapper<IQuerySource>
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:209

`Static` getSafeBindings

getSafeBindings(output): IQueryOperationResultBindings
Safely cast a query operation output to a bindings output. This will throw a runtime error if the output is of the incorrect type.
Parameters
- output: IQueryOperationResult
  A query operation output.
Returns IQueryOperationResultBindings
A bindings query operation output.
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:55

`Static` getSafeBoolean

getSafeBoolean(output): IQueryOperationResultBoolean
Safely cast a query operation output to a boolean output. This will throw a runtime error if the output is of the incorrect type.
Parameters
- output: IQueryOperationResult
  A query operation output.
Returns IQueryOperationResultBoolean
A boolean query operation output.
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:77

`Static` getSafeQuads

getSafeQuads(output): IQueryOperationResultQuads
Safely cast a query operation output to a quads output. This will throw a runtime error if the output is of the incorrect type.
Parameters
- output: IQueryOperationResult
  A query operation output.
Returns IQueryOperationResultQuads
A quads query operation output.
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:66

`Static` getSafeVoid

getSafeVoid(output): IQueryOperationResultVoid
Safely cast a query operation output to a void output. This will throw a runtime error if the output is of the incorrect type.
Parameters
- output: IQueryOperationResult
  A query operation output.
Returns IQueryOperationResultVoid
A void query operation output.
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:88

`Static` removeOperationSource

removeOperationSource(operation): void
Remove the source wrapper from the given operation. The operation is mutated.
Parameters
- operation: Operation
  An operation.
Returns void
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:231

`Static` throwOnReadOnly

throwOnReadOnly(context): void
Throw an error if the context contains the readOnly flag.
Parameters
- context: IActionContext
  An action context.
Returns void
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:199

`Static` validateQueryOutput

validateQueryOutput(output, expectedType): void
Throw an error if the output type does not match the expected type.
Parameters
- output: IQueryOperationResult
  A query operation output.
- expectedType: "boolean" | "bindings" | "quads" | "void"
  The expected output type.
Returns void
- Defined in packages/bus-query-operation/lib/ActorQueryOperation.ts:98

Class ActorQueryOperationAbstract

See

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Parameters

args: IActorQueryOperationArgs

Returns ActorQueryOperation

Default Nested

Properties

Readonly beforeActors

Readonly bus

Readonly name

Default

Methods

deinitialize

Returns Promise<any>

Protected getDefaultLogData

Parameters

context: IActionContext

Optional data: (() => any)

Returns any

Returns any

initialize

Returns Promise<any>

Protected logDebug

Parameters

context: IActionContext

message: string

Optional data: (() => any)

Returns any

Returns void

Protected logError

Parameters

context: IActionContext

message: string

Optional data: (() => any)

Returns any

Returns void

Protected logFatal

Parameters

context: IActionContext

message: string

Optional data: (() => any)

Returns any

Returns void

Protected logInfo

Parameters

context: IActionContext

message: string

Optional data: (() => any)

Returns any

Returns void

Protected logTrace

Parameters

context: IActionContext

message: string

Optional data: (() => any)

Returns any

Returns void

Protected logWarn

Parameters

context: IActionContext

message: string

Optional data: (() => any)

Returns any

Returns void

Abstract run

Parameters

action: IActionQueryOperation

Returns Promise<IQueryOperationResult>

runObservable

Parameters

action: IActionQueryOperation

Returns Promise<IQueryOperationResult>

Abstract test

Class ActorQueryOperation`Abstract`

`Protected` constructor

`Readonly` beforeActors

`Readonly` bus

`Readonly` name

`Protected` getDefaultLogData

`Optional` data: (() => any)

`Protected` logDebug

`Optional` data: (() => any)

`Protected` logError

`Optional` data: (() => any)

`Protected` logFatal

`Optional` data: (() => any)

`Protected` logInfo

`Optional` data: (() => any)

`Protected` logTrace

`Optional` data: (() => any)

`Protected` logWarn

`Optional` data: (() => any)

`Abstract` run

`Abstract` test

`Static` assignOperationSource

`Static` createExistenceResolver

`Static` doesShapeAcceptOperation

`Optional` options: {
filterBindings?: boolean;
joinBindings?: boolean;
}

`Optional` filterBindings?: boolean

`Optional` joinBindings?: boolean

`Static` getAsyncExpressionContext

`Protected` `Static` getBaseExpressionContext

`Static` getContextLogger

`Static` getExpressionContext

`Optional` _mediatorQueryOperation: MediatorQueryOperation

`Static` getOperationSource

`Static` getSafeBindings

`Static` getSafeBoolean

`Static` getSafeQuads

`Static` getSafeVoid

`Static` removeOperationSource