Class ActorQueryOperationPathNps

ReadonlybeforeActors

Readonlybus

ReadonlymediatorQueryOperation

Readonlyname

{<rdf:subject>}
Copy

ReadonlyoperationName

assignPatternSources

• assignPatternSources(
      algebraFactory: Factory,
      pattern: Pattern,
      sources: IQuerySourceWrapper<IQuerySource>[],
  ): Operation

• Parameters

  • algebraFactory: Factory
  • pattern: Pattern
  • sources: IQuerySourceWrapper<IQuerySource>[]

  Returns Operation

generateVariable

• generateVariable(
      dataFactory: ComunicaDataFactory,
      path?: Path,
      name?: string,
  ): Variable

• Parameters

  • dataFactory: ComunicaDataFactory
  • Optionalpath: Path
  • Optionalname: string

  Returns Variable

getObjectsPredicateStar

• getObjectsPredicateStar(
      algebraFactory: Factory,
      object: Term,
      predicate: PropertyPathSymbol,
      graph: Term,
      context: IActionContext,
      termHashes: Record<string, Term>,
      it: BufferedIterator<Term>,
      counter: any,
  ): Promise<undefined | () => Promise<MetadataBindings>>

• Pushes all terms to iterator it that are a solution of object predicate* ?o.

  Parameters

  • algebraFactory: Factory

    The algebra factory.
  • object: Term

    Term of where we start the predicate* search.
  • predicate: PropertyPathSymbol

    Predicate of the *-path.
  • graph: Term

    The graph in which we search for the pattern.
  • context: IActionContext
  • termHashes: Record<string, Term>

    Remembers the objects we've already searched for.
  • it: BufferedIterator<Term>

    Iterator to push terms to.
  • counter: any

    Counts how many searches are in progress to close it when needed (when counter == 0).

  Returns Promise<undefined | () => Promise<MetadataBindings>>

  The results metadata.

getObjectsPredicateStarEval

• getObjectsPredicateStarEval(
      subject: Term,
      predicate: PropertyPathSymbol,
      object: Variable,
      graph: Term,
      context: IActionContext,
      emitFirstSubject: boolean,
      algebraFactory: Factory,
      bindingsFactory: BindingsFactory,
  ): Promise<IPathResultStream>

• Returns an iterator with Bindings of the query subject predicate* ?o or subject predicate+ ?o If graph is a variable, it will also be in those bindings

  Parameters

  • subject: Term

    Term of where we start the predicate* search.
  • predicate: PropertyPathSymbol

    Predicate of the *-path.
  • object: Variable

    Variable of the zeroOrMore-query.
  • graph: Term

    The graph in which we search for the pattern. (Possibly a variable)
  • context: IActionContext

    The context to pass to sub-opertations
  • emitFirstSubject: boolean

    If the path operation is predicate*, otherwise it is predicate+.
  • algebraFactory: Factory

    The algebra factory.
  • bindingsFactory: BindingsFactory

    The data factory.

  Returns Promise<IPathResultStream>

  Iterator to where all bindings of query should have been pushed.

getPathSources

• getPathSources(
      operation: PropertyPathSymbol,
  ): IQuerySourceWrapper<IQuerySource>[]

• Find all sources recursively contained in the given path operation.

  Parameters

  • operation: PropertyPathSymbol

  Returns IQuerySourceWrapper<IQuerySource>[]

getSubjectAndObjectBindingsPredicateStar

• getSubjectAndObjectBindingsPredicateStar(
      subjectVar: Variable,
      objectVar: Variable,
      subjectVal: Term,
      objectVal: Term,
      predicate: PropertyPathSymbol,
      graph: Term,
      context: IActionContext,
      termHashesGlobal: Record<string, Promise<Term[]>>,
      termHashesCurrentSubject: Record<string, boolean>,
      it: BufferedIterator<Bindings>,
      counter: any,
      algebraFactory: Factory,
      bindingsFactory: BindingsFactory,
  ): Promise<void>

• Pushes all terms to iterator it that are a solution of ?s predicate* ?o.

  Parameters

  • subjectVar: Variable

    String representation of subjectVariable
  • objectVar: Variable

    String representation of objectVariable
  • subjectVal: Term

    Term of where we start the predicate* search.
  • objectVal: Term

    Found solution for an object, start for the new step.
  • predicate: PropertyPathSymbol

    Predicate of the *-path.
  • graph: Term

    The graph in which we search for the pattern.
  • context: IActionContext
  • termHashesGlobal: Record<string, Promise<Term[]>>

    Remembers solutions for when objectVal is already been calculated, can be reused when same objectVal occurs
  • termHashesCurrentSubject: Record<string, boolean>

    Remembers the pairs we've already searched for, can stop searching if so.
  • it: BufferedIterator<Bindings>

    Iterator to push terms to.
  • counter: any

    Counts how many searches are in progress to close it when needed (when counter == 0).
  • algebraFactory: Factory

    The algebra factory.
  • bindingsFactory: BindingsFactory

    The bindings factory.

  Returns Promise<void>

  All solutions of query should have been pushed to it by then.

isPathArbitraryLengthDistinct

• isPathArbitraryLengthDistinct(
      algebraFactory: Factory,
      context: IActionContext,
      path: Path,
  ): Promise<
      {
          context: IActionContext;
          operation: undefined
          | IQueryOperationResultBindings;
      },
  >

• Parameters

  • algebraFactory: Factory
  • context: IActionContext
  • path: Path

  Returns Promise<
      {
          context: IActionContext;
          operation: undefined
          | IQueryOperationResultBindings;
      },
  >

run

• run(
      action: IActionQueryOperation,
      sideData: undefined,
  ): Promise<IQueryOperationResult>

• Run the given action on this actor.

  In most cases, this method should not be called directly. Instead, #runObservable should be called.

  Parameters

  • action: IActionQueryOperation

    The action to run.
  • sideData: undefined

  Returns Promise<IQueryOperationResult>

  A promise that resolves to the run result.

runObservable

• runObservable(
      action: IActionQueryOperation,
      sideData: undefined,
  ): Promise<IQueryOperationResult>

• Run the given action on this actor AND invokes the Bus#onRun method.

  Parameters

  • action: IActionQueryOperation

    The action to run.
  • sideData: undefined

  Returns Promise<IQueryOperationResult>

  A promise that resolves to the run result.

test

• test(action: IActionQueryOperation): Promise<TestResult<IActorTest, undefined>>

• Check if this actor can run the given action, without actually running it.

  Parameters

  • action: IActionQueryOperation

    The action to test.

  Returns Promise<TestResult<IActorTest, undefined>>

  A promise that resolves to the test result.

testOperation

• testOperation(
      operation: Path,
      _context: IActionContext,
  ): Promise<TestResult<IActorTest>>

• Parameters

  • operation: Path
  • _context: IActionContext

  Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

• 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.