org.openrdf.query.resultio

Interface QueryResultParser

All Known Subinterfaces:

BooleanQueryResultParser, TupleQueryResultParser

All Known Implementing Classes:

AbstractQueryResultParser, AbstractSPARQLJSONParser, AbstractSPARQLXMLParser, AbstractTupleQueryResultParser, BinaryQueryResultParser, BooleanTextParser, QueryResultParserBase, SPARQLBooleanJSONParser, SPARQLBooleanXMLParser, SPARQLJSONParserBase, SPARQLResultsCSVParser, SPARQLResultsJSONParser, SPARQLResultsTSVParser, SPARQLResultsXMLParser, SPARQLXMLParserBase, TupleQueryResultParserBase

public interface QueryResultParser

Base interface for parsers of query results in both boolean and tuple forms.

Since:

2.7.0

Author:

Peter Ansell

Method Summary

Modifier and Type	Method and Description
ParserConfig	getParserConfig() Retrieves the current parser configuration as a single object.
QueryResultFormat	getQueryResultFormat() Gets the query result format that this parser can parse.
Collection<RioSetting<?>>	getSupportedSettings()
void	parseQueryResult(InputStream in) Parse the query results out of the given InputStream into the handler setup using setQueryResultHandler(QueryResultHandler).
void	setParserConfig(ParserConfig config) Sets all supplied parser configuration options.
void	setQueryResultHandler(QueryResultHandler handler) Sets the QueryResultHandler to be used when parsing query results using parseQueryResult(InputStream).
void	setValueFactory(ValueFactory valueFactory) Sets the ValueFactory that the parser will use to create Value objects for the parsed query result.

Method Detail

getQueryResultFormat

QueryResultFormat getQueryResultFormat()

Gets the query result format that this parser can parse.

Returns:

The QueryResultFormat supported by this parser.

Since:

2.7.0

setQueryResultHandler

void setQueryResultHandler(QueryResultHandler handler)

Sets the QueryResultHandler to be used when parsing query results using parseQueryResult(InputStream).

Parameters:

handler - The QueryResultHandler to use for handling results.

Since:

2.7.0

setValueFactory

void setValueFactory(ValueFactory valueFactory)

Sets the ValueFactory that the parser will use to create Value objects for the parsed query result.

Parameters:

valueFactory - The value factory that the parser should use.

parseQueryResult

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

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

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 setQueryResultHandler(QueryResultHandler) throws an exception.

Since:

2.7.0

setParserConfig

void setParserConfig(ParserConfig config)

Sets all supplied parser configuration options.

Parameters:

config - a parser configuration object.

Since:

2.7.0

getParserConfig

ParserConfig getParserConfig()

Retrieves the current parser configuration as a single object.

Returns:

a parser configuration object representing the current configuration of the parser.

Since:

2.7.0

getSupportedSettings

Collection<RioSetting<?>> getSupportedSettings()

Returns:

A collection of RioSettings that are supported by this QueryResultParser.

Since:

2.7.0