Class ActorRdfJoinEntriesSortTraversalZeroKnowledge

An actor that sorts join entries based on Hartig's heuristic for plan selection in link traversal environments.

It first determines isolated connected graphs. (done by @comunica/actor-optimize-query-operation-join-connected) For each of the connected graphs, it orders triple patterns in BGPs by the following priority:

dependency-respecting: for each (non-first) pattern, at least one variable must occur in a preceding pattern.
seed: try to make the first pattern contain a source URI.
no vocab seed: avoid first triple pattern with vocab URI (variable predicate, or variable objects with rdf:type predicate)
filtering: patterns only containing variables also contained in preceding triple patterns are placed as soon as possible.

It does this in an adaptive way. This means that this actor will only determine the first triple pattern, execute it, and materialize the remaining BGP based on its results. After that, the remaining BGP is evaluated recursively by this or another BGP actor.

Hierarchy

ActorRdfJoinEntriesSort
- ActorRdfJoinEntriesSortTraversalZeroKnowledge

Index

Constructors

constructor

new ActorRdfJoinEntriesSortTraversalZeroKnowledge(
    args: IActorArgs<
        IActionRdfJoinEntriesSort,
        IActorRdfJoinEntriesSortTest,
        IActorRdfJoinEntriesSortOutput,
    >,
): ActorRdfJoinEntriesSortTraversalZeroKnowledge
Parameters
- args: IActorArgs<
      IActionRdfJoinEntriesSort,
      IActorRdfJoinEntriesSortTest,
      IActorRdfJoinEntriesSortOutput,
  >
Returns ActorRdfJoinEntriesSortTraversalZeroKnowledge
Overrides ActorRdfJoinEntriesSort.constructor
- Defined in packages/actor-rdf-join-entries-sort-traversal-zero-knowledge/lib/ActorRdfJoinEntriesSortTraversalZeroKnowledge.ts:34

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionRdfJoinEntriesSort,
    IActorRdfJoinEntriesSortTest,
    IActorRdfJoinEntriesSortOutput,
    undefined,
>[]

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

`Readonly`bus

bus: Bus<
    Actor<
        IActionRdfJoinEntriesSort,
        IActorRdfJoinEntriesSortTest,
        IActorRdfJoinEntriesSortOutput,
        undefined,
    >,
    IActionRdfJoinEntriesSort,
    IActorRdfJoinEntriesSortTest,
    IActorRdfJoinEntriesSortOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

Methods

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorRdfJoinEntriesSort.getDefaultLogData
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:69

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfJoinEntriesSort.logDebug
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:71

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfJoinEntriesSort.logError
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:74

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfJoinEntriesSort.logFatal
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:75

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfJoinEntriesSort.logInfo
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:72

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfJoinEntriesSort.logTrace
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:70

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfJoinEntriesSort.logWarn
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:73

run

run(action: IActionRdfJoinEntriesSort): Promise<IActorRdfJoinEntriesSortOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionRdfJoinEntriesSort
  The action to run.
Returns Promise<IActorRdfJoinEntriesSortOutput>
A promise that resolves to the run result.
Overrides ActorRdfJoinEntriesSort.run
- Defined in packages/actor-rdf-join-entries-sort-traversal-zero-knowledge/lib/ActorRdfJoinEntriesSortTraversalZeroKnowledge.ts:146

runObservable

runObservable(
action: IActionRdfJoinEntriesSort,
sideData: undefined,
): Promise<IActorRdfJoinEntriesSortOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionRdfJoinEntriesSort
  The action to run.
- sideData: undefined
Returns Promise<IActorRdfJoinEntriesSortOutput>
A promise that resolves to the run result.
Inherited from ActorRdfJoinEntriesSort.runObservable
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:68

test

test(
_action: IActionRdfJoinEntriesSort,
): Promise<TestResult<IActorRdfJoinEntriesSortTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionRdfJoinEntriesSort
Returns Promise<TestResult<IActorRdfJoinEntriesSortTest>>
A promise that resolves to the test result.
Overrides ActorRdfJoinEntriesSort.test
- Defined in packages/actor-rdf-join-entries-sort-traversal-zero-knowledge/lib/ActorRdfJoinEntriesSortTraversalZeroKnowledge.ts:142

`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 ActorRdfJoinEntriesSort.getContextLogger
- Defined in node_modules/@comunica/core/lib/Actor.d.ts:42

`Static`getPatternNonVocabUris

getPatternNonVocabUris(pattern: Pattern | Path): NamedNode<string>[]
Obtain all IRIs from the given pattern that are not related to vocabularies. Concretely, predicates will be omitted, and objects if predicate is http://www.w3.org/1999/02/22-rdf-syntax-ns#type
Parameters
- pattern: Pattern | Path
  A quad pattern.
Returns NamedNode<string>[]
- Defined in packages/actor-rdf-join-entries-sort-traversal-zero-knowledge/lib/ActorRdfJoinEntriesSortTraversalZeroKnowledge.ts:45

`Static`getScoreSeedNonVocab

getScoreSeedNonVocab(pattern: Pattern | Path, sources: string[]): number
Calculate a score for the given quad pattern based on a given set of sources. The more sources are present in the given pattern as non-vocab URIs, the higher the score.
Parameters
- pattern: Pattern | Path
  A quad pattern.
- sources: string[]
  An array of sources.
Returns number
- Defined in packages/actor-rdf-join-entries-sort-traversal-zero-knowledge/lib/ActorRdfJoinEntriesSortTraversalZeroKnowledge.ts:97

`Static`getScoreSelectivity

getScoreSelectivity(pattern: Pattern | Path): number
Determine a score for the selectivity of the given pattern. The fewer variables, the higher the score.
Parameters
- pattern: Pattern | Path
  A quad pattern.
Returns number
- Defined in packages/actor-rdf-join-entries-sort-traversal-zero-knowledge/lib/ActorRdfJoinEntriesSortTraversalZeroKnowledge.ts:109

`Static`getSourceUri

getSourceUri(namedNode: NamedNode): string
Determine the source IRI of a given IRI without hash.
Parameters
- namedNode: NamedNode
  An IRI.
Returns string
- Defined in packages/actor-rdf-join-entries-sort-traversal-zero-knowledge/lib/ActorRdfJoinEntriesSortTraversalZeroKnowledge.ts:85

`Static`sortJoinEntries

sortJoinEntries(
entries: IJoinEntryWithMetadata[],
sources: string[],
): IJoinEntryWithMetadata[]
This sorts join entries by first prioritizing triple patterns in BGPs, and then all other operation types.

Sort the patterns in BGPs by the following priorities:
1. A source in S or O (not O if rdf:type) (seed rule, no vocab rule)
2. Most selective: fewest variables (filtering rule, dependency-respecting rule)
Parameters
- entries: IJoinEntryWithMetadata[]
  Quad patterns.
- sources: string[]
  The sources that are currently being queried.
Returns IJoinEntryWithMetadata[]
- Defined in packages/actor-rdf-join-entries-sort-traversal-zero-knowledge/lib/ActorRdfJoinEntriesSortTraversalZeroKnowledge.ts:123

Class ActorRdfJoinEntriesSortTraversalZeroKnowledge

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorRdfJoinEntriesSortTraversalZeroKnowledge

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

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

runObservable

Parameters

Returns Promise<IActorRdfJoinEntriesSortOutput>

test

Parameters

Returns Promise<TestResult<IActorRdfJoinEntriesSortTest>>

StaticgetContextLogger

Parameters

Returns Logger | undefined

StaticgetPatternNonVocabUris

Parameters

Returns NamedNode<string>[]

StaticgetScoreSeedNonVocab

Parameters

Returns number

StaticgetScoreSelectivity

Parameters

Returns number

StaticgetSourceUri

Parameters

Returns string

StaticsortJoinEntries

Parameters

Returns IJoinEntryWithMetadata[]

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Protected`getDefaultLogData

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger

`Static`getPatternNonVocabUris

`Static`getScoreSeedNonVocab

`Static`getScoreSelectivity

`Static`getSourceUri

`Static`sortJoinEntries