Package org.eclipse.rdf4j.query.resultio.sparqlxml

Class SPARQLResultsXMLWriter

java.lang.Object

org.eclipse.rdf4j.query.resultio.AbstractQueryResultWriter

org.eclipse.rdf4j.query.resultio.sparqlxml.SPARQLResultsXMLWriter

All Implemented Interfaces:

org.eclipse.rdf4j.common.io.CharSink, org.eclipse.rdf4j.common.io.Sink, QueryResultHandler, QueryResultWriter, TupleQueryResultWriter, TupleQueryResultHandler

Direct Known Subclasses:

SPARQLStarResultsXMLWriter

public class SPARQLResultsXMLWriter
extends AbstractQueryResultWriter
implements TupleQueryResultWriter

A TupleQueryResultWriter that writes tuple query results in the SPARQL Query Results XML Format.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	documentOpen
protected boolean	headerComplete
protected boolean	headerOpen
protected boolean	tupleVariablesFound
protected XMLWriter	xmlWriter	XMLWriter to write XML to.

Constructor Summary

Constructors

Constructor	Description
SPARQLResultsXMLWriter(OutputStream out)
SPARQLResultsXMLWriter(Writer writer)
SPARQLResultsXMLWriter(XMLWriter xmlWriter)

Method Summary

Modifier and Type	Method	Description
protected void	endDocument()
void	endHeader()
void	endQueryResult()
TupleQueryResultFormat	getQueryResultFormat()
Collection<org.eclipse.rdf4j.rio.RioSetting<?>>	getSupportedSettings()
TupleQueryResultFormat	getTupleQueryResultFormat()
Writer	getWriter()
void	handleBoolean(boolean value)
void	handleLinks(List<String> linkUrls)
void	handleNamespace(String prefix, String uri)
protected void	handleSolutionImpl(BindingSet bindingSet)
void	handleStylesheet(String url)
void	setPrettyPrint(boolean prettyPrint)	Deprecated. Use AbstractQueryResultWriter.getWriterConfig() .set(BasicWriterSettings.PRETTY_PRINT, prettyPrint) instead.
void	startDocument()
void	startHeader()
void	startQueryResult(List<String> bindingNames)

Methods inherited from class org.eclipse.rdf4j.query.resultio.AbstractQueryResultWriter

getFileFormat, getWriterConfig, handleSolution, setWriterConfig, xsdStringToPlainLiteral

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.rdf4j.query.QueryResultHandler

endQueryResult, handleBoolean, handleLinks, handleSolution, startQueryResult

Methods inherited from interface org.eclipse.rdf4j.query.resultio.QueryResultWriter

endHeader, getSupportedSettings, getWriterConfig, handleNamespace, handleStylesheet, setWriterConfig, startDocument, startHeader

Methods inherited from interface org.eclipse.rdf4j.common.io.Sink

acceptsFileFormat, getFileFormat

Field Detail

xmlWriter

protected XMLWriter xmlWriter

XMLWriter to write XML to.

documentOpen

protected boolean documentOpen

headerOpen

protected boolean headerOpen

headerComplete

protected boolean headerComplete

tupleVariablesFound

protected boolean tupleVariablesFound

Constructor Detail

SPARQLResultsXMLWriter

public SPARQLResultsXMLWriter(OutputStream out)

SPARQLResultsXMLWriter

public SPARQLResultsXMLWriter(Writer writer)

SPARQLResultsXMLWriter

public SPARQLResultsXMLWriter(XMLWriter xmlWriter)

Method Detail

getTupleQueryResultFormat

public TupleQueryResultFormat getTupleQueryResultFormat()

Specified by:

getTupleQueryResultFormat in interface TupleQueryResultWriter

getQueryResultFormat

public final TupleQueryResultFormat getQueryResultFormat()

Specified by:

getQueryResultFormat in interface QueryResultWriter

getWriter

public Writer getWriter()

Specified by:

getWriter in interface org.eclipse.rdf4j.common.io.CharSink

setPrettyPrint

@Deprecated
public void setPrettyPrint(boolean prettyPrint)

Deprecated.

Use AbstractQueryResultWriter.getWriterConfig() .set(BasicWriterSettings.PRETTY_PRINT, prettyPrint) instead.

Enables/disables addition of indentation characters and newlines in the XML document. By default, pretty-printing is set to true. If set to false, no indentation and newlines are added to the XML document. This method has to be used before writing starts (that is, before QueryResultWriter.startDocument() is called).

endDocument

protected void endDocument()
                    throws IOException

Throws:

IOException

handleBoolean

public void handleBoolean(boolean value)
                   throws QueryResultHandlerException

Specified by:

handleBoolean in interface QueryResultHandler

Throws:

QueryResultHandlerException

startDocument

public void startDocument()
                   throws QueryResultHandlerException

Specified by:

startDocument in interface QueryResultWriter

Throws:

QueryResultHandlerException

handleStylesheet

public void handleStylesheet(String url)
                      throws QueryResultHandlerException

Specified by:

handleStylesheet in interface QueryResultWriter

Throws:

QueryResultHandlerException

startHeader

public void startHeader()
                 throws QueryResultHandlerException

Specified by:

startHeader in interface QueryResultWriter

Throws:

QueryResultHandlerException

handleLinks

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

Specified by:

handleLinks in interface QueryResultHandler

Throws:

QueryResultHandlerException

endHeader

public void endHeader()
               throws QueryResultHandlerException

Specified by:

endHeader in interface QueryResultWriter

Throws:

QueryResultHandlerException

startQueryResult

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

Specified by:

startQueryResult in interface QueryResultHandler

Overrides:

startQueryResult in class AbstractQueryResultWriter

Throws:

TupleQueryResultHandlerException

endQueryResult

public void endQueryResult()
                    throws TupleQueryResultHandlerException

Specified by:

endQueryResult in interface QueryResultHandler

Throws:

TupleQueryResultHandlerException

handleSolutionImpl

protected void handleSolutionImpl(BindingSet bindingSet)
                           throws TupleQueryResultHandlerException

Overrides:

handleSolutionImpl in class AbstractQueryResultWriter

Throws:

TupleQueryResultHandlerException

getSupportedSettings

public final Collection<org.eclipse.rdf4j.rio.RioSetting<?>> getSupportedSettings()

Specified by:

getSupportedSettings in interface QueryResultWriter

Overrides:

getSupportedSettings in class AbstractQueryResultWriter

handleNamespace

public void handleNamespace(String prefix,
                            String uri)
                     throws QueryResultHandlerException

Specified by:

handleNamespace in interface QueryResultWriter

Throws:

QueryResultHandlerException