Class ActorRdfJoin<TS>`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

Type Parameters

TS extends IActorRdfJoinTestSideData = IActorRdfJoinTestSideData

Constructors

constructor

new ActorRdfJoin<
    TS extends IActorRdfJoinTestSideData = IActorRdfJoinTestSideData,
>(
    args: IActorRdfJoinArgs<TS>,
    options: IActorRdfJoinInternalOptions,
): ActorRdfJoin<TS>
Type Parameters
- TS extends IActorRdfJoinTestSideData = IActorRdfJoinTestSideData
Parameters
- args: IActorRdfJoinArgs<TS>
  \
- options: IActorRdfJoinInternalOptions
  Actor-specific join options.
Returns ActorRdfJoin<TS>
Default Nested
bus \

Default Nested
busFailMessage
Overrides Actor.constructor
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:83

Properties

`Readonly`beforeActors

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

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

`Readonly`bus

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

The bus this actor subscribes to.

`Protected` `Readonly`canHandleUndefs

canHandleUndefs: boolean

If this actor can handle undefs overlapping variable bindings.

includeInLogs

includeInLogs: boolean = true

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

`Protected` `Readonly`isLeaf

isLeaf: boolean

If this join operator will not invoke any other join or query operations below, and can therefore be considered a leaf of the join plan.

`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

`Protected` `Optional` `Readonly`requiresVariableOverlap

requiresVariableOverlap?: boolean

If this join operator must only be used for join entries with (at least partially) common variables.

Methods

constructResultMetadata

constructResultMetadata(
    entries: IJoinEntry[],
    metadatas: MetadataBindings[],
    context: IActionContext,
    partialMetadata?: Partial<MetadataBindings>,
    optional?: boolean,
): 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.
- optional: boolean = false
  If metadata for an optional operation must be calculated.
Returns Promise<MetadataBindings>
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:236

constructState

constructState(metadatas: MetadataBindings[]): MetadataValidationState
Construct a metadata validation state for the given metadata entries.
Parameters
- metadatas: MetadataBindings[]
  An array of checked metadata.
Returns MetadataValidationState
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:217

`Protected`getDefaultLogData

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

`Protected` `Abstract`getJoinCoefficients

getJoinCoefficients(
action: IActionRdfJoin,
sideData: IActorRdfJoinTestSideData,
): Promise<TestResult<IMediatorTypeJoinCoefficients, TS>>
Calculate the join coefficients.
Parameters
- action: IActionRdfJoin
  Join action
- sideData: IActorRdfJoinTestSideData
  The test side data.
Returns Promise<TestResult<IMediatorTypeJoinCoefficients, TS>>
The join coefficient estimates.
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:476

`Protected` `Abstract`getOutput

getOutput(
action: IActionRdfJoin,
sideData: IActorRdfJoinTestSideData,
): Promise<IActorRdfJoinOutputInner>
Returns the resulting output for joining the given entries. This is called after removing the trivial cases in run.
Parameters
- action: IActionRdfJoin
- sideData: IActorRdfJoinTestSideData
  Side data from the test method
Returns Promise<IActorRdfJoinOutputInner>
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:465

`Protected`logDebug

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

run

run(
action: IActionRdfJoin,
sideData: IActorRdfJoinTestSideData,
): Promise<IQueryOperationResultBindings>
Returns default input for 0 or 1 entries. Calls the getOutput function otherwise
Parameters
- action: IActionRdfJoin
- sideData: IActorRdfJoinTestSideData
  Side data from the test method
Returns Promise<IQueryOperationResultBindings>
A bindings result.
Overrides Actor.run
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:386

runObservable

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

test

test(
action: IActionRdfJoin,
): Promise<TestResult<IMediatorTypeJoinCoefficients, TS>>
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<TestResult<IMediatorTypeJoinCoefficients, TS>>
The join coefficients.
Overrides Actor.test
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:332

`Static`getCardinality

getCardinality(metadata: MetadataBindings): 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 bus-rdf-join/lib/ActorRdfJoin.ts:175

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

`Static`getEntriesWithMetadatas

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

`Static`getMetadatas

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

`Static`getRequestInitialTimes

getRequestInitialTimes(metadatas: MetadataBindings[]): 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 bus-rdf-join/lib/ActorRdfJoin.ts:200

`Static`getRequestItemTimes

getRequestItemTimes(metadatas: MetadataBindings[]): 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 bus-rdf-join/lib/ActorRdfJoin.ts:208

`Static`joinBindings

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

`Static`joinVariables

joinVariables(
    dataFactory: ComunicaDataFactory,
    metadatas: MetadataBindings[],
    optional?: boolean,
): MetadataVariable[]
Returns the variables that will occur in the joined bindings.
Parameters
- dataFactory: ComunicaDataFactory
  The data factory.
- metadatas: MetadataBindings[]
  An array of metadata objects for the entries.
- optional: boolean = false
  If an optional join is being performed.
Returns MetadataVariable[]
An array of joined variables.
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:127

`Static`overlappingVariables

overlappingVariables(metadatas: MetadataBindings[]): MetadataVariable[]
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 MetadataVariable[]
An array of variables.
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:99

`Static`sortJoinEntries

sortJoinEntries(
    mediatorJoinEntriesSort: MediatorRdfJoinEntriesSort,
    entries: IJoinEntryWithMetadata[],
    context: IActionContext,
): Promise<TestResult<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<TestResult<IJoinEntryWithMetadata[]>>
The sorted join entries.
- Defined in bus-rdf-join/lib/ActorRdfJoin.ts:286

Class ActorRdfJoin<TS>Abstract

See

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ActorRdfJoin<TS>

Default Nested

Default Nested

Properties

ReadonlybeforeActors

Readonlybus

Protected ReadonlycanHandleUndefs

includeInLogs

Protected ReadonlyisLeaf

Protected ReadonlylimitEntries

Protected ReadonlylimitEntriesMin

ReadonlylogicalType

ReadonlymediatorJoinSelectivity

Readonlyname

Default

ReadonlyphysicalName

Protected Optional ReadonlyrequiresVariableOverlap

Methods

constructResultMetadata

Parameters

Returns Promise<MetadataBindings>

constructState

Parameters

Returns MetadataValidationState

ProtectedgetDefaultLogData

Parameters

Returns any

Protected AbstractgetJoinCoefficients

Parameters

Returns Promise<TestResult<IMediatorTypeJoinCoefficients, TS>>

Protected AbstractgetOutput

Parameters

Returns Promise<IActorRdfJoinOutputInner>

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

runObservable

Parameters

Returns Promise<IQueryOperationResultBindings>

test

Parameters

Returns Promise<TestResult<IMediatorTypeJoinCoefficients, TS>>

StaticgetCardinality

Parameters

Returns QueryResultCardinality

StaticgetContextLogger

Parameters

Returns undefined | Logger

StaticgetEntriesWithMetadatas

Parameters

Class ActorRdfJoin<TS>`Abstract`

`Readonly`beforeActors

`Readonly`bus

`Protected` `Readonly`canHandleUndefs

`Protected` `Readonly`isLeaf

`Protected` `Readonly`limitEntries

`Protected` `Readonly`limitEntriesMin

`Readonly`logicalType

`Readonly`mediatorJoinSelectivity

`Readonly`name

`Readonly`physicalName

`Protected` `Optional` `Readonly`requiresVariableOverlap

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

`Static`joinVariables

`Static`overlappingVariables

`Static`sortJoinEntries