Class BinaryQueryResultWriter
- java.lang.Object
-
- org.eclipse.rdf4j.query.resultio.AbstractQueryResultWriter
-
- org.eclipse.rdf4j.query.resultio.binary.BinaryQueryResultWriter
-
- All Implemented Interfaces:
ByteSink,Sink,QueryResultHandler,QueryResultWriter,TupleQueryResultWriter,TupleQueryResultHandler
public class BinaryQueryResultWriter extends AbstractQueryResultWriter implements TupleQueryResultWriter, ByteSink
Writer for the binary tuple result format. The format is explained inBinaryQueryResultConstants.- Author:
- Arjohn Kampman
-
-
Field Summary
Fields Modifier and Type Field Description protected booleantupleVariablesFound
-
Constructor Summary
Constructors Constructor Description BinaryQueryResultWriter(OutputStream out)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidendHeader()Indicates the end of the header.voidendQueryResult()Indicates the end of a sequence of solutions.voiderror(QueryErrorType errType, String msg)Writes an error msg to the stream.OutputStreamgetOutputStream()get theOutputStreamused by thisByteSink.TupleQueryResultFormatgetQueryResultFormat()Gets the query result format that this writer uses.Collection<RioSetting<?>>getSupportedSettings()TupleQueryResultFormatgetTupleQueryResultFormat()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 stylesheetUrl)Handles a stylesheet URL.voidstartDocument()Indicates the start of the document.voidstartHeader()Indicates 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, 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
handleSolution
-
Methods inherited from interface org.eclipse.rdf4j.query.resultio.QueryResultWriter
getWriterConfig, setWriterConfig
-
Methods inherited from interface org.eclipse.rdf4j.common.io.Sink
acceptsFileFormat, getFileFormat
-
-
-
-
Constructor Detail
-
BinaryQueryResultWriter
public BinaryQueryResultWriter(OutputStream out)
-
-
Method Detail
-
getOutputStream
public OutputStream getOutputStream()
Description copied from interface:ByteSinkget theOutputStreamused by thisByteSink.- Specified by:
getOutputStreamin interfaceByteSink- Returns:
- an
OutputStream
-
getTupleQueryResultFormat
public final TupleQueryResultFormat getTupleQueryResultFormat()
Description copied from interface:TupleQueryResultWriterGets the query result format that this writer uses.- Specified by:
getTupleQueryResultFormatin interfaceTupleQueryResultWriter
-
getQueryResultFormat
public final TupleQueryResultFormat getQueryResultFormat()
Description copied from interface:QueryResultWriterGets the query result format that this writer uses.- Specified by:
getQueryResultFormatin interfaceQueryResultWriter
-
getSupportedSettings
public Collection<RioSetting<?>> getSupportedSettings()
- Specified by:
getSupportedSettingsin interfaceQueryResultWriter- Overrides:
getSupportedSettingsin classAbstractQueryResultWriter- Returns:
- A collection of
RioSettings that are supported by thisQueryResultWriter.
-
startDocument
public void startDocument() throws TupleQueryResultHandlerExceptionDescription copied from interface:QueryResultWriterIndicates the start of the document.- Specified by:
startDocumentin interfaceQueryResultWriter- Throws:
TupleQueryResultHandlerException
-
startQueryResult
public void startQueryResult(List<String> bindingNames) throws TupleQueryResultHandlerException
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
public void endQueryResult() throws TupleQueryResultHandlerExceptionDescription 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
protected void handleSolutionImpl(BindingSet bindingSet) throws TupleQueryResultHandlerException
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
-
handleNamespace
public void handleNamespace(String prefix, String uri) throws QueryResultHandlerException
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
-
error
public void error(QueryErrorType errType, String msg) throws IOException
Writes an error msg to the stream.- Parameters:
errType- The error type.msg- The error message.- Throws:
IOException- When the error could not be written to the stream.
-
handleStylesheet
public void handleStylesheet(String stylesheetUrl) throws QueryResultHandlerException
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:
stylesheetUrl- 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
public void startHeader() throws QueryResultHandlerExceptionDescription 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:
- SPARQL Query Results XML Format documentation for head element.
-
handleLinks
public void handleLinks(List<String> linkUrls) throws QueryResultHandlerException
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:
- "link"
-
endHeader
public void endHeader() throws QueryResultHandlerExceptionDescription 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.
-
handleBoolean
public void handleBoolean(boolean value) throws QueryResultHandlerExceptionDescription 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.
-
-