Package org.apache.jena.sparql.procedure

Class ProcedureBase

java.lang.Object

org.apache.jena.sparql.util.PrintSerializableBase

org.apache.jena.sparql.procedure.ProcedureBase

All Implemented Interfaces:

org.apache.jena.atlas.io.Printable, Procedure, PrintSerializable

Direct Known Subclasses:

ProcedureEval

public abstract class ProcedureBase
extends PrintSerializableBase
implements Procedure

Constructor Summary

Constructors

Constructor	Description
ProcedureBase()

Method Summary

Modifier and Type	Method	Description
void	build(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, Node name, ExprList args, ExecutionContext execCxt)
void	output(org.apache.jena.atlas.io.IndentedWriter out, SerializationContext sCxt)
QueryIterator	proc(QueryIterator input, ExecutionContext execCxt)	Call the procedure, with an input iterator of bindings.

Methods inherited from class org.apache.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 org.apache.jena.atlas.io.Printable

output

Methods inherited from interface org.apache.jena.sparql.util.PrintSerializable

toString

Constructor Detail

ProcedureBase

public ProcedureBase()

Method Detail

build

public void build(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,
                                   Node name,
                                   ExprList args,
                                   ExecutionContext execCxt)

output

public void output(org.apache.jena.atlas.io.IndentedWriter out,
                   SerializationContext sCxt)

Specified by:

output in interface PrintSerializable