Package fr.mines_stetienne.ci.sparql_generate.iterator

Class IteratorStreamFunctionBase

java.lang.Object
fr.mines_stetienne.ci.sparql_generate.iterator.IteratorStreamFunctionBase
All Implemented Interfaces:
IteratorFunction
Direct Known Subclasses:
ITER_Call_Select, ITER_CSV, ITER_HTTPGet, ITER_JSONSurfer, ITER_MQTTSubscribe, ITER_WebSocket, IteratorFunctionBase, IteratorStreamFunctionBase0, IteratorStreamFunctionBase1, IteratorStreamFunctionBase2, IteratorStreamFunctionBase3, IteratorStreamFunctionBase4, IteratorStreamFunctionBase5, SPARQLExtIteratorFunction
public abstract class IteratorStreamFunctionBase extends Object implements IteratorFunction
The base implementation of the IteratorFunction interface.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.apache.jena.sparql.expr.ExprList
    arguments
    The list of argument expressions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IteratorStreamFunctionBase()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    build(org.apache.jena.sparql.expr.ExprList args)
    Build a iterator function execution with the given arguments, and operate a check of the build.
    abstract void
    checkBuild(org.apache.jena.sparql.expr.ExprList args)
    Partially checks if the iterator function can be executed with the given arguments.
    abstract void
    exec(List<org.apache.jena.sparql.expr.NodeValue> args, Consumer<List<List<org.apache.jena.sparql.expr.NodeValue>>> collectionListNodeValue)
    IteratorFunction call to a list of evaluated argument values.
    final void
    exec(org.apache.jena.sparql.engine.binding.Binding binding, org.apache.jena.sparql.expr.ExprList args, org.apache.jena.sparql.function.FunctionEnv env, Consumer<List<List<org.apache.jena.sparql.expr.NodeValue>>> collectionListNodeValue)
    Test a list of values - argument will not be null but may have the wrong number of arguments.
    final org.apache.jena.sparql.util.Context
    getContext()
    Return the Context object for this execution.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • arguments

      protected org.apache.jena.sparql.expr.ExprList arguments
      The list of argument expressions.

  • Constructor Details

    • IteratorStreamFunctionBase

      public IteratorStreamFunctionBase()

  • Method Details

    • build

      public final void build(org.apache.jena.sparql.expr.ExprList args)
      Build a iterator function execution with the given arguments, and operate a check of the build.
      Specified by:
      build in interface IteratorFunction
      Parameters:
      args - -
      Throws:
      org.apache.jena.query.QueryBuildException - if the iterator function cannot be executed with the given arguments.

    • checkBuild

      public abstract void checkBuild(org.apache.jena.sparql.expr.ExprList args)
      Partially checks if the iterator function can be executed with the given arguments.
      Parameters:
      args - -
      Throws:
      org.apache.jena.query.QueryBuildException - if the iterator function cannot be executed with the given arguments.

    • exec

      public final void exec(org.apache.jena.sparql.engine.binding.Binding binding, org.apache.jena.sparql.expr.ExprList args, org.apache.jena.sparql.function.FunctionEnv env, Consumer<List<List<org.apache.jena.sparql.expr.NodeValue>>> collectionListNodeValue)
      Description copied from interface: IteratorFunction
      Test a list of values - argument will not be null but may have the wrong number of arguments. FunctionBase provides a more convenient way to implement a function. Can throw ExprEvalsException if something goes wrong.
      Specified by:
      exec in interface IteratorFunction
      Parameters:
      binding - The current solution
      args - A list of unevaluated expressions
      env - The execution context
      collectionListNodeValue - where to emit new values

    • getContext

      public final org.apache.jena.sparql.util.Context getContext()
      Return the Context object for this execution.
      Returns:
      -

    • exec

      public abstract void exec(List<org.apache.jena.sparql.expr.NodeValue> args, Consumer<List<List<org.apache.jena.sparql.expr.NodeValue>>> collectionListNodeValue)
      IteratorFunction call to a list of evaluated argument values.
      Parameters:
      args - -
      collectionListNodeValue - - where to emit collections of nodevalues