public class BinaryQueryResultWriter extends AbstractQueryResultWriter implements TupleQueryResultWriter, ByteSink
BinaryQueryResultConstants.| Modifier and Type | Field and Description |
|---|---|
protected boolean |
tupleVariablesFound |
| Constructor and Description |
|---|
BinaryQueryResultWriter(OutputStream out) |
| Modifier and Type | Method and Description |
|---|---|
void |
endHeader()
Indicates the end of the header.
|
void |
endQueryResult()
Indicates the end of a sequence of solutions.
|
void |
error(QueryErrorType errType,
String msg)
Writes an error msg to the stream.
|
OutputStream |
getOutputStream()
get the
OutputStream used by this ByteSink. |
TupleQueryResultFormat |
getQueryResultFormat()
Gets the query result format that this writer uses.
|
Collection<RioSetting<?>> |
getSupportedSettings() |
TupleQueryResultFormat |
getTupleQueryResultFormat()
Gets the query result format that this writer uses.
|
void |
handleBoolean(boolean value)
Handles the specified boolean value.
|
void |
handleLinks(List<String> linkUrls)
Handles the links elements which are present in SPARQL Results JSON and SPARQL Results XML documents in the
header.
|
void |
handleNamespace(String prefix,
String uri)
Handles a namespace prefix declaration.
|
protected void |
handleSolutionImpl(BindingSet bindingSet)
Extending classes must implement this method instead of overriding
AbstractQueryResultWriter.handleSolution(BindingSet) in order
to benefit from automatic handling of RDF* encoding. |
void |
handleStylesheet(String stylesheetUrl)
Handles a stylesheet URL.
|
void |
startDocument()
Indicates the start of the document.
|
void |
startHeader()
Indicates the start of the header.
|
void |
startQueryResult(List<String> bindingNames)
Indicates the start of a sequence of Solutions.
|
getFileFormat, getWriterConfig, handleSolution, setWriterConfig, xsdStringToPlainLiteralclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetWriterConfig, setWriterConfighandleSolutionacceptsFileFormat, getFileFormatpublic BinaryQueryResultWriter(OutputStream out)
public OutputStream getOutputStream()
ByteSinkOutputStream used by this ByteSink.getOutputStream in interface ByteSinkOutputStreampublic final TupleQueryResultFormat getTupleQueryResultFormat()
TupleQueryResultWritergetTupleQueryResultFormat in interface TupleQueryResultWriterpublic final TupleQueryResultFormat getQueryResultFormat()
QueryResultWritergetQueryResultFormat in interface QueryResultWriterpublic Collection<RioSetting<?>> getSupportedSettings()
getSupportedSettings in interface QueryResultWritergetSupportedSettings in class AbstractQueryResultWriterRioSettings that are supported by this QueryResultWriter.public void startDocument()
throws TupleQueryResultHandlerException
QueryResultWriterstartDocument in interface QueryResultWriterTupleQueryResultHandlerExceptionpublic void startQueryResult(List<String> bindingNames) throws TupleQueryResultHandlerException
QueryResultHandlerstartQueryResult in interface QueryResultHandlerstartQueryResult in class AbstractQueryResultWriterbindingNames - An ordered set of binding names.TupleQueryResultHandlerException - If there was an error during the starting of the query result handler.
This exception may be thrown if the QueryResultHandler.handleBoolean(boolean)
method was called before this method and the handler cannot process both
boolean and tuple results simultaneously.public void endQueryResult()
throws TupleQueryResultHandlerException
QueryResultHandlerendQueryResult in interface QueryResultHandlerTupleQueryResultHandlerException - If there was an error during the ending of the query result handler.
This exception may be thrown if the QueryResultHandler.handleBoolean(boolean)
method was called before this method and the handler cannot process both
boolean and tuple results simultaneously.protected void handleSolutionImpl(BindingSet bindingSet) throws TupleQueryResultHandlerException
AbstractQueryResultWriterAbstractQueryResultWriter.handleSolution(BindingSet) in order
to benefit from automatic handling of RDF* encoding.handleSolutionImpl in class AbstractQueryResultWriterbindingSet - the solution to handleTupleQueryResultHandlerExceptionpublic void handleNamespace(String prefix, String uri) throws QueryResultHandlerException
QueryResultWriterQueryResultWriter.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.
handleNamespace in interface QueryResultWriterprefix - The prefix to use for the namespaceuri - The full URI that is to be represented by the prefix.QueryResultHandlerExceptionpublic void error(QueryErrorType errType, String msg) throws IOException
errType - The error type.msg - The error message.IOException - When the error could not be written to the stream.public void handleStylesheet(String stylesheetUrl) throws QueryResultHandlerException
QueryResultWriterQueryResultWriter.startDocument() and before
QueryResultWriter.startHeader().
NOTE: If the format does not support stylesheets, it must silently ignore calls to this method.
handleStylesheet in interface QueryResultWriterstylesheetUrl - The URL of the stylesheet to be used to style the results.QueryResultHandlerException - If there was an error handling the stylesheet. This error is not thrown in
cases where stylesheets are not supported.public void startHeader()
throws QueryResultHandlerException
QueryResultWriterstartHeader in interface QueryResultWriterQueryResultHandlerException - If there was an error writing the start of the header.public void handleLinks(List<String> linkUrls) throws QueryResultHandlerException
QueryResultHandlerNOTE: If the format does not support links, it must silently ignore a call to this method.
An accumulating handler should accumulate these links.
handleLinks in interface QueryResultHandlerlinkUrls - The URLs of the links to handle.QueryResultHandlerException - If there was an error handling the set of link URLs. This error is not thrown
in cases where links are not supported.public void endHeader()
throws QueryResultHandlerException
QueryResultWriterQueryResultWriter.startHeader() and before any calls to
QueryResultHandler.handleSolution(org.eclipse.rdf4j.query.BindingSet).endHeader in interface QueryResultWriterQueryResultHandlerException - If there was an error writing the end of the header.public void handleBoolean(boolean value)
throws QueryResultHandlerException
QueryResultHandlerhandleBoolean in interface QueryResultHandlervalue - The boolean value to handle.QueryResultHandlerException - If there was an error during the handling of this value. This exception may
be thrown if the QueryResultHandler.startQueryResult(List),
QueryResultHandler.handleSolution(BindingSet) or QueryResultHandler.endQueryResult() methods
were called before this method was called, and the handler cannot process
both boolean and tuple results simultaneously.Copyright © 2015-2021 Eclipse Foundation. All Rights Reserved.