Class ActorQueryOperationFromQuad

A comunica From Query Operation Actor.

Hierarchy (View Summary)

ActorQueryOperationTypedMediated<Algebra.From>
- ActorQueryOperationFromQuad

Constructors

constructor

new ActorQueryOperationFromQuad(
args: IActorQueryOperationTypedMediatedArgs,
): ActorQueryOperationFromQuad
Parameters
- args: IActorQueryOperationTypedMediatedArgs
Returns ActorQueryOperationFromQuad
Overrides ActorQueryOperationTypedMediated.constructor
- Defined in actor-query-operation-from-quad/lib/ActorQueryOperationFromQuad.ts:16

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`mediatorQueryOperation

mediatorQueryOperation: MediatorQueryOperation

`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

`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(
operationOriginal: From,
context: IActionContext,
): Promise<IQueryOperationResult>
Parameters
- operationOriginal: From
- context: IActionContext
Returns Promise<IQueryOperationResult>
Overrides ActorQueryOperationTypedMediated.runOperation
- Defined in actor-query-operation-from-quad/lib/ActorQueryOperationFromQuad.ts:251

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: From,
_context: IActionContext,
): Promise<TestResult<IActorTest>>
Parameters
- _operation: From
- _context: IActionContext
Returns Promise<TestResult<IActorTest>>
Overrides ActorQueryOperationTypedMediated.testOperation
- Defined in actor-query-operation-from-quad/lib/ActorQueryOperationFromQuad.ts:247

`Static`applyOperationDefaultGraph

applyOperationDefaultGraph(
    algebraFactory: Factory,
    operation: Operation,
    defaultGraphs: Term[],
): Operation
Recursively transform the given operation to use the given graphs as default graph This will (possibly) create a new operation and not modify the given operation.
Parameters
- algebraFactory: Factory
  The algebra factory.
- operation: Operation
  An operation.
- defaultGraphs: Term[]
  Graph terms.
Returns Operation
A new operation.

Package
- Defined in actor-query-operation-from-quad/lib/ActorQueryOperationFromQuad.ts:57

`Static`applyOperationNamedGraph

applyOperationNamedGraph(
    algebraFactory: Factory,
    operation: Operation,
    namedGraphs: NamedNode<string>[],
    defaultGraphs: Term[],
): Operation
Recursively transform the given operation to use the given graphs as named graph This will (possibly) create a new operation and not modify the given operation.
Parameters
- algebraFactory: Factory
  The algebra factory.
- operation: Operation
  An operation.
- namedGraphs: NamedNode<string>[]
  Graph terms.
- defaultGraphs: Term[]
  Default graph terms.
Returns Operation
A new operation.

Package
- Defined in actor-query-operation-from-quad/lib/ActorQueryOperationFromQuad.ts:118

`Static`copyOperation

copyOperation(
operation: Operation,
recursiveCb: (subOperation: Operation) => Operation,
): Operation
Create a deep copy of the given operation.
Parameters
- operation: Operation
  An operation.
- recursiveCb: (subOperation: Operation) => Operation
  A callback for recursive operation calls.
Returns Operation
The copied operation.
- Defined in actor-query-operation-from-quad/lib/ActorQueryOperationFromQuad.ts:26

`Static`createOperation

createOperation(algebraFactory: Factory, pattern: From): Operation
Transform an operation based on the default and named graphs in the pattern.

FROM sets the default graph. If multiple are available, take the union of the operation for all of them at quad-pattern level.

FROM NAMED indicates which named graphs are available. This will rewrite the query so that only triples from the given named graphs can be selected.
Parameters
- algebraFactory: Factory
  The algebra factory.
- pattern: From
  A from operation.
Returns Operation
The transformed operation.

Package
- Defined in actor-query-operation-from-quad/lib/ActorQueryOperationFromQuad.ts:235

`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

`Static`joinOperations

joinOperations(algebraFactory: Factory, operations: Operation[]): Operation
Transform the given array of operations into a join operation.
Parameters
- algebraFactory: Factory
  The algebra factory.
- operations: Operation[]
  An array of operations, must contain at least one operation.
Returns Operation
A join operation.

Package
- Defined in actor-query-operation-from-quad/lib/ActorQueryOperationFromQuad.ts:194

`Static`unionOperations

unionOperations(algebraFactory: Factory, operations: Operation[]): Operation
Transform the given array of operations into a union operation.
Parameters
- algebraFactory: Factory
  The algebra factory.
- operations: Operation[]
  An array of operations, must contain at least one operation.
Returns Operation
A union operation.

Package
- Defined in actor-query-operation-from-quad/lib/ActorQueryOperationFromQuad.ts:211

Class ActorQueryOperationFromQuad

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorQueryOperationFromQuad

Properties

ReadonlybeforeActors

Readonlybus

ReadonlymediatorQueryOperation

Readonlyname

Default

ReadonlyoperationName

Methods

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

runObservable

Parameters

Returns Promise<IQueryOperationResult>

runOperation

Parameters

Returns Promise<IQueryOperationResult>

test

Parameters

Returns Promise<TestResult<IActorTest, undefined>>

testOperation

Parameters

Returns Promise<TestResult<IActorTest>>

StaticapplyOperationDefaultGraph

Parameters

Returns Operation

Package

StaticapplyOperationNamedGraph

Parameters

Returns Operation

Package

StaticcopyOperation

Parameters

Returns Operation

StaticcreateOperation

Parameters

Returns Operation

Package

StaticgetContextLogger

Parameters

Returns undefined | Logger

StaticjoinOperations

Parameters

Returns Operation

Package

StaticunionOperations

Parameters

Returns Operation

Package

`Readonly`beforeActors

`Readonly`bus

`Readonly`mediatorQueryOperation

`Readonly`name

`Readonly`operationName

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`applyOperationDefaultGraph

`Static`applyOperationNamedGraph

`Static`copyOperation

`Static`createOperation

`Static`getContextLogger

`Static`joinOperations

`Static`unionOperations