Class ActorQueryOperationUnionOrdered

A union actor that keeps term orders of its inputs.

Hierarchy (View Summary)

ActorQueryOperationTypedMediated<Union>
- ActorQueryOperationUnionOrdered

Index

Constructors

constructor

new ActorQueryOperationUnionOrdered(
args: IActorQueryOperationUnionOrderedArgs,
): ActorQueryOperationUnionOrdered
Parameters
- args: IActorQueryOperationUnionOrderedArgs
Returns ActorQueryOperationUnionOrdered
Overrides ActorQueryOperationTypedMediated.constructor
- Defined in packages/actor-query-operation-union-ordered/lib/ActorQueryOperationUnionOrdered.ts:25

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 packages/core/lib/Actor.ts:101

`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 packages/core/lib/Actor.ts:114

`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 packages/core/lib/Actor.ts:135

`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 packages/core/lib/Actor.ts:142

`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 packages/core/lib/Actor.ts:121

`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 packages/core/lib/Actor.ts:107

`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 packages/core/lib/Actor.ts:128

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 packages/bus-query-operation/lib/ActorQueryOperationTyped.ts:47

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 packages/core/lib/Actor.ts:93

runOperation

runOperation(
operation: Union,
context: IActionContext,
): Promise<IQueryOperationResult>
Parameters
- operation: Union
- context: IActionContext
Returns Promise<IQueryOperationResult>
Overrides ActorQueryOperationTypedMediated.runOperation
- Defined in packages/actor-query-operation-union-ordered/lib/ActorQueryOperationUnionOrdered.ts:61

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 packages/bus-query-operation/lib/ActorQueryOperationTyped.ts:35

testOperation

testOperation(
operation: Union,
_context: IActionContext,
): Promise<TestResult<IActorTest>>
Parameters
- operation: Union
- _context: IActionContext
Returns Promise<TestResult<IActorTest>>
Overrides ActorQueryOperationTypedMediated.testOperation
- Defined in packages/actor-query-operation-union-ordered/lib/ActorQueryOperationUnionOrdered.ts:53

`Static`getContextLogger

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

`Static`getUsefulOrder

getUsefulOrder(
metadatas: MetadataBindings[],
variables: string[],
): TermsOrder<Variable> | undefined
The longest term order that all inputs are sorted on.
Parameters
- metadatas: MetadataBindings[]
  The metadata of the inputs.
- variables: string[]
  The names of the variables on which an order is useful.
Returns TermsOrder<Variable> | undefined
- Defined in packages/actor-query-operation-union-ordered/lib/ActorQueryOperationUnionOrdered.ts:35

Class ActorQueryOperationUnionOrdered

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorQueryOperationUnionOrdered

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

StaticgetUsefulOrder

Parameters

Returns TermsOrder<Variable> | undefined

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