Class ActorRdfJoin`Abstract`

A comunica actor for joining 2 binding streams.

Actor types:

Input: IActionRdfJoin: The streams that need to be joined.
Test: IMediatorTypeJoinCoefficients: Join coefficients.
Output: IActorRdfJoinOutput: The resulting joined stream.

See

IActionRdfJoin
IActorQueryOperationOutput

Hierarchy (view full)

Actor<IActionRdfJoin, IMediatorTypeJoinCoefficients, IQueryOperationResultBindings>
- ActorRdfJoin

Constructors

constructor

new ActorRdfJoin(args, options): ActorRdfJoin
Parameters
- args: IActorRdfJoinArgs
- options: IActorRdfJoinInternalOptions
  Actor-specific join options.
Returns ActorRdfJoin
Default Nested
bus
Overrides Actor.constructor
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:66

Properties

`Readonly` beforeActors

beforeActors: Actor<IActionRdfJoin, IMediatorTypeJoinCoefficients, IQueryOperationResultBindings>[] = []

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

`Readonly` bus

bus: Bus<Actor<IActionRdfJoin, IMediatorTypeJoinCoefficients, IQueryOperationResultBindings>, IActionRdfJoin, IMediatorTypeJoinCoefficients, IQueryOperationResultBindings>

The bus this actor subscribes to.

`Protected` `Readonly` canHandleUndefs

canHandleUndefs: boolean

If this actor can handle undefs in the bindings.

includeInLogs

includeInLogs: boolean = true

If this actor will be logged in the debugger and physical query plan logger

`Protected` `Readonly` limitEntries

limitEntries: number

Can be used by subclasses to indicate the max or min number of streams that can be joined. 0 for infinity. By default, this indicates the max number, but can be inverted by setting limitEntriesMin to true.

`Protected` `Readonly` limitEntriesMin

limitEntriesMin: boolean

If true, the limitEntries field is a lower limit, otherwise, it is an upper limit.

`Readonly` logicalType

logicalType: LogicalJoinType

`Readonly` mediatorJoinSelectivity

mediatorJoinSelectivity: MediatorRdfJoinSelectivity

`Readonly` name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Readonly` physicalName

physicalName: string

Methods

constructResultMetadata

constructResultMetadata(entries, metadatas, context, partialMetadata?): Promise<MetadataBindings>
Helper function to create a new metadata object for the join result. For required metadata entries that are not provided, sane defaults are calculated.
Parameters
- entries: IJoinEntry[]
  Join entries.
- metadatas: MetadataBindings[]
  Metadata of the join entries.
- context: IActionContext
  The action context.
- partialMetadata: Partial<MetadataBindings> = {}
  Partial metadata entries.
Returns Promise<MetadataBindings>
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:189

deinitialize

deinitialize(): Promise<any>
Deinitialize this actor. This should be used for cleaning up things when the application is shut down, such as closing files and removing temporary files.

Returns Promise<any>
A promise that resolves when the actor has been deinitialized.
Inherited from Actor.deinitialize
- Defined in packages/core/lib/Actor.ts:106

`Protected` getDefaultLogData

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

`Protected` `Abstract` getJoinCoefficients

getJoinCoefficients(action, metadatas): Promise<IMediatorTypeJoinCoefficients>
Calculate the join coefficients.
Parameters
- action: IActionRdfJoin
  Join action
- metadatas: MetadataBindings[]
  Array of resolved metadata objects.
Returns Promise<IMediatorTypeJoinCoefficients>
The join coefficient estimates.
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:411

`Protected` `Abstract` getOutput

getOutput(action): Promise<IActorRdfJoinOutputInner>
Returns the resulting output for joining the given entries. This is called after removing the trivial cases in run.
Parameters
- action: IActionRdfJoin
Returns Promise<IActorRdfJoinOutputInner>
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:403

initialize

initialize(): Promise<any>
Initialize this actor. This should be used for doing things that take a while, such as opening files.

Returns Promise<any>
A promise that resolves when the actor has been initialized.
Inherited from Actor.initialize
- Defined in packages/core/lib/Actor.ts:95

`Protected` logDebug

logDebug(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from Actor.logDebug
- Defined in packages/core/lib/Actor.ts:125

`Protected` logError

logError(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from Actor.logError
- Defined in packages/core/lib/Actor.ts:146

`Protected` logFatal

logFatal(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from Actor.logFatal
- Defined in packages/core/lib/Actor.ts:153

`Protected` logInfo

logInfo(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from Actor.logInfo
- Defined in packages/core/lib/Actor.ts:132

`Protected` logTrace

logTrace(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from Actor.logTrace
- Defined in packages/core/lib/Actor.ts:118

`Protected` logWarn

logWarn(context, message, data?): void
Parameters
- context: IActionContext
- message: string
- Optional data: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from Actor.logWarn
- Defined in packages/core/lib/Actor.ts:139

run

run(action): Promise<IQueryOperationResultBindings>
Returns default input for 0 or 1 entries. Calls the getOutput function otherwise
Parameters
- action: IActionRdfJoin
Returns Promise<IQueryOperationResultBindings>
A bindings result.
Overrides Actor.run
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:355

runObservable

runObservable(action): Promise<IQueryOperationResultBindings>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionRdfJoin
  The action to run.
Returns Promise<IQueryOperationResultBindings>
A promise that resolves to the run result.
Inherited from Actor.runObservable
- Defined in packages/core/lib/Actor.ts:82

test

test(action): Promise<IMediatorTypeJoinCoefficients>
Default test function for join actors. Checks whether all iterators have metadata. If yes: call the abstract getIterations method, if not: return Infinity.
Parameters
- action: IActionRdfJoin
  The input action containing the relevant iterators
Returns Promise<IMediatorTypeJoinCoefficients>
The join coefficients.
Overrides Actor.test
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:310

`Static` getCardinality

getCardinality(metadata): QueryResultCardinality
Get the estimated number of items from the given metadata.
Parameters
- metadata: MetadataBindings
  A metadata object.
Returns QueryResultCardinality
The estimated number of items, or Infinity if cardinality is falsy.
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:143

`Static` getContextLogger

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

`Static` getEntriesWithMetadatas

getEntriesWithMetadatas(entries): Promise<IJoinEntryWithMetadata[]>
Obtain the join entries witt metadata from all given join entries.
Parameters
- entries: IJoinEntry[]
  Join entries.
Returns Promise<IJoinEntryWithMetadata[]>
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:159

`Static` getMetadatas

getMetadatas(entries): Promise<MetadataBindings[]>
Obtain the metadata from all given join entries.
Parameters
- entries: IJoinEntry[]
  Join entries.
Returns Promise<MetadataBindings[]>
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:151

`Static` getRequestInitialTimes

getRequestInitialTimes(metadatas): number[]
Calculate the time to initiate a request for the given metadata entries.
Parameters
- metadatas: MetadataBindings[]
  An array of checked metadata.
Returns number[]
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:168

`Static` getRequestItemTimes

getRequestItemTimes(metadatas): number[]
Calculate the time to receive a single item for the given metadata entries.
Parameters
- metadatas: MetadataBindings[]
  An array of checked metadata.
Returns number[]
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:176

`Static` hash

hash(bindings, variables): string
Creates a hash of the given bindings by concatenating the results of the given variables. This function will not sort the variables and expects them to be in the same order for every call.
Parameters
- bindings: Bindings
- variables: Variable[]
Returns string
A hash string.
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:82

`Static` joinBindings

joinBindings(...bindings): null | Bindings
Returns the result of joining bindings, or null if no join is possible.
Parameters
- Rest ...bindings: Bindings[]
Returns null | Bindings
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:119

`Static` joinVariables

joinVariables(metadatas): Variable[]
Returns the variables that will occur in the joined bindings.
Parameters
- metadatas: MetadataBindings[]
  An array of metadata objects for the entries.
Returns Variable[]
An array of joined variables.
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:108

`Static` overlappingVariables

overlappingVariables(metadatas): Variable[]
Returns an array containing all the variable names that occur in all bindings streams.
Parameters
- metadatas: MetadataBindings[]
  An array of optional metadata objects for the entries.
Returns Variable[]
An array of variables.
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:94

`Static` sortJoinEntries

sortJoinEntries(mediatorJoinEntriesSort, entries, context): Promise<IJoinEntryWithMetadata[]>
Order the given join entries using the join-entries-sort bus.
Parameters
- mediatorJoinEntriesSort: MediatorRdfJoinEntriesSort
  A mediator for sorting join entries.
- entries: IJoinEntryWithMetadata[]
  An array of join entries.
- context: IActionContext
  The action context.
Returns Promise<IJoinEntryWithMetadata[]>
The sorted join entries.
- Defined in packages/bus-rdf-join/lib/ActorRdfJoin.ts:236

Class ActorRdfJoinAbstract

See

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorRdfJoin

Default Nested

Properties

Readonly beforeActors

Readonly bus

Protected Readonly canHandleUndefs

includeInLogs

Protected Readonly limitEntries

Protected Readonly limitEntriesMin

Readonly logicalType

Readonly mediatorJoinSelectivity

Readonly name

Default

Readonly physicalName

Methods

constructResultMetadata

Parameters

Returns Promise<MetadataBindings>

deinitialize

Returns Promise<any>

Protected getDefaultLogData

Parameters

Returns any

Returns any

Protected Abstract getJoinCoefficients

Parameters

Returns Promise<IMediatorTypeJoinCoefficients>

Protected Abstract getOutput

Parameters

Returns Promise<IActorRdfJoinOutputInner>

initialize

Returns Promise<any>

Protected logDebug

Parameters

Returns any

Returns void

Protected logError

Parameters

Returns any

Returns void

Protected logFatal

Parameters

Returns any

Returns void

Protected logInfo

Parameters

Returns any

Returns void

Protected logTrace

Parameters

Returns any

Returns void

Protected logWarn

Parameters

Returns any

Returns void

run

Parameters

Returns Promise<IQueryOperationResultBindings>

runObservable

Parameters

Returns Promise<IQueryOperationResultBindings>

test

Parameters

Returns Promise<IMediatorTypeJoinCoefficients>

Static getCardinality

Parameters

Returns QueryResultCardinality

Static getContextLogger

Parameters

Class ActorRdfJoin`Abstract`

`Readonly` beforeActors

`Readonly` bus

`Protected` `Readonly` canHandleUndefs

`Protected` `Readonly` limitEntries

`Protected` `Readonly` limitEntriesMin

`Readonly` logicalType

`Readonly` mediatorJoinSelectivity

`Readonly` name

`Readonly` physicalName

`Protected` getDefaultLogData

`Protected` `Abstract` getJoinCoefficients

`Protected` `Abstract` getOutput

`Protected` logDebug

`Protected` logError

`Protected` logFatal

`Protected` logInfo

`Protected` logTrace

`Protected` logWarn

`Static` getCardinality

`Static` getContextLogger

`Static` getEntriesWithMetadatas

`Static` getMetadatas

`Static` getRequestInitialTimes

`Static` getRequestItemTimes

`Static` hash

`Static` joinBindings

`Static` joinVariables

`Static` overlappingVariables

`Static` sortJoinEntries