Package org.eclipse.rdf4j.query.resultio.helpers

Class QueryResultCollector

java.lang.Object

org.eclipse.rdf4j.query.resultio.helpers.QueryResultCollector

All Implemented Interfaces:

BooleanQueryResultHandler, QueryResultHandler, TupleQueryResultHandler

public class QueryResultCollector
extends Object
implements QueryResultHandler, TupleQueryResultHandler, BooleanQueryResultHandler

An implementation of the QueryResultHandler interface that is able to collect a single result from either Boolean or Tuple results simultaneously.

The Lists that are returned by this interface are immutable.

Author:

Peter Ansell

Constructor Summary

Constructors

Constructor	Description
QueryResultCollector()

Method Summary

Modifier and Type	Method	Description
void	endQueryResult()
List<String>	getBindingNames()	Returns a collection of binding names collected.
List<BindingSet>	getBindingSets()
boolean	getBoolean()	If getHandledBoolean() returns true this method returns the boolean that was last found using handleBoolean(boolean)
boolean	getHandledBoolean()	Determines whether handleBoolean(boolean) was called for this collector.
boolean	getHandledTuple()	Determines whether endQueryResult() was called after the last calls to startQueryResult(List) and optionally calls to handleSolution(BindingSet).
List<String>	getLinks()
void	handleBoolean(boolean value)
void	handleLinks(List<String> linkUrls)
void	handleSolution(BindingSet bindingSet)
void	startQueryResult(List<String> bindingNames)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryResultCollector

public QueryResultCollector()

Method Detail

handleBoolean

public void handleBoolean(boolean value)
                   throws QueryResultHandlerException

Specified by:

handleBoolean in interface QueryResultHandler

Throws:

QueryResultHandlerException

startQueryResult

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

Specified by:

startQueryResult in interface QueryResultHandler

Throws:

TupleQueryResultHandlerException

handleSolution

public void handleSolution(BindingSet bindingSet)
                    throws TupleQueryResultHandlerException

Specified by:

handleSolution in interface QueryResultHandler

Throws:

TupleQueryResultHandlerException

endQueryResult

public void endQueryResult()
                    throws TupleQueryResultHandlerException

Specified by:

endQueryResult in interface QueryResultHandler

Throws:

TupleQueryResultHandlerException

handleLinks

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

Specified by:

handleLinks in interface QueryResultHandler

Throws:

QueryResultHandlerException

getHandledBoolean

public boolean getHandledBoolean()

Determines whether handleBoolean(boolean) was called for this collector.

Returns:

True if there was a boolean handled by this collector.

getBoolean

public boolean getBoolean()
                   throws QueryResultHandlerException

If getHandledBoolean() returns true this method returns the boolean that was last found using handleBoolean(boolean)

If getHandledBoolean() returns false this method throws a QueryResultHandlerException indicating that a response could not be provided.

Returns:

The boolean value that was collected.

Throws:

QueryResultHandlerException - If there was no boolean value collected.

getHandledTuple

public boolean getHandledTuple()

Determines whether endQueryResult() was called after the last calls to startQueryResult(List) and optionally calls to handleSolution(BindingSet).

Returns:

True if there was a call to endQueryResult() after the last calls to startQueryResult(List) and handleSolution(BindingSet).

getBindingNames

public List<String> getBindingNames()
                             throws QueryResultHandlerException

Returns a collection of binding names collected.

Returns:

An immutable list of Strings that were collected as the binding names.

Throws:

QueryResultHandlerException - If the tuple results set was not successfully collected, as signalled by a call to endQueryResult().

getBindingSets

public List<BindingSet> getBindingSets()
                                throws QueryResultHandlerException

Returns:

An immutable list of BindingSets that were collected as the tuple results.

Throws:

QueryResultHandlerException - If the tuple results set was not successfully collected, as signalled by a call to endQueryResult().

getLinks

public List<String> getLinks()

Returns:

A list of links accumulated from calls to handleLinks(List).