Class SPARQLStarResultsJSONWriter
java.lang.Object
org.eclipse.rdf4j.query.resultio.AbstractQueryResultWriter
org.eclipse.rdf4j.query.resultio.sparqljson.SPARQLResultsJSONWriter
org.eclipse.rdf4j.query.resultio.sparqljson.SPARQLStarResultsJSONWriter
org.eclipse.rdf4j.query.resultio.sparqlstarjson.SPARQLStarResultsJSONWriter
- All Implemented Interfaces:
CharSink
,Sink
,QueryResultHandler
,QueryResultWriter
,TupleQueryResultWriter
,TupleQueryResultHandler
@Deprecated(since="3.4.0")
public class SPARQLStarResultsJSONWriter
extends SPARQLStarResultsJSONWriter
Deprecated.
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected boolean
protected boolean
protected boolean
protected final com.fasterxml.jackson.core.JsonGenerator
protected boolean
protected boolean
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
void
Indicates the end of the header.void
Indicates the end of a sequence of solutions.final Collection
<RioSetting<?>> final Writer
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 overridingAbstractQueryResultWriter.handleSolution(BindingSet)
in order to benefit from automatic handling of RDF-star encoding.void
handleStylesheet
(String stylesheetUrl) Handles a stylesheet URL.void
Indicates the start of the document.void
Indicates the start of the header.void
startQueryResult
(List<String> columnHeaders) Indicates the start of a sequence of Solutions.Methods inherited from class org.eclipse.rdf4j.query.resultio.sparqljson.SPARQLStarResultsJSONWriter
acceptsFileFormat, getQueryResultFormat, getTupleQueryResultFormat
Methods inherited from class org.eclipse.rdf4j.query.resultio.sparqljson.SPARQLResultsJSONWriter
writeValue
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
endQueryResult, handleBoolean, handleLinks, handleSolution, startQueryResult
Methods inherited from interface org.eclipse.rdf4j.query.resultio.QueryResultWriter
endHeader, getSupportedSettings, getWriterConfig, handleNamespace, handleStylesheet, setWriterConfig, startDocument, startHeader
Methods inherited from interface org.eclipse.rdf4j.common.io.Sink
getFileFormat
-
Field Details
-
firstTupleWritten
protected boolean firstTupleWritten -
documentOpen
protected boolean documentOpen -
headerOpen
protected boolean headerOpen -
headerComplete
protected boolean headerComplete -
tupleVariablesFound
protected boolean tupleVariablesFound -
linksFound
protected boolean linksFound -
jg
protected final com.fasterxml.jackson.core.JsonGenerator jg
-
-
Constructor Details
-
SPARQLStarResultsJSONWriter
Deprecated.
-
-
Method Details
-
getWriter
Description copied from interface:CharSink
-
endHeader
Description copied from interface:QueryResultWriter
Indicates the end of the header. This must be called afterQueryResultWriter.startHeader()
and before any calls toQueryResultHandler.handleSolution(org.eclipse.rdf4j.query.BindingSet)
.- Specified by:
endHeader
in interfaceQueryResultWriter
- Throws:
QueryResultHandlerException
- If there was an error writing the end of the header.
-
startQueryResult
Description copied from interface:QueryResultHandler
Indicates 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:
startQueryResult
in interfaceQueryResultHandler
- Overrides:
startQueryResult
in classAbstractQueryResultWriter
- Parameters:
columnHeaders
- 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.
-
handleSolutionImpl
Description copied from class:AbstractQueryResultWriter
Extending classes must implement this method instead of overridingAbstractQueryResultWriter.handleSolution(BindingSet)
in order to benefit from automatic handling of RDF-star encoding.- Overrides:
handleSolutionImpl
in classAbstractQueryResultWriter
- Parameters:
bindingSet
- the solution to handle- Throws:
TupleQueryResultHandlerException
-
endQueryResult
Description copied from interface:QueryResultHandler
Indicates the end of a sequence of solutions.- Specified by:
endQueryResult
in 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.
-
startDocument
Description copied from interface:QueryResultWriter
Indicates the start of the document.- Specified by:
startDocument
in interfaceQueryResultWriter
- Throws:
QueryResultHandlerException
- If there was an error starting the writing of the results.
-
handleStylesheet
Description copied from interface:QueryResultWriter
Handles 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:
handleStylesheet
in 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
Description copied from interface:QueryResultWriter
Indicates the start of the header.- Specified by:
startHeader
in interfaceQueryResultWriter
- Throws:
QueryResultHandlerException
- If there was an error writing the start of the header.- See Also:
-
handleLinks
Description copied from interface:QueryResultHandler
Handles 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:
handleLinks
in 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:
-
handleBoolean
Description copied from interface:QueryResultHandler
Handles the specified boolean value.- Specified by:
handleBoolean
in 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.
-
getSupportedSettings
- Specified by:
getSupportedSettings
in interfaceQueryResultWriter
- Overrides:
getSupportedSettings
in classAbstractQueryResultWriter
- Returns:
- A collection of
RioSetting
s that are supported by thisQueryResultWriter
.
-
handleNamespace
Description copied from interface:QueryResultWriter
Handles 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:
handleNamespace
in interfaceQueryResultWriter
- Parameters:
prefix
- The prefix to use for the namespaceuri
- The full URI that is to be represented by the prefix.- Throws:
QueryResultHandlerException
-
endDocument
- Throws:
IOException
-
SPARQLStarResultsJSONWriter