org.openrdf.query

Class TupleQueryResultHandlerBase

java.lang.Object

org.openrdf.query.TupleQueryResultHandlerBase

All Implemented Interfaces:

QueryResultHandler, TupleQueryResultHandler

Direct Known Subclasses:

TupleQueryResultBuilder

public class TupleQueryResultHandlerBase
extends Object
implements TupleQueryResultHandler

Base class for TupleQueryResultHandlers with dummy implementations of all methods. This class is a useful superclass for classes that implement only one or two TupleQueryResultHandler methods.

Constructor Summary

Constructors

Constructor and Description
TupleQueryResultHandlerBase()

Method Summary

Modifier and Type	Method and Description
void	endQueryResult() Indicates the end of a sequence of solutions.
void	handleBoolean(boolean value) Handles the specified boolean value.
void	handleLinks(List<String> linkUrls) Handles the links elements which are present in SPARQL Results JSON and SPARQL Results XML documents in the header.
void	handleSolution(BindingSet bindingSet) Handles a solution.
void	startQueryResult(List<String> bindingNames) Indicates the start of a sequence of Solutions.

Methods inherited from class java.lang.Object

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

Constructor Detail

TupleQueryResultHandlerBase

public TupleQueryResultHandlerBase()

Method Detail

startQueryResult

public void startQueryResult(List<String> bindingNames)
                      throws TupleQueryResultHandlerException

Description copied from interface: QueryResultHandler

Indicates the start of a sequence of Solutions. The supplied bindingNames are an indication of the values that are in the Solutions. For example, a SeRQL query like select X, Y from {X} P {Y} will have binding names X and Y.

Specified by:

startQueryResult in interface QueryResultHandler

Parameters:

bindingNames - An ordered set of binding names.

Throws:

TupleQueryResultHandlerException - If there was an error during the starting of the query result handler. This exception may be thrown if the QueryResultHandler.handleBoolean(boolean) method was called before this method and the handler cannot process both boolean and tuple results simultaneously.

endQueryResult

public void endQueryResult()
                    throws TupleQueryResultHandlerException

Description copied from interface: QueryResultHandler

Indicates the end of a sequence of solutions.

Specified by:

endQueryResult in interface QueryResultHandler

Throws:

TupleQueryResultHandlerException - If there was an error during the ending of the query result handler. This exception may be thrown if the QueryResultHandler.handleBoolean(boolean) method was called before this method and the handler cannot process both boolean and tuple results simultaneously.

handleSolution

public void handleSolution(BindingSet bindingSet)
                    throws TupleQueryResultHandlerException

Description copied from interface: QueryResultHandler

Handles a solution.

Specified by:

handleSolution in interface QueryResultHandler

Parameters:

bindingSet - A single set of tuple results, with binding names bound to values. Each of the binding names in the solution must have previously been registered with the QueryResultHandler.startQueryResult(List) method.

Throws:

TupleQueryResultHandlerException - If there was an error during the handling of the query solution. This exception may be thrown if the QueryResultHandler.handleBoolean(boolean) method was called before this method and the handler cannot process both boolean and tuple results simultaneously.

handleBoolean

public void handleBoolean(boolean value)
                   throws QueryResultHandlerException

Description copied from interface: QueryResultHandler

Handles the specified boolean value.

Specified by:

handleBoolean in interface QueryResultHandler

Parameters:

value - The boolean value to handle.

Throws:

QueryResultHandlerException - If there was an error during the handling of this value. This exception may be thrown if the QueryResultHandler.startQueryResult(List), QueryResultHandler.handleSolution(BindingSet) or QueryResultHandler.endQueryResult() methods were called before this method was called, and the handler cannot process both boolean and tuple results simultaneously.

handleLinks

public void handleLinks(List<String> linkUrls)
                 throws QueryResultHandlerException

Description copied from interface: QueryResultHandler

Handles the links elements which are present in SPARQL Results JSON and SPARQL Results XML documents in the header.

NOTE: If the format does not support links, it must silently ignore a call to this method.

An accumulating handler should accumulate these links.

Specified by:

handleLinks in interface QueryResultHandler

Parameters:

linkUrls - The URLs of the links to handle.

Throws:

QueryResultHandlerException - If there was an error handling the set of link URLs. This error is not thrown in cases where links are not supported.

See Also:

"link"