Package org.eclipse.rdf4j.query.resultio
Interface QueryResultWriter
-
- All Superinterfaces:
QueryResultHandler
- All Known Subinterfaces:
BooleanQueryResultWriter,TupleQueryResultWriter
- All Known Implementing Classes:
AbstractQueryResultWriter,BinaryQueryResultWriter,BooleanTextWriter,ConsoleQueryResultWriter,SPARQLBooleanJSONWriter,SPARQLBooleanXMLWriter,SPARQLResultsCSVWriter,SPARQLResultsJSONWriter,SPARQLResultsTSVWriter,SPARQLResultsXMLWriter,SPARQLStarResultsJSONWriter,SPARQLStarResultsTSVWriter,SPARQLStarResultsXMLWriter
public interface QueryResultWriter extends QueryResultHandler
The base interface for writers of query results sets and boolean results.- Author:
- Peter Ansell
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidendHeader()Indicates the end of the header.QueryResultFormatgetQueryResultFormat()Gets the query result format that this writer uses.Collection<RioSetting<?>>getSupportedSettings()WriterConfiggetWriterConfig()Retrieves the current writer configuration as a single object.voidhandleNamespace(String prefix, String uri)Handles a namespace prefix declaration.voidhandleStylesheet(String stylesheetUrl)Handles a stylesheet URL.voidsetWriterConfig(WriterConfig config)Sets all supplied writer configuration options.voidstartDocument()Indicates the start of the document.voidstartHeader()Indicates the start of the header.-
Methods inherited from interface org.eclipse.rdf4j.query.QueryResultHandler
endQueryResult, handleBoolean, handleLinks, handleSolution, startQueryResult
-
-
-
-
Method Detail
-
getQueryResultFormat
QueryResultFormat getQueryResultFormat()
Gets the query result format that this writer uses.
-
handleNamespace
void handleNamespace(String prefix, String uri) throws QueryResultHandlerException
Handles a namespace prefix declaration. If this is called, it should be called beforestartDocument()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.
- Parameters:
prefix- The prefix to use for the namespaceuri- The full URI that is to be represented by the prefix.- Throws:
QueryResultHandlerException
-
startDocument
void startDocument() throws QueryResultHandlerExceptionIndicates the start of the document.- Throws:
QueryResultHandlerException- If there was an error starting the writing of the results.
-
handleStylesheet
void handleStylesheet(String stylesheetUrl) throws QueryResultHandlerException
Handles a stylesheet URL. If this is called, it must be called afterstartDocument()and beforestartHeader().NOTE: If the format does not support stylesheets, it must silently ignore calls to this method.
- 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
void startHeader() throws QueryResultHandlerExceptionIndicates the start of the header.- Throws:
QueryResultHandlerException- If there was an error writing the start of the header.- See Also:
- SPARQL Query Results XML Format documentation for head element.
-
endHeader
void endHeader() throws QueryResultHandlerExceptionIndicates the end of the header. This must be called afterstartHeader()and before any calls toQueryResultHandler.handleSolution(org.eclipse.rdf4j.query.BindingSet).- Throws:
QueryResultHandlerException- If there was an error writing the end of the header.
-
setWriterConfig
void setWriterConfig(WriterConfig config)
Sets all supplied writer configuration options.- Parameters:
config- a writer configuration object.
-
getWriterConfig
WriterConfig getWriterConfig()
Retrieves the current writer configuration as a single object.- Returns:
- a writer configuration object representing the current configuration of the writer.
-
getSupportedSettings
Collection<RioSetting<?>> getSupportedSettings()
- Returns:
- A collection of
RioSettings that are supported by thisQueryResultWriter.
-
-