Class ActorQueryOperationUnion

A comunica Union Query Operation Actor.

Hierarchy (View Summary)

ActorQueryOperationTypedMediated<Algebra.Union>
- ActorQueryOperationUnion

Constructors

constructor

new ActorQueryOperationUnion(
args: IActorQueryOperationUnionArgs,
): ActorQueryOperationUnion
Parameters
- args: IActorQueryOperationUnionArgs
Returns ActorQueryOperationUnion
Overrides ActorQueryOperationTypedMediated.constructor
- Defined in actor-query-operation-union/lib/ActorQueryOperationUnion.ts:30

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

mediatorRdfMetadataAccumulate: MediatorRdfMetadataAccumulate

`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(
operation: Union,
context: IActionContext,
): Promise<IQueryOperationResult>
Parameters
- operation: Union
- context: IActionContext
Returns Promise<IQueryOperationResult>
Overrides ActorQueryOperationTypedMediated.runOperation
- Defined in actor-query-operation-union/lib/ActorQueryOperationUnion.ts:120

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: Union,
_context: IActionContext,
): Promise<TestResult<IActorTest>>
Parameters
- _operation: Union
- _context: IActionContext
Returns Promise<TestResult<IActorTest>>
Overrides ActorQueryOperationTypedMediated.testOperation
- Defined in actor-query-operation-union/lib/ActorQueryOperationUnion.ts:116

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

unionMetadata<
    Bindings extends boolean,
    M extends MetadataBindings | MetadataQuads,
>(
    metadatas: M[],
    bindings: Bindings,
    context: IActionContext,
    mediatorRdfMetadataAccumulate: MediatorRdfMetadataAccumulate,
): Promise<M>
Takes the union of the given metadata array. It will ensure that the cardinality metadata value is properly calculated.
Type Parameters
- Bindings extends boolean
- M extends MetadataBindings | MetadataQuads
Parameters
- metadatas: M[]
  Array of metadata.
- bindings: Bindings
  If the union of the variables field should also be taken.
- context: IActionContext
  The action context
- mediatorRdfMetadataAccumulate: MediatorRdfMetadataAccumulate
  Mediator for metadata accumulation
Returns Promise<M>
Union of the metadata.
- Defined in actor-query-operation-union/lib/ActorQueryOperationUnion.ts:71

`Static`unionVariables

unionVariables(variables: MetadataVariable[][]): MetadataVariable[]
Takes the union of the given double array variables. Uniqueness is guaranteed.
Parameters
- variables: MetadataVariable[][]
  Double array of variables to take the union of.
Returns MetadataVariable[]
The union of the given variables.
- Defined in actor-query-operation-union/lib/ActorQueryOperationUnion.ts:40

Class ActorQueryOperationUnion

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorQueryOperationUnion

Properties

ReadonlybeforeActors

Readonlybus

ReadonlymediatorQueryOperation

ReadonlymediatorRdfMetadataAccumulate

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

StaticgetContextLogger

Parameters

Returns undefined | Logger

StaticunionMetadata

Type Parameters

Parameters

Returns Promise<M>

StaticunionVariables

Parameters

Returns MetadataVariable[]

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`mediatorQueryOperation

`Readonly`mediatorRdfMetadataAccumulate

`Readonly`name

`Readonly`operationName

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger

`Static`unionMetadata

`Static`unionVariables