public interface QueryResultWriter extends QueryResultHandler
| Modifier and Type | Method and Description |
|---|---|
void |
endHeader()
Indicates the end of the header.
|
default Optional<OutputStream> |
getOutputStream()
Gets the
OutputStream this writer writes to, if it uses one. |
QueryResultFormat |
getQueryResultFormat()
Gets the query result format that this writer uses.
|
Collection<RioSetting<?>> |
getSupportedSettings() |
WriterConfig |
getWriterConfig()
Retrieves the current writer configuration as a single object.
|
void |
handleNamespace(String prefix,
String uri)
Handles a namespace prefix declaration.
|
void |
handleStylesheet(String stylesheetUrl)
Handles a stylesheet URL.
|
void |
setWriterConfig(WriterConfig config)
Sets all supplied writer configuration options.
|
void |
startDocument()
Indicates the start of the document.
|
void |
startHeader()
Indicates the start of the header.
|
endQueryResult, handleBoolean, handleLinks, handleSolution, startQueryResultQueryResultFormat getQueryResultFormat()
@InternalUseOnly @Experimental default Optional<OutputStream> getOutputStream()
OutputStream this writer writes to, if it uses one.void handleNamespace(String prefix, String uri) throws QueryResultHandlerException
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.
prefix - The prefix to use for the namespaceuri - The full URI that is to be represented by the prefix.QueryResultHandlerExceptionvoid startDocument()
throws QueryResultHandlerException
QueryResultHandlerException - If there was an error starting the writing of the results.void handleStylesheet(String stylesheetUrl) throws QueryResultHandlerException
startDocument() and before
startHeader().
NOTE: If the format does not support stylesheets, it must silently ignore calls to this method.
stylesheetUrl - 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.void startHeader()
throws QueryResultHandlerException
QueryResultHandlerException - If there was an error writing the start of the header.void endHeader()
throws QueryResultHandlerException
startHeader() and before any calls to
QueryResultHandler.handleSolution(org.eclipse.rdf4j.query.BindingSet).QueryResultHandlerException - If there was an error writing the end of the header.void setWriterConfig(WriterConfig config)
config - a writer configuration object.WriterConfig getWriterConfig()
Collection<RioSetting<?>> getSupportedSettings()
RioSettings that are supported by this QueryResultWriter.Copyright © 2015-2020 Eclipse Foundation. All Rights Reserved.