Class AbstractTupleQueryResultParser

java.lang.Object

org.eclipse.rdf4j.query.resultio.AbstractQueryResultParser

org.eclipse.rdf4j.query.resultio.AbstractTupleQueryResultParser

All Implemented Interfaces:

QueryResultParser, TupleQueryResultParser

Direct Known Subclasses:

BinaryQueryResultParser, SPARQLResultsCSVParser, SPARQLResultsTSVParser

public abstract class AbstractTupleQueryResultParser
extends AbstractQueryResultParser
implements TupleQueryResultParser

Base class for TupleQueryResultParsers offering common functionality for query result parsers.

Field Summary

Fields inherited from class AbstractQueryResultParser

handler, valueFactory

Modifier and Type	Field	Description
protected QueryResultHandler	handler	The QueryResultHandler that will handle the parsed query results.
protected ValueFactory	valueFactory	The ValueFactory to use for creating RDF model objects.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTupleQueryResultParser()	Creates a new parser base that, by default, will use an instance of SimpleValueFactory to create Value objects.
protected	AbstractTupleQueryResultParser(ValueFactory valueFactory)	Creates a new parser base that will use the supplied ValueFactory to create Value objects.

Method Summary

Modifier and Type	Method	Description
QueryResultFormat	getQueryResultFormat()	Gets the query result format that this parser can parse.
void	parseQueryResult(InputStream in)	Parse the query results out of the given InputStream into the handler setup using QueryResultParser.setQueryResultHandler(QueryResultHandler).
void	setTupleQueryResultHandler(TupleQueryResultHandler handler)	Sets the TupleQueryResultHandler that will handle the parsed query result data.

Methods inherited from class AbstractQueryResultParser

getParseErrorListener, getParseLocationListener, getParserConfig, getSupportedSettings, set, setParseErrorListener, setParseLocationListener, setParserConfig, setQueryResultHandler, setValueFactory

Modifier and Type	Method	Description
ParseErrorListener	getParseErrorListener()
ParseLocationListener	getParseLocationListener()
ParserConfig	getParserConfig()	Retrieves the current parser configuration as a single object.
Collection<RioSetting<?>>	getSupportedSettings()
<T> QueryResultParser	set(RioSetting<T> setting, T value)	Set a setting on the parser, and return this parser object to allow chaining.
QueryResultParser	setParseErrorListener(ParseErrorListener el)	Sets the ParseErrorListener that will be notified of any errors that this parser finds during parsing.
QueryResultParser	setParseLocationListener(ParseLocationListener el)	Sets the ParseLocationListener that will be notified of the parser's progress during the parse process.
QueryResultParser	setParserConfig(ParserConfig config)	Sets all supplied parser configuration options.
QueryResultParser	setQueryResultHandler(QueryResultHandler handler)	Sets the QueryResultHandler to be used when parsing query results using QueryResultParser.parseQueryResult(InputStream).
QueryResultParser	setValueFactory(ValueFactory valueFactory)	Sets the ValueFactory that the parser will use to create Value objects for the parsed query result.

Methods inherited from class Object

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

Methods inherited from interface TupleQueryResultParser

getTupleQueryResultFormat, parse

Modifier and Type	Method	Description
TupleQueryResultFormat	getTupleQueryResultFormat()	Gets the query result format that this parser can parse.
void	parse(InputStream in)	Deprecated. Use QueryResultParser.parseQueryResult(InputStream) instead.

Constructor Details

AbstractTupleQueryResultParser

protected AbstractTupleQueryResultParser()

Creates a new parser base that, by default, will use an instance of SimpleValueFactory to create Value objects.

AbstractTupleQueryResultParser

protected AbstractTupleQueryResultParser(ValueFactory valueFactory)

Creates a new parser base that will use the supplied ValueFactory to create Value objects.

Method Details

getQueryResultFormat

public QueryResultFormat getQueryResultFormat()

Description copied from interface: QueryResultParser

Gets the query result format that this parser can parse.

Specified by:

getQueryResultFormat in interface QueryResultParser

Returns:

The QueryResultFormat supported by this parser.

parseQueryResult

public void parseQueryResult(InputStream in)
                      throws IOException,
QueryResultParseException,
QueryResultHandlerException

Description copied from interface: QueryResultParser

Parse the query results out of the given InputStream into the handler setup using QueryResultParser.setQueryResultHandler(QueryResultHandler).

Specified by:

parseQueryResult in interface QueryResultParser

Parameters:

in - The InputStream to parse the results from.

Throws:

IOException - If there is an exception from the InputStream.

QueryResultParseException - If the query results are not parsable by this parser.

QueryResultHandlerException - If the QueryResultHandler set in QueryResultParser.setQueryResultHandler(QueryResultHandler) throws an exception.

setTupleQueryResultHandler

public void setTupleQueryResultHandler(TupleQueryResultHandler handler)

Description copied from interface: TupleQueryResultParser

Sets the TupleQueryResultHandler that will handle the parsed query result data.

Specified by:

setTupleQueryResultHandler in interface TupleQueryResultParser