Class SPARQLResultsXMLParser

java.lang.Object

org.eclipse.rdf4j.query.resultio.AbstractQueryResultParser

org.eclipse.rdf4j.query.resultio.sparqlxml.AbstractSPARQLXMLParser

org.eclipse.rdf4j.query.resultio.sparqlxml.SPARQLResultsXMLParser

All Implemented Interfaces:

QueryResultParser, TupleQueryResultParser, ErrorHandler

Direct Known Subclasses:

SPARQLStarResultsXMLParser

public class SPARQLResultsXMLParser
extends AbstractSPARQLXMLParser
implements TupleQueryResultParser

Parser for reading tuple query results formatted as SPARQL Results Documents. See SPARQL Query Results XML Format for the definition of this format. The parser assumes that the XML is wellformed.

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

Constructor	Description
SPARQLResultsXMLParser()	Creates a new parser for the SPARQL Query Results XML Format that will use an instance of SimpleValueFactory to create Value objects.
SPARQLResultsXMLParser(ValueFactory valueFactory)	Creates a new parser for the SPARQL Query Results XML Format 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.
TupleQueryResultFormat	getTupleQueryResultFormat()	Gets the query result format that this parser can parse.
void	parse(InputStream in)	Deprecated.
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 AbstractSPARQLXMLParser

error, fatalError, getCompulsoryXmlFeatureSettings, getCompulsoryXmlPropertySettings, getOptionalXmlFeatureSettings, getOptionalXmlPropertySettings, getSupportedSettings, parseQueryResultInternal, reportWarning, warning

Modifier and Type	Method	Description
void	error(SAXParseException exception)
void	fatalError(SAXParseException exception)
Collection<RioSetting<Boolean>>	getCompulsoryXmlFeatureSettings()	Returns a collection of settings that will always be set as XML parser features using XMLReader.setFeature(String, boolean).
Collection<RioSetting<?>>	getCompulsoryXmlPropertySettings()	Returns a collection of settings that will always be set as XML parser properties using XMLReader.setProperty(String, Object)
Collection<RioSetting<Boolean>>	getOptionalXmlFeatureSettings()	Returns a collection of settings that will be used, if set in AbstractQueryResultParser.getParserConfig(), as XML parser features using XMLReader.setFeature(String, boolean).
Collection<RioSetting<?>>	getOptionalXmlPropertySettings()	Returns a collection of settings that will be used, if set in AbstractQueryResultParser.getParserConfig(), as XML parser properties using XMLReader.setProperty(String, Object)
Collection<RioSetting<?>>	getSupportedSettings()
protected boolean	parseQueryResultInternal(InputStream in, boolean attemptParseBoolean, boolean attemptParseTuple)
protected void	reportWarning(String msg)
void	warning(SAXParseException exception)

Methods inherited from class AbstractQueryResultParser

getParseErrorListener, getParseLocationListener, getParserConfig, 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.
<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

Constructor Details

SPARQLResultsXMLParser

public SPARQLResultsXMLParser()

Creates a new parser for the SPARQL Query Results XML Format that will use an instance of SimpleValueFactory to create Value objects.

SPARQLResultsXMLParser

public SPARQLResultsXMLParser(ValueFactory valueFactory)

Creates a new parser for the SPARQL Query Results XML Format that will use the supplied ValueFactory to create Value objects.

Method Details

getTupleQueryResultFormat

public TupleQueryResultFormat getTupleQueryResultFormat()

Description copied from interface: TupleQueryResultParser

Gets the query result format that this parser can parse.

Specified by:

getTupleQueryResultFormat in interface TupleQueryResultParser

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.

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

parseQueryResult

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

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

Overrides:

parseQueryResult in class AbstractSPARQLXMLParser

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.

TupleQueryResultHandlerException

parse

@Deprecated
public void parse(InputStream in)
           throws IOException,
QueryResultParseException,
TupleQueryResultHandlerException

Deprecated.

Description copied from interface: TupleQueryResultParser

Parses the data from the supplied InputStream.

Specified by:

parse in interface TupleQueryResultParser

Parameters:

in - The InputStream from which to read the data.

Throws:

IOException - If an I/O error occurred while data was read from the InputStream.

QueryResultParseException - If the parser has encountered an unrecoverable parse error.

TupleQueryResultHandlerException - If the configured query result handler has encountered an unrecoverable error.