Class ResultSetFormatter


  • public class ResultSetFormatter
    extends java.lang.Object
    ResultSetFormatter - Convenience ways to call the various output formatters. in various formats.
    See Also:
    ResultSetMgr
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String asText​(ResultSet qresults)
      Return a string that has the result set serialized as a text table
      static java.lang.String asText​(ResultSet qresults, Prologue prologue)
      Return a string that has the result set serialized as a text table
      static java.lang.String asXMLString​(boolean booleanResult)
      Return a string that has the result set serialized as XML (not RDF)
      static java.lang.String asXMLString​(boolean booleanResult, java.lang.String stylesheet)
      Return a string that has the result set serialized as XML (not RDF)
      static java.lang.String asXMLString​(ResultSet qresults)
      Return a string that has the result set serialized as XML (not RDF)
      static java.lang.String asXMLString​(ResultSet qresults, java.lang.String stylesheet)
      Return a string that has the result set serialized as XML (not RDF) with a style sheet directive inserted into the XML.
      static int consume​(ResultSet resultSet)
      This operation faithfully walks the results but does nothing with them.
      static void out​(boolean answer)
      Output an ASK answer
      static void out​(java.io.OutputStream out, boolean answer)
      Output an ASK answer
      static void out​(java.io.OutputStream out, ResultSet qresults)
      Output a result set in a text format.
      static void out​(java.io.OutputStream out, ResultSet resultSet, PrefixMapping pmap)
      Output a result set in a text format.
      static void out​(java.io.OutputStream out, ResultSet resultSet, Prologue prologue)
      Output a result set in a text format.
      static void out​(ResultSet qresults)
      Output a result set in a text format.
      static void out​(ResultSet qresults, Query query)
      Output a result set in a text format.
      static void out​(ResultSet qresults, PrefixMapping pmap)
      Output a result set in a text format.
      static void out​(ResultSet qresults, Prologue prologue)
      Output a result set in a text format.
      static void output​(boolean result, Lang resultFormat)  
      static void output​(java.io.OutputStream outStream, boolean result, Lang resultFormat)  
      static void output​(java.io.OutputStream outStream, java.util.Iterator<JsonObject> jsonItems)
      Output an iterator of JSON values.
      static void output​(java.io.OutputStream outStream, ResultSet resultSet, Lang resultFormat)  
      static void output​(java.io.OutputStream outStream, ResultSet resultSet, ResultsFormat rFmt)
      Output a ResultSet in some format.
      static void output​(ResultSet resultSet, Lang resultFormat)  
      static void output​(ResultSet resultSet, ResultsFormat rFmt)
      Output a ResultSet in some format.
      static void outputAsCSV​(boolean booleanResult)
      Output a boolean result in CSV format
      static void outputAsCSV​(java.io.OutputStream outStream, boolean booleanResult)
      Output a boolean result in CSV format
      static void outputAsCSV​(java.io.OutputStream outStream, ResultSet resultSet)
      Output a result set in CSV format
      static void outputAsCSV​(ResultSet resultSet)
      Output a result set in CSV format
      static void outputAsJSON​(boolean booleanResult)
      Output a result set in the JSON format Format: Serializing SPARQL Query Results in JSON JSON: http://json.org/
      static void outputAsJSON​(java.io.OutputStream outStream, boolean booleanResult)
      Output a result set in the JSON format Format: Serializing SPARQL Query Results in JSON JSON: http://json.org/
      static void outputAsJSON​(java.io.OutputStream outStream, ResultSet resultSet)
      Output a result set in the JSON format Format: Serializing SPARQL Query Results in JSON JSON: http://json.org/
      static void outputAsJSON​(ResultSet resultSet)
      Output a result set in the JSON format Format: Serializing SPARQL Query Results in JSON JSON: http://json.org/
      static void outputAsSSE​(boolean booleanResult)
      Output a boolean result in the SSE format Format: SSE
      static void outputAsSSE​(java.io.OutputStream outStream, boolean booleanResult)
      Output a boolean result in the SSE format Format: SSE
      static void outputAsSSE​(java.io.OutputStream outStream, ResultSet resultSet)
      Output a result set in the SSE format Format: SSE
      static void outputAsSSE​(java.io.OutputStream outStream, ResultSet resultSet, Prologue prologue)
      Output a result set in the SSE format Format: SSE
      static void outputAsSSE​(ResultSet resultSet)
      Output a result set in the SSE format Format: SSE
      static void outputAsSSE​(ResultSet resultSet, Prologue prologue)
      Output a result set in the SSE format Format: SSE
      static void outputAsTSV​(boolean booleanResult)
      Output a boolean result in TSV (tab separated values) format
      static void outputAsTSV​(java.io.OutputStream outStream, boolean booleanResult)
      Output a boolean result in TSV format
      static void outputAsTSV​(java.io.OutputStream outStream, ResultSet resultSet)
      Output a result set in TSV format
      static void outputAsTSV​(ResultSet resultSet)
      Output a result set in TSV format
      static void outputAsXML​(boolean booleanResult)
      Output a boolean result in the XML format
      static void outputAsXML​(boolean booleanResult, java.lang.String stylesheet)
      Output a boolean result in the XML format
      static void outputAsXML​(java.io.OutputStream outStream, boolean booleanResult)
      Output a boolean result in the XML format
      static void outputAsXML​(java.io.OutputStream outStream, boolean booleanResult, java.lang.String stylesheet)
      Output a boolean result in the XML format
      static void outputAsXML​(java.io.OutputStream outStream, ResultSet qresults)
      Output a result set in the XML format
      static void outputAsXML​(java.io.OutputStream outStream, ResultSet qresults, java.lang.String stylesheet)
      Output a result set in the XML format, inserting a style sheet in the XML output
      static void outputAsXML​(ResultSet qresults)
      Output a result set in the XML format
      static void outputAsXML​(ResultSet qresults, java.lang.String stylesheet)
      Output a result set in the XML format, inserting a style sheet in the XML output
      static java.util.List<QuerySolution> toList​(ResultSet resultSet)
      Turn the result set into a java.util.List
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • out

        public static void out​(ResultSet qresults)
        Output a result set in a text format. The result set is consumed. Use @see{ResultSetFactory.makeRewindable(ResultSet)} for a rewindable one.

        This caches the entire results in memory in order to determine the appropriate column widths and therefore may exhaust memory for large results

        Parameters:
        qresults - result set
      • out

        public static void out​(java.io.OutputStream out,
                               ResultSet qresults)
        Output a result set in a text format. The result set is consumed. Use @see{ResultSetFactory.makeRewindable(ResultSet)} for a rewindable one.

        This caches the entire results in memory in order to determine the appropriate column widths and therefore may exhaust memory for large results

        Parameters:
        out - OutputStream
        qresults - result set
      • out

        public static void out​(ResultSet qresults,
                               Query query)
        Output a result set in a text format. The result set is consumed. Use @see{ResultSetFactory.makeRewindable(ResultSet)} for a rewindable one.

        This caches the entire results in memory in order to determine the appropriate column widths and therefore may exhaust memory for large results

        Parameters:
        qresults - result set
        query - May be used to abbreviate URIs
      • out

        public static void out​(ResultSet qresults,
                               Prologue prologue)
        Output a result set in a text format. The result set is consumed. Use @see{ResultSetFactory.makeRewindable(ResultSet)} for a rewindable one.

        This caches the entire results in memory in order to determine the appropriate column widths and therefore may exhaust memory for large results

        Parameters:
        qresults - result set
        prologue - May be used to abbreviate URIs
      • out

        public static void out​(ResultSet qresults,
                               PrefixMapping pmap)
        Output a result set in a text format. The result set is consumed. Use @see{ResultSetFactory.makeRewindable(ResultSet)} for a rewindable one.

        This caches the entire results in memory in order to determine the appropriate column widths and therefore may exhaust memory for large results

        Parameters:
        qresults - result set
        pmap - Prefix mapping for abbreviating URIs.
      • out

        public static void out​(java.io.OutputStream out,
                               ResultSet resultSet,
                               PrefixMapping pmap)
        Output a result set in a text format. The result set is consumed. Use @see{ResultSetFactory.makeRewindable(ResultSet)} for a rewindable one.

        This caches the entire results in memory in order to determine the appropriate column widths and therefore may exhaust memory for large results

        Parameters:
        out - OutputStream
        resultSet - Result set
        pmap - Prefix mapping for abbreviating URIs.
      • out

        public static void out​(java.io.OutputStream out,
                               ResultSet resultSet,
                               Prologue prologue)
        Output a result set in a text format. The result set is consumed. Use @see{ResultSetFactory.makeRewindable(ResultSet)} for a rewindable one.

        This caches the entire results in memory in order to determine the appropriate column widths and therefore may exhaust memory for large results

        Parameters:
        out - OutputStream
        resultSet - result set
        prologue - Prologue, used to abbreviate IRIs
      • out

        public static void out​(boolean answer)
        Output an ASK answer
        Parameters:
        answer - The boolean answer
      • out

        public static void out​(java.io.OutputStream out,
                               boolean answer)
        Output an ASK answer
        Parameters:
        out - OutputStream
        answer - The boolean answer
      • asText

        public static java.lang.String asText​(ResultSet qresults)
        Return a string that has the result set serialized as a text table

        This caches the entire results in memory in order to determine the appropriate column widths and therefore may exhaust memory for large results

        Parameters:
        qresults - result set
        Returns:
        string
      • asText

        public static java.lang.String asText​(ResultSet qresults,
                                              Prologue prologue)
        Return a string that has the result set serialized as a text table

        This caches the entire results in memory in order to determine the appropriate column widths and therefore may exhaust memory for large results

        Parameters:
        qresults - result set
        prologue - Prologue, used to abbreviate IRIs
        Returns:
        string
      • consume

        public static int consume​(ResultSet resultSet)
        This operation faithfully walks the results but does nothing with them.
        Returns:
        The count of the number of solutions.
      • toList

        public static java.util.List<QuerySolution> toList​(ResultSet resultSet)
        Turn the result set into a java.util.List
        Parameters:
        resultSet - The result set
        Returns:
        List of QuerySolutions
      • output

        public static void output​(ResultSet resultSet,
                                  ResultsFormat rFmt)
        Output a ResultSet in some format.
        Parameters:
        resultSet - Result set
        rFmt - A format to encode the result set in
      • output

        public static void output​(java.io.OutputStream outStream,
                                  ResultSet resultSet,
                                  ResultsFormat rFmt)
        Output a ResultSet in some format. To get detailed control over each format, call the appropriate operation directly.
        Parameters:
        outStream - Output
        resultSet - Result set
        rFmt - A format to encode the result set in
      • output

        public static void output​(ResultSet resultSet,
                                  Lang resultFormat)
      • output

        public static void output​(java.io.OutputStream outStream,
                                  ResultSet resultSet,
                                  Lang resultFormat)
      • output

        public static void output​(boolean result,
                                  Lang resultFormat)
      • output

        public static void output​(java.io.OutputStream outStream,
                                  boolean result,
                                  Lang resultFormat)
      • output

        public static void output​(java.io.OutputStream outStream,
                                  java.util.Iterator<JsonObject> jsonItems)
        Output an iterator of JSON values.
        Parameters:
        outStream - output stream
        jsonItems - The JSON values
      • outputAsXML

        public static void outputAsXML​(ResultSet qresults)
        Output a result set in the XML format
        Parameters:
        qresults - result set
      • outputAsXML

        public static void outputAsXML​(java.io.OutputStream outStream,
                                       ResultSet qresults)
        Output a result set in the XML format
        Parameters:
        outStream - output stream
        qresults - result set
      • outputAsXML

        public static void outputAsXML​(ResultSet qresults,
                                       java.lang.String stylesheet)
        Output a result set in the XML format, inserting a style sheet in the XML output
        Parameters:
        qresults - result set
        stylesheet - The URL of the stylesheet
      • outputAsXML

        public static void outputAsXML​(java.io.OutputStream outStream,
                                       ResultSet qresults,
                                       java.lang.String stylesheet)
        Output a result set in the XML format, inserting a style sheet in the XML output
        Parameters:
        outStream - output stream
        qresults - result set
        stylesheet - The URL of the stylesheet
      • outputAsXML

        public static void outputAsXML​(boolean booleanResult)
        Output a boolean result in the XML format
        Parameters:
        booleanResult - The boolean result to encode
      • outputAsXML

        public static void outputAsXML​(java.io.OutputStream outStream,
                                       boolean booleanResult)
        Output a boolean result in the XML format
        Parameters:
        outStream - output stream
        booleanResult - The boolean result to encode
      • outputAsXML

        public static void outputAsXML​(boolean booleanResult,
                                       java.lang.String stylesheet)
        Output a boolean result in the XML format
        Parameters:
        booleanResult -
        stylesheet - The URL of the stylesheet
      • outputAsXML

        public static void outputAsXML​(java.io.OutputStream outStream,
                                       boolean booleanResult,
                                       java.lang.String stylesheet)
        Output a boolean result in the XML format
        Parameters:
        outStream - output stream
        booleanResult -
        stylesheet - The URL of the stylesheet
      • asXMLString

        public static java.lang.String asXMLString​(ResultSet qresults)
        Return a string that has the result set serialized as XML (not RDF)

        This builds the string in memory which can lead to memory exhaustion for large results. It is generally better to use the outputAsXML(OutputStream, ResultSet) overload instead

        Parameters:
        qresults - result set
        Returns:
        string
      • asXMLString

        public static java.lang.String asXMLString​(ResultSet qresults,
                                                   java.lang.String stylesheet)
        Return a string that has the result set serialized as XML (not RDF) with a style sheet directive inserted into the XML.

        This builds the string in memory which can lead to memory exhaustion for large results. It is generally better to use the outputAsXML(OutputStream, ResultSet, String) overload instead

        Parameters:
        qresults - result set
        stylesheet -
        Returns:
        string
      • asXMLString

        public static java.lang.String asXMLString​(boolean booleanResult)
        Return a string that has the result set serialized as XML (not RDF)

        This builds the string in memory which can lead to memory exhaustion for large results. It is generally better to use the outputAsXML(OutputStream, boolean) overload instead

        Parameters:
        booleanResult - The boolean result to encode
        Returns:
        string
      • asXMLString

        public static java.lang.String asXMLString​(boolean booleanResult,
                                                   java.lang.String stylesheet)
        Return a string that has the result set serialized as XML (not RDF)

        This builds the string in memory which can lead to memory exhaustion for large results. It is generally better to use the outputAsXML(OutputStream, boolean, String) overload instead

        Parameters:
        booleanResult - The boolean result to encode
        stylesheet -
        Returns:
        string
      • outputAsJSON

        public static void outputAsJSON​(java.io.OutputStream outStream,
                                        boolean booleanResult)
        Output a result set in the JSON format Format: Serializing SPARQL Query Results in JSON JSON: http://json.org/
        Parameters:
        outStream - output stream
        booleanResult - The boolean result to encode
      • outputAsSSE

        public static void outputAsSSE​(boolean booleanResult)
        Output a boolean result in the SSE format Format: SSE
        Parameters:
        booleanResult - The boolean result to encode
      • outputAsSSE

        public static void outputAsSSE​(java.io.OutputStream outStream,
                                       boolean booleanResult)
        Output a boolean result in the SSE format Format: SSE
        Parameters:
        outStream - output stream
        booleanResult - The boolean result to encode
      • outputAsSSE

        public static void outputAsSSE​(ResultSet resultSet)
        Output a result set in the SSE format Format: SSE
        Parameters:
        resultSet - result set
      • outputAsSSE

        public static void outputAsSSE​(ResultSet resultSet,
                                       Prologue prologue)
        Output a result set in the SSE format Format: SSE
        Parameters:
        resultSet - result set
      • outputAsSSE

        public static void outputAsSSE​(java.io.OutputStream outStream,
                                       ResultSet resultSet)
        Output a result set in the SSE format Format: SSE
        Parameters:
        outStream - The output stream
        resultSet - The result set
      • outputAsSSE

        public static void outputAsSSE​(java.io.OutputStream outStream,
                                       ResultSet resultSet,
                                       Prologue prologue)
        Output a result set in the SSE format Format: SSE
        Parameters:
        outStream - output stream
        resultSet - result set
        prologue -
      • outputAsCSV

        public static void outputAsCSV​(boolean booleanResult)
        Output a boolean result in CSV format
        Parameters:
        booleanResult - The boolean result to encode
      • outputAsCSV

        public static void outputAsCSV​(java.io.OutputStream outStream,
                                       boolean booleanResult)
        Output a boolean result in CSV format
        Parameters:
        outStream - output stream
        booleanResult - The boolean result to encode
      • outputAsCSV

        public static void outputAsCSV​(ResultSet resultSet)
        Output a result set in CSV format
        Parameters:
        resultSet - result set
      • outputAsCSV

        public static void outputAsCSV​(java.io.OutputStream outStream,
                                       ResultSet resultSet)
        Output a result set in CSV format
        Parameters:
        outStream - The output stream
        resultSet - The result set
      • outputAsTSV

        public static void outputAsTSV​(boolean booleanResult)
        Output a boolean result in TSV (tab separated values) format
        Parameters:
        booleanResult - The boolean result to encode
      • outputAsTSV

        public static void outputAsTSV​(java.io.OutputStream outStream,
                                       boolean booleanResult)
        Output a boolean result in TSV format
        Parameters:
        outStream - output stream
        booleanResult - The boolean result to encode
      • outputAsTSV

        public static void outputAsTSV​(ResultSet resultSet)
        Output a result set in TSV format
        Parameters:
        resultSet - result set
      • outputAsTSV

        public static void outputAsTSV​(java.io.OutputStream outStream,
                                       ResultSet resultSet)
        Output a result set in TSV format
        Parameters:
        outStream - The output stream
        resultSet - The result set