Class ActorWarmupQueriesSampled

A comunica warmup actor that executes queries derived from the data in the sources, such as single patterns, stars, and paths, all with a limit.

Hierarchy (View Summary)

ActorWarmup
- ActorWarmupQueriesSampled

Index

Constructors

constructor

new ActorWarmupQueriesSampled(args: IActorWarmupArgs): ActorWarmupQueriesSampled
Parameters
- args: IActorWarmupArgs
Returns ActorWarmupQueriesSampled
Overrides ActorWarmup.constructor
- Defined in actor-warmup-queries-sampled/lib/ActorWarmupQueriesSampled.ts:19

Properties

`Readonly`beforeActors

beforeActors: Actor<IActionWarmup, IActorTest, IActorWarmupOutput, undefined>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<IActionWarmup, IActorTest, IActorWarmupOutput, undefined>,
    IActionWarmup,
    IActorTest,
    IActorWarmupOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Static` `Readonly`LIMIT

LIMIT: 20

`Static` `Readonly`MAX_PREDICATES

MAX_PREDICATES: 24

`Static` `Readonly`MAX_SUBJECTS

MAX_SUBJECTS: 24

`Static` `Readonly`MEDIA_TYPE

MEDIA_TYPE: "application/sparql-results+json" = 'application/sparql-results+json'

Methods

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorWarmup.getDefaultLogData
- Defined in 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 ActorWarmup.logDebug
- Defined in 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 ActorWarmup.logError
- Defined in 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 ActorWarmup.logFatal
- Defined in 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 ActorWarmup.logInfo
- Defined in 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 ActorWarmup.logTrace
- Defined in 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 ActorWarmup.logWarn
- Defined in core/lib/Actor.ts:128

run

run(action: IActionWarmup): Promise<IActorWarmupOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionWarmup
  The action to run.
Returns Promise<IActorWarmupOutput>
A promise that resolves to the run result.
Overrides ActorWarmup.run
- Defined in actor-warmup-queries-sampled/lib/ActorWarmupQueriesSampled.ts:31

runObservable

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

test

test(action: IActionWarmup): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- action: IActionWarmup
  The action to test.
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorWarmup.test
- Defined in actor-warmup-queries-sampled/lib/ActorWarmupQueriesSampled.ts:23

`Protected` `Static`consume

consume(data: ReadableStream): Promise<void>
Parameters
- data: ReadableStream
Returns Promise<void>
- Defined in actor-warmup-queries-sampled/lib/ActorWarmupQueriesSampled.ts:110

`Static`generateQueries

generateQueries(
    engine: IQueryEngine<any, any>,
    context: IActionContext,
    stopped?: () => boolean,
    loaded?: () => void,
): Promise<string[]>
Generate warm-up queries from the data in the sources.
Parameters
- engine: IQueryEngine<any, any>
  A query engine.
- context: IActionContext
  A context with the sources.
- stopped: () => boolean = ...
  A check after which no more data is sampled.
- loaded: () => void = ...
  A callback for when the first query, which loads the sources, has completed.
Returns Promise<string[]>
- Defined in actor-warmup-queries-sampled/lib/ActorWarmupQueriesSampled.ts:57

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

Class ActorWarmupQueriesSampled

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorWarmupQueriesSampled

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

Static ReadonlyLIMIT

Static ReadonlyMAX_PREDICATES

Static ReadonlyMAX_SUBJECTS

Static ReadonlyMEDIA_TYPE

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

runObservable

Parameters

Returns Promise<IActorWarmupOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

Protected Staticconsume

Parameters

Returns Promise<void>

StaticgenerateQueries

Parameters

Returns Promise<string[]>

StaticgetContextLogger

Parameters

Returns Logger | undefined

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Static` `Readonly`LIMIT

`Static` `Readonly`MAX_PREDICATES

`Static` `Readonly`MAX_SUBJECTS

`Static` `Readonly`MEDIA_TYPE

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Protected` `Static`consume

`Static`generateQueries

`Static`getContextLogger