Class ActorOptimizeQueryOperationQuerySourceIdentify

A comunica Query Source Identify Optimize Query Operation Actor.

Hierarchy (View Summary)

ActorOptimizeQueryOperation
- ActorOptimizeQueryOperationQuerySourceIdentify

Constructors

constructor

new ActorOptimizeQueryOperationQuerySourceIdentify(
args: IActorOptimizeQueryOperationQuerySourceIdentifyArgs,
): ActorOptimizeQueryOperationQuerySourceIdentify
Parameters
- args: IActorOptimizeQueryOperationQuerySourceIdentifyArgs
Returns ActorOptimizeQueryOperationQuerySourceIdentify
Overrides ActorOptimizeQueryOperation.constructor
- Defined in actor-optimize-query-operation-query-source-identify/lib/ActorOptimizeQueryOperationQuerySourceIdentify.ts:56

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionOptimizeQueryOperation,
    IActorTest,
    IActorOptimizeQueryOperationOutput,
    undefined,
>[] = []

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionOptimizeQueryOperation,
        IActorTest,
        IActorOptimizeQueryOperationOutput,
        undefined,
    >,
    IActionOptimizeQueryOperation,
    IActorTest,
    IActorOptimizeQueryOperationOutput,
    undefined,
>

The bus this actor subscribes to.

`Optional` `Readonly`cache

cache?: LRUCache<
    string,
    Map<string, Promise<IQuerySourceWrapper<IQuerySource>>>,
    unknown,
>

A cache of identified sources, indexed by url, and then by qualifier (see getCacheQualifier), as the same url may be identified into different sources.

`Readonly`cacheSize

cacheSize: number

`Readonly`httpInvalidator

httpInvalidator: ActorHttpInvalidateListenable

`Readonly`mediatorContextPreprocess

mediatorContextPreprocess: MediatorContextPreprocess

`Readonly`mediatorQuerySourceIdentify

mediatorQuerySourceIdentify: MediatorQuerySourceIdentify

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly`serviceForceSparqlEndpoint

serviceForceSparqlEndpoint: boolean

Methods

expandSource

expandSource(
querySource: QuerySourceUnidentified,
): Promise<QuerySourceUnidentifiedExpanded>
Parameters
- querySource: QuerySourceUnidentified
Returns Promise<QuerySourceUnidentifiedExpanded>
- Defined in actor-optimize-query-operation-query-source-identify/lib/ActorOptimizeQueryOperationQuerySourceIdentify.ts:147

getCacheQualifier

getCacheQualifier(
querySourceUnidentified: QuerySourceUnidentifiedExpanded,
): string
Determine the qualifier under which an identified source is cached for its url.

The qualifier contains everything that can make the same url identify into a different source: its forced type, and the values of the cache-relevant keys in its source context (see CONTEXT_KEYS_QUERY_SOURCE_CACHE). This ensures that a source is only reused by queries that pass an equivalent source.
Parameters
- querySourceUnidentified: QuerySourceUnidentifiedExpanded
  An unidentified source.
Returns string
The qualifier, which is empty for sources without forced type and cache-relevant source context.
- Defined in actor-optimize-query-operation-query-source-identify/lib/ActorOptimizeQueryOperationQuerySourceIdentify.ts:205

`Protected`getCacheQualifierValue

getCacheQualifierValue(value: unknown): CacheQualifierValue
Represent a source context value in a cache qualifier. RDF terms and primitive values are represented by their value. Other objects (such as fetch functions or proxy handlers) are represented by their identity, as they can not be compared by value.
Parameters
- value: unknown
  A source context value.
Returns CacheQualifierValue
- Defined in actor-optimize-query-operation-query-source-identify/lib/ActorOptimizeQueryOperationQuerySourceIdentify.ts:227

`Protected`getDefaultLogData

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

identifySource

identifySource(
    querySourceUnidentified: QuerySourceUnidentifiedExpanded,
    context: IActionContext,
    cacheQualifierPrefix?: string,
): Promise<IQuerySourceWrapper<IQuerySource>>
Parameters
- querySourceUnidentified: QuerySourceUnidentifiedExpanded
- context: IActionContext
- cacheQualifierPrefix: string = ''
Returns Promise<IQuerySourceWrapper<IQuerySource>>
- Defined in actor-optimize-query-operation-query-source-identify/lib/ActorOptimizeQueryOperationQuerySourceIdentify.ts:159

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorOptimizeQueryOperation.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 ActorOptimizeQueryOperation.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 ActorOptimizeQueryOperation.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 ActorOptimizeQueryOperation.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 ActorOptimizeQueryOperation.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 ActorOptimizeQueryOperation.logWarn
- Defined in core/lib/Actor.ts:128

run

run(
action: IActionOptimizeQueryOperation,
): Promise<IActorOptimizeQueryOperationOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionOptimizeQueryOperation
  The action to run.
Returns Promise<IActorOptimizeQueryOperationOutput>
A promise that resolves to the run result.
Overrides ActorOptimizeQueryOperation.run
- Defined in actor-optimize-query-operation-query-source-identify/lib/ActorOptimizeQueryOperationQuerySourceIdentify.ts:82

runObservable

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

test

test(_action: IActionOptimizeQueryOperation): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionOptimizeQueryOperation
  The action to test.
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorOptimizeQueryOperation.test
- Defined in actor-optimize-query-operation-query-source-identify/lib/ActorOptimizeQueryOperationQuerySourceIdentify.ts:78

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

Class ActorOptimizeQueryOperationQuerySourceIdentify

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorOptimizeQueryOperationQuerySourceIdentify

Properties

ReadonlybeforeActors

Readonlybus

Optional Readonlycache

ReadonlycacheSize

ReadonlyhttpInvalidator

ReadonlymediatorContextPreprocess

ReadonlymediatorQuerySourceIdentify

Readonlyname

Default

ReadonlyserviceForceSparqlEndpoint

Methods

expandSource

Parameters

Returns Promise<QuerySourceUnidentifiedExpanded>

getCacheQualifier

Parameters

Returns string

ProtectedgetCacheQualifierValue

Parameters

Returns CacheQualifierValue

ProtectedgetDefaultLogData

Parameters

Returns any

identifySource

Parameters

Returns Promise<IQuerySourceWrapper<IQuerySource>>

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

runObservable

Parameters

Returns Promise<IActorOptimizeQueryOperationOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns Logger | undefined

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Optional` `Readonly`cache

`Readonly`cacheSize

`Readonly`httpInvalidator

`Readonly`mediatorContextPreprocess

`Readonly`mediatorQuerySourceIdentify

`Readonly`name

`Readonly`serviceForceSparqlEndpoint

`Protected`getCacheQualifierValue

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger