com.hp.hpl.jena.sparql.procedure
Class ProcedureBase

java.lang.Object
  extended by com.hp.hpl.jena.sparql.util.PrintSerializableBase
      extended by com.hp.hpl.jena.sparql.procedure.ProcedureBase
All Implemented Interfaces:
Procedure, PrintSerializable, Printable
Direct Known Subclasses:
ProcedureEval

public abstract class ProcedureBase
extends PrintSerializableBase
implements Procedure


Constructor Summary
ProcedureBase()
           
 
Method Summary
 void build(com.hp.hpl.jena.graph.Node procId, ExprList args, ExecutionContext execCxt)
          Called during query plan construction immediately after the construction of the property function instance.
abstract  QueryIterator exec(Binding binding, com.hp.hpl.jena.graph.Node name, ExprList args, ExecutionContext execCxt)
           
 void output(IndentedWriter out, SerializationContext sCxt)
           
 QueryIterator proc(QueryIterator input, ExecutionContext execCxt)
          Call the procedure, with an input iterator of bindings.
 
Methods inherited from class com.hp.hpl.jena.sparql.util.PrintSerializableBase
output, toString, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.hp.hpl.jena.sparql.util.PrintSerializable
toString
 
Methods inherited from interface org.openjena.atlas.io.Printable
output
 

Constructor Detail

ProcedureBase

public ProcedureBase()
Method Detail

build

public void build(com.hp.hpl.jena.graph.Node procId,
                  ExprList args,
                  ExecutionContext execCxt)
Description copied from interface: Procedure
Called during query plan construction immediately after the construction of the property function instance.

Specified by:
build in interface Procedure
Parameters:
procId - The procedure identifier (usually a URI)
args - The argument list (unevaluated expressions)
execCxt - Execution context

proc

public final QueryIterator proc(QueryIterator input,
                                ExecutionContext execCxt)
Description copied from interface: Procedure
Call the procedure, with an input iterator of bindings. Implementations can inherit from the convenience form ProcEval which calls repeated for each binding.

Specified by:
proc in interface Procedure
Parameters:
input - QueryIterator from the previous stage
execCxt - The execution context
Returns:
QueryIterator

exec

public abstract QueryIterator exec(Binding binding,
                                   com.hp.hpl.jena.graph.Node name,
                                   ExprList args,
                                   ExecutionContext execCxt)

output

public void output(IndentedWriter out,
                   SerializationContext sCxt)
Specified by:
output in interface PrintSerializable


Licenced under the Apache License, Version 2.0