Class SPARQLResultsXMLWriter
java.lang.Object
org.eclipse.rdf4j.query.resultio.AbstractQueryResultWriter
org.eclipse.rdf4j.query.resultio.sparqlxml.SPARQLResultsXMLWriter
- All Implemented Interfaces:
CharSink,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
FieldsModifier and TypeFieldDescriptionprotected booleanprotected booleanprotected booleanprotected booleanprotected XMLWriterXMLWriter to write XML to. -
Constructor Summary
ConstructorsConstructorDescriptionSPARQLResultsXMLWriter(Writer writer) SPARQLResultsXMLWriter(XMLWriter xmlWriter) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidvoidIndicates the end of the header.voidIndicates the end of a sequence of solutions.final TupleQueryResultFormatGets the query result format that this writer uses.final Collection<RioSetting<?>>Gets the query result format that this writer uses.voidhandleBoolean(boolean value) Handles the specified boolean value.voidhandleLinks(List<String> linkUrls) Handles the links elements which are present in SPARQL Results JSON and SPARQL Results XML documents in the header.voidhandleNamespace(String prefix, String uri) Handles a namespace prefix declaration.protected voidhandleSolutionImpl(BindingSet bindingSet) Extending classes must implement this method instead of overridingAbstractQueryResultWriter.handleSolution(BindingSet)in order to benefit from automatic handling of RDF-star encoding.voidhandleStylesheet(String url) Handles a stylesheet URL.voidsetPrettyPrint(boolean prettyPrint) Deprecated.voidIndicates the start of the document.voidIndicates the start of the header.voidstartQueryResult(List<String> bindingNames) Indicates the start of a sequence of Solutions.Methods inherited from class org.eclipse.rdf4j.query.resultio.AbstractQueryResultWriter
getFileFormat, getWriterConfig, handleSolution, setWriterConfig, xsdStringToPlainLiteralMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.rdf4j.query.QueryResultHandler
endQueryResult, handleBoolean, handleLinks, handleSolution, startQueryResultMethods inherited from interface org.eclipse.rdf4j.query.resultio.QueryResultWriter
endHeader, getSupportedSettings, getWriterConfig, handleNamespace, handleStylesheet, setWriterConfig, startDocument, startHeaderMethods inherited from interface org.eclipse.rdf4j.common.io.Sink
acceptsFileFormat, getFileFormat
-
Field Details
-
xmlWriter
XMLWriter to write XML to. -
documentOpen
protected boolean documentOpen -
headerOpen
protected boolean headerOpen -
headerComplete
protected boolean headerComplete -
tupleVariablesFound
protected boolean tupleVariablesFound
-
-
Constructor Details
-
SPARQLResultsXMLWriter
-
SPARQLResultsXMLWriter
-
SPARQLResultsXMLWriter
-
-
Method Details
-
getTupleQueryResultFormat
Description copied from interface:TupleQueryResultWriterGets the query result format that this writer uses.- Specified by:
getTupleQueryResultFormatin interfaceTupleQueryResultWriter
-
getQueryResultFormat
Description copied from interface:QueryResultWriterGets the query result format that this writer uses.- Specified by:
getQueryResultFormatin interfaceQueryResultWriter
-
getWriter
Description copied from interface:CharSink -
setPrettyPrint
Deprecated.UseAbstractQueryResultWriter.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, beforeQueryResultWriter.startDocument()is called). -
endDocument
- Throws:
IOException
-
handleBoolean
Description copied from interface:QueryResultHandlerHandles the specified boolean value.- Specified by:
handleBooleanin interfaceQueryResultHandler- Parameters:
value- The boolean value to handle.- Throws:
QueryResultHandlerException- If there was an error during the handling of this value. This exception may be thrown if theQueryResultHandler.startQueryResult(List),QueryResultHandler.handleSolution(BindingSet)orQueryResultHandler.endQueryResult()methods were called before this method was called, and the handler cannot process both boolean and tuple results simultaneously.
-
startDocument
Description copied from interface:QueryResultWriterIndicates the start of the document.- Specified by:
startDocumentin interfaceQueryResultWriter- Throws:
QueryResultHandlerException- If there was an error starting the writing of the results.
-
handleStylesheet
Description copied from interface:QueryResultWriterHandles a stylesheet URL. If this is called, it must be called afterQueryResultWriter.startDocument()and beforeQueryResultWriter.startHeader().NOTE: If the format does not support stylesheets, it must silently ignore calls to this method.
- Specified by:
handleStylesheetin interfaceQueryResultWriter- Parameters:
url- The URL of the stylesheet to be used to style the results.- Throws:
QueryResultHandlerException- If there was an error handling the stylesheet. This error is not thrown in cases where stylesheets are not supported.
-
startHeader
Description copied from interface:QueryResultWriterIndicates the start of the header.- Specified by:
startHeaderin interfaceQueryResultWriter- Throws:
QueryResultHandlerException- If there was an error writing the start of the header.- See Also:
-
handleLinks
Description copied from interface:QueryResultHandlerHandles the links elements which are present in SPARQL Results JSON and SPARQL Results XML documents in the header.NOTE: If the format does not support links, it must silently ignore a call to this method.
An accumulating handler should accumulate these links.
- Specified by:
handleLinksin interfaceQueryResultHandler- Parameters:
linkUrls- The URLs of the links to handle.- Throws:
QueryResultHandlerException- If there was an error handling the set of link URLs. This error is not thrown in cases where links are not supported.- See Also:
-
endHeader
Description copied from interface:QueryResultWriterIndicates the end of the header. This must be called afterQueryResultWriter.startHeader()and before any calls toQueryResultHandler.handleSolution(org.eclipse.rdf4j.query.BindingSet).- Specified by:
endHeaderin interfaceQueryResultWriter- Throws:
QueryResultHandlerException- If there was an error writing the end of the header.
-
startQueryResult
Description copied from interface:QueryResultHandlerIndicates the start of a sequence of Solutions. The supplied bindingNames are an indication of the values that are in the Solutions. For example, a SPARQL query like select ?X ?Y where { ?X ?P ?Y } will have binding names X and Y.- Specified by:
startQueryResultin interfaceQueryResultHandler- Overrides:
startQueryResultin classAbstractQueryResultWriter- Parameters:
bindingNames- An ordered set of binding names.- Throws:
TupleQueryResultHandlerException- If there was an error during the starting of the query result handler. This exception may be thrown if theQueryResultHandler.handleBoolean(boolean)method was called before this method and the handler cannot process both boolean and tuple results simultaneously.
-
endQueryResult
Description copied from interface:QueryResultHandlerIndicates the end of a sequence of solutions.- Specified by:
endQueryResultin interfaceQueryResultHandler- Throws:
TupleQueryResultHandlerException- If there was an error during the ending of the query result handler. This exception may be thrown if theQueryResultHandler.handleBoolean(boolean)method was called before this method and the handler cannot process both boolean and tuple results simultaneously.
-
handleSolutionImpl
Description copied from class:AbstractQueryResultWriterExtending classes must implement this method instead of overridingAbstractQueryResultWriter.handleSolution(BindingSet)in order to benefit from automatic handling of RDF-star encoding.- Overrides:
handleSolutionImplin classAbstractQueryResultWriter- Parameters:
bindingSet- the solution to handle- Throws:
TupleQueryResultHandlerException
-
getSupportedSettings
- Specified by:
getSupportedSettingsin interfaceQueryResultWriter- Overrides:
getSupportedSettingsin classAbstractQueryResultWriter- Returns:
- A collection of
RioSettings that are supported by thisQueryResultWriter.
-
handleNamespace
Description copied from interface:QueryResultWriterHandles a namespace prefix declaration. If this is called, it should be called beforeQueryResultWriter.startDocument()to ensure that it has a document wide effect.NOTE: If the format does not support namespaces, it must silently ignore calls to this method.
- Specified by:
handleNamespacein interfaceQueryResultWriter- Parameters:
prefix- The prefix to use for the namespaceuri- The full URI that is to be represented by the prefix.- Throws:
QueryResultHandlerException
-
AbstractQueryResultWriter.getWriterConfig().set(BasicWriterSettings.PRETTY_PRINT, prettyPrint) instead.