com.hp.hpl.jena.query
Class ResultSetFormatter

java.lang.Object
  extended by com.hp.hpl.jena.query.ResultSetFormatter

public class ResultSetFormatter
extends Object

ResultSetFormatter - Convenience ways to call the various output formatters. in various formats.


Method Summary
static Resource asRDF(Model model, boolean booleanResult)
          Encode the boolean as RDF in the model provided.
static Resource asRDF(Model model, ResultSet resultSet)
          Encode the result set as RDF in the model provided.
static String asText(ResultSet qresults)
          Return a string that has the result set serilized as a text table
static String asText(ResultSet qresults, Prologue prologue)
          Return a string that has the result set serilized as a text table
static String asXMLString(boolean booleanResult)
          Return a string that has the result set serilized as XML (not RDF)
static String asXMLString(boolean booleanResult, String stylesheet)
          Return a string that has the result set serilized as XML (not RDF)
static String asXMLString(ResultSet qresults)
          Return a string that has the result set serilized as XML (not RDF)
static String asXMLString(ResultSet qresults, String stylesheet)
          Return a string that has the result set serilized 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(OutputStream out, boolean answer)
          Output an ASK answer
static void out(OutputStream out, ResultSet qresults)
          Output a result set in a text format.
static void out(OutputStream out, ResultSet qresults, PrefixMapping pmap)
          Output a result set in a text format.
static void out(OutputStream out, ResultSet qresults, 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, 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 out(ResultSet qresults, Query query)
          Output a result set in a text format.
static void output(OutputStream outStream, ResultSet resultSet, ResultsFormat rFmt)
          Output a ResultSet in some format.
static void output(ResultSet resultSet, ResultsFormat rFmt)
          Output a ResultSet in some format.
static void outputAsBIO(OutputStream out, ResultSet results)
          Output a result set in BIO format
static void outputAsCSV(boolean booleanResult)
          Output a boolean result in CSV format
static void outputAsCSV(OutputStream outStream, boolean booleanResult)
          Output a boolean result in in CSV format
static void outputAsCSV(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(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(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 outputAsRDF(OutputStream outStream, String format, boolean booleanResult)
          Write out an RDF model that encodes a boolean result
static void outputAsRDF(OutputStream outStream, String format, ResultSet resultSet)
          Write out an RDF model that encodes the result set
static void outputAsRDF(String format, boolean booleanResult)
          Write out an RDF model that encodes a boolean result
static void outputAsRDF(String format, ResultSet resultSet)
          Write out an RDF model that encodes the result set
static void outputAsSSE(boolean booleanResult)
          Output a boolean result in the SSE format Format: SSE
static void outputAsSSE(OutputStream outStream, boolean booleanResult)
          Output a boolean result in the SSE format Format: SSE
static void outputAsSSE(OutputStream outStream, ResultSet resultSet)
          Output a result set in the SSE format Format: SSE
static void outputAsSSE(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(OutputStream outStream, boolean booleanResult)
          Output a boolean result in in TSV format
static void outputAsTSV(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, String stylesheet)
          Output a boolean result in the XML format
static void outputAsXML(OutputStream outStream, boolean booleanResult)
          Output a boolean result in the XML format
static void outputAsXML(OutputStream outStream, boolean booleanResult, String stylesheet)
          Output a boolean result in the XML format
static void outputAsXML(OutputStream outStream, ResultSet qresults)
          Output a result set in the XML format
static void outputAsXML(OutputStream outStream, ResultSet qresults, 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, String stylesheet)
          Output a result set in the XML format, inserting a style sheet in the XMl output
static List<QuerySolution> toList(ResultSet resultSet)
          Turn the result set into a java.util.List
static Model toModel(boolean booleanResult)
          Encode a boolean result set as RDF.
static Model toModel(ResultSet resultSet)
          Encode the result set as RDF.
 
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.

Parameters:
qresults - result set

out

public static void out(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.

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.

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.

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.

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

out

public static void out(OutputStream 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.

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

out

public static void out(OutputStream 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.

Parameters:
out - OutputStream
qresults - 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(OutputStream out,
                       boolean answer)
Output an ASK answer

Parameters:
out - OutputStream
answer - The boolean answer

asText

public static String asText(ResultSet qresults)
Return a string that has the result set serilized as a text table

Parameters:
qresults - result set
Returns:
string

asText

public static String asText(ResultSet qresults,
                            Prologue prologue)
Return a string that has the result set serilized as a text table

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 List<QuerySolution> toList(ResultSet resultSet)
Turn the result set into a java.util.List

Parameters:
resultSet - The result set
Returns:
List of QuerySolutions

toModel

public static Model toModel(ResultSet resultSet)
Encode the result set as RDF.

Parameters:
resultSet -
Returns:
Model Model contains the results

toModel

public static Model toModel(boolean booleanResult)
Encode a boolean result set as RDF.

Parameters:
booleanResult -
Returns:
Model Model contains the results

asRDF

public static Resource asRDF(Model model,
                             ResultSet resultSet)
Encode the result set as RDF in the model provided.

Parameters:
model - The place where to put the RDF.
resultSet -
Returns:
Resource The resource for the result set.

asRDF

public static Resource asRDF(Model model,
                             boolean booleanResult)
Encode the boolean as RDF in the model provided.

Parameters:
model - The place where to put the RDF.
booleanResult -
Returns:
Resource The resource for the result set.

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(OutputStream outStream,
                          ResultSet resultSet,
                          ResultsFormat rFmt)
Output a ResultSet in some format. To get detailed control over each format, call the appropropiate operation directly.

Parameters:
outStream - Output
resultSet - Result set
rFmt - A format to encode the result set in

outputAsRDF

public static void outputAsRDF(String format,
                               ResultSet resultSet)
Write out an RDF model that encodes the result set

Parameters:
format - Name of RDF format (names as Jena writers)
resultSet - The result set to encode in RDF

outputAsRDF

public static void outputAsRDF(OutputStream outStream,
                               String format,
                               ResultSet resultSet)
Write out an RDF model that encodes the result set

Parameters:
outStream - Output
format - Name of RDF format (names as Jena writers)
resultSet - The result set to encode in RDF

outputAsRDF

public static void outputAsRDF(String format,
                               boolean booleanResult)
Write out an RDF model that encodes a boolean result

Parameters:
format - Name of RDF format (names as Jena writers)
booleanResult - The boolean result to encode in RDF

outputAsRDF

public static void outputAsRDF(OutputStream outStream,
                               String format,
                               boolean booleanResult)
Write out an RDF model that encodes a boolean result

Parameters:
outStream - Output
format - Name of RDF format (names as Jena writers)
booleanResult - The boolean result to encode in RDF

outputAsXML

public static void outputAsXML(ResultSet qresults)
Output a result set in the XML format

Parameters:
qresults - result set

outputAsXML

public static void outputAsXML(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,
                               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 stylsheet

outputAsXML

public static void outputAsXML(OutputStream outStream,
                               ResultSet qresults,
                               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 stylsheet

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(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,
                               String stylesheet)
Output a boolean result in the XML format

Parameters:
booleanResult -
stylesheet - The URL of the stylesheet

outputAsXML

public static void outputAsXML(OutputStream outStream,
                               boolean booleanResult,
                               String stylesheet)
Output a boolean result in the XML format

Parameters:
outStream - output stream
booleanResult -
stylesheet - The URL of the stylesheet

asXMLString

public static String asXMLString(ResultSet qresults)
Return a string that has the result set serilized as XML (not RDF)

Parameters:
qresults - result set
Returns:
string

asXMLString

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

Parameters:
qresults - result set
stylesheet -
Returns:
string

asXMLString

public static String asXMLString(boolean booleanResult)
Return a string that has the result set serilized as XML (not RDF)

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

asXMLString

public static String asXMLString(boolean booleanResult,
                                 String stylesheet)
Return a string that has the result set serilized as XML (not RDF)

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

outputAsJSON

public static void outputAsJSON(ResultSet resultSet)
Output a result set in the JSON format Format: Serializing SPARQL Query Results in JSON JSON: http://json.org/

Parameters:
resultSet - result set

outputAsJSON

public static void outputAsJSON(OutputStream outStream,
                                ResultSet resultSet)
Output a result set in the JSON format Format: Serializing SPARQL Query Results in JSON JSON: http://json.org/

Parameters:
outStream - output stream
resultSet - result set

outputAsJSON

public static void outputAsJSON(boolean booleanResult)
Output a result set in the JSON format Format: Serializing SPARQL Query Results in JSON JSON: http://json.org/

Parameters:
booleanResult - The boolean result to encode

outputAsJSON

public static void outputAsJSON(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(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(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(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(OutputStream outStream,
                               boolean booleanResult)
Output a boolean result in 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(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(OutputStream outStream,
                               boolean booleanResult)
Output a boolean result in 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(OutputStream outStream,
                               ResultSet resultSet)
Output a result set in TSV format

Parameters:
outStream - The output stream
resultSet - The result set

outputAsBIO

public static void outputAsBIO(OutputStream out,
                               ResultSet results)
Output a result set in BIO format



Licenced under the Apache License, Version 2.0