org.openrdf.query.resultio

Class QueryResultIO

java.lang.Object

org.openrdf.query.resultio.QueryResultIO

public class QueryResultIO
extends Object

Class offering utility methods related to query results.

Author:

Arjohn Kampman

Constructor Summary

Constructors

Constructor and Description
QueryResultIO()

Method Summary

Modifier and Type	Method and Description
static BooleanQueryResultParser	createParser(BooleanQueryResultFormat format) Convenience methods for creating BooleanQueryResultParser objects.
static TupleQueryResultParser	createParser(TupleQueryResultFormat format) Convenience methods for creating TupleQueryResultParser objects.
static TupleQueryResultParser	createParser(TupleQueryResultFormat format, ValueFactory valueFactory) Convenience methods for creating TupleQueryResultParser objects that use the specified ValueFactory to create RDF model objects.
static BooleanQueryResultWriter	createWriter(BooleanQueryResultFormat format, OutputStream out) Convenience methods for creating BooleanQueryResultWriter objects.
static QueryResultWriter	createWriter(QueryResultFormat format, OutputStream out) Convenience methods for creating QueryResultWriter objects.
static TupleQueryResultWriter	createWriter(TupleQueryResultFormat format, OutputStream out) Convenience methods for creating TupleQueryResultWriter objects.
static BooleanQueryResultFormat	getBooleanParserFormatForFileName(String fileName) Tries to match the extension of a file name against the list of RDF formats that can be parsed.
static BooleanQueryResultFormat	getBooleanParserFormatForFileName(String fileName, BooleanQueryResultFormat fallback) Tries to match the extension of a file name against the list of RDF formats that can be parsed.
static BooleanQueryResultFormat	getBooleanParserFormatForMIMEType(String mimeType) Tries to match a MIME type against the list of boolean query result formats that can be parsed.
static BooleanQueryResultFormat	getBooleanParserFormatForMIMEType(String mimeType, BooleanQueryResultFormat fallback) Tries to match a MIME type against the list of boolean query result formats that can be parsed.
static BooleanQueryResultFormat	getBooleanWriterFormatForFileName(String fileName) Tries to match the extension of a file name against the list of RDF formats that can be written.
static BooleanQueryResultFormat	getBooleanWriterFormatForFileName(String fileName, BooleanQueryResultFormat fallback) Tries to match the extension of a file name against the list of RDF formats that can be written.
static BooleanQueryResultFormat	getBooleanWriterFormatForMIMEType(String mimeType) Tries to match a MIME type against the list of boolean query result formats that can be written.
static BooleanQueryResultFormat	getBooleanWriterFormatForMIMEType(String mimeType, BooleanQueryResultFormat fallback) Tries to match a MIME type against the list of boolean query result formats that can be written.
static TupleQueryResultFormat	getParserFormatForFileName(String fileName) Tries to match the extension of a file name against the list of RDF formats that can be parsed.
static TupleQueryResultFormat	getParserFormatForFileName(String fileName, TupleQueryResultFormat fallback) Tries to match the extension of a file name against the list of RDF formats that can be parsed.
static TupleQueryResultFormat	getParserFormatForMIMEType(String mimeType) Tries to match a MIME type against the list of tuple query result formats that can be parsed.
static TupleQueryResultFormat	getParserFormatForMIMEType(String mimeType, TupleQueryResultFormat fallback) Tries to match a MIME type against the list of tuple query result formats that can be parsed.
static TupleQueryResultFormat	getWriterFormatForFileName(String fileName) Tries to match the extension of a file name against the list of RDF formats that can be written.
static TupleQueryResultFormat	getWriterFormatForFileName(String fileName, TupleQueryResultFormat fallback) Tries to match the extension of a file name against the list of RDF formats that can be written.
static TupleQueryResultFormat	getWriterFormatForMIMEType(String mimeType) Tries to match a MIME type against the list of tuple query result formats that can be written.
static TupleQueryResultFormat	getWriterFormatForMIMEType(String mimeType, TupleQueryResultFormat fallback) Tries to match a MIME type against the list of tuple query result formats that can be written.
static boolean	parse(InputStream in, BooleanQueryResultFormat format) Parses a boolean query result document and returns the parsed value.
static TupleQueryResult	parse(InputStream in, TupleQueryResultFormat format) Parses a query result document and returns it as a TupleQueryResult object.
static void	parse(InputStream in, TupleQueryResultFormat format, TupleQueryResultHandler handler, ValueFactory valueFactory) Parses a query result document, reporting the parsed solutions to the supplied TupleQueryResultHandler.
static void	write(boolean value, BooleanQueryResultFormat format, OutputStream out) Deprecated. Use writeBoolean(boolean, BooleanQueryResultFormat, OutputStream) instead.
static void	write(GraphQueryResult gqr, RDFFormat format, OutputStream out) Writes a graph query result document in a specific RDF format to an output stream.
static void	write(TupleQueryResult tqr, TupleQueryResultFormat format, OutputStream out) Writes a query result document in a specific query result format to an output stream.
static void	writeBoolean(boolean value, BooleanQueryResultFormat format, OutputStream out) Writes a boolean query result document in a specific boolean query result format to an output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryResultIO

public QueryResultIO()

Method Detail

getParserFormatForMIMEType

public static TupleQueryResultFormat getParserFormatForMIMEType(String mimeType)

Tries to match a MIME type against the list of tuple query result formats that can be parsed.

Parameters:

mimeType - A MIME type, e.g. "application/sparql-results+xml".

Returns:

An RDFFormat object if a match was found, or null otherwise.

See Also:

getParserFormatForMIMEType(String, TupleQueryResultFormat)

getParserFormatForMIMEType

public static TupleQueryResultFormat getParserFormatForMIMEType(String mimeType,
                                                                TupleQueryResultFormat fallback)

Tries to match a MIME type against the list of tuple query result formats that can be parsed. This method calls FileFormat.matchMIMEType(String, Iterable) with the specified MIME type, the keys of TupleQueryResultParserRegistry.getInstance() and the fallback format as parameters.

Parameters:

mimeType - A MIME type, e.g. "application/sparql-results+xml".

fallback - The format that will be returned if no match was found.

Returns:

The matching TupleQueryResultFormat, or fallback if no match was found.

getParserFormatForFileName

public static TupleQueryResultFormat getParserFormatForFileName(String fileName)

Tries to match the extension of a file name against the list of RDF formats that can be parsed.

Parameters:

fileName - A file name.

Returns:

An TupleQueryResultFormat object if a match was found, or null otherwise.

See Also:

getParserFormatForFileName(String, TupleQueryResultFormat)

getParserFormatForFileName

public static TupleQueryResultFormat getParserFormatForFileName(String fileName,
                                                                TupleQueryResultFormat fallback)

Tries to match the extension of a file name against the list of RDF formats that can be parsed. This method calls FileFormat.matchFileName(String, Iterable, info.aduna.lang.FileFormat) with the specified MIME type, the keys of TupleQueryResultParserRegistry.getInstance() and the fallback format as parameters.

Parameters:

fileName - A file name.

fallback - The format that will be returned if no match was found.

Returns:

The matching TupleQueryResultFormat, or fallback if no match was found.

getWriterFormatForMIMEType

public static TupleQueryResultFormat getWriterFormatForMIMEType(String mimeType)

Tries to match a MIME type against the list of tuple query result formats that can be written.

Parameters:

mimeType - A MIME type, e.g. "application/sparql-results+xml".

Returns:

An TupleQueryResultFormat object if a match was found, or null otherwise.

See Also:

getWriterFormatForMIMEType(String, TupleQueryResultFormat)

getWriterFormatForMIMEType

public static TupleQueryResultFormat getWriterFormatForMIMEType(String mimeType,
                                                                TupleQueryResultFormat fallback)

Tries to match a MIME type against the list of tuple query result formats that can be written. This method calls FileFormat.matchMIMEType(String, Iterable, info.aduna.lang.FileFormat) with the specified MIME type, the keys of TupleQueryResultWriterRegistry.getInstance() and the fallback format as parameters.

Parameters:

mimeType - A MIME type, e.g. "application/sparql-results+xml".

fallback - The format that will be returned if no match was found.

Returns:

The matching TupleQueryResultFormat, or fallback if no match was found.

getWriterFormatForFileName

public static TupleQueryResultFormat getWriterFormatForFileName(String fileName)

Tries to match the extension of a file name against the list of RDF formats that can be written.

Parameters:

fileName - A file name.

Returns:

An TupleQueryResultFormat object if a match was found, or null otherwise.

See Also:

getWriterFormatForFileName(String, TupleQueryResultFormat)

getWriterFormatForFileName

public static TupleQueryResultFormat getWriterFormatForFileName(String fileName,
                                                                TupleQueryResultFormat fallback)

Tries to match the extension of a file name against the list of RDF formats that can be written. This method calls FileFormat.matchFileName(String, Iterable, info.aduna.lang.FileFormat) with the specified MIME type, the keys of TupleQueryResultWriterRegistry.getInstance() and the fallback format as parameters.

Parameters:

fileName - A file name.

fallback - The format that will be returned if no match was found.

Returns:

The matching TupleQueryResultFormat, or fallback if no match was found.

getBooleanParserFormatForMIMEType

public static BooleanQueryResultFormat getBooleanParserFormatForMIMEType(String mimeType)

Tries to match a MIME type against the list of boolean query result formats that can be parsed.

Parameters:

mimeType - A MIME type, e.g. "application/sparql-results+xml".

Returns:

An RDFFormat object if a match was found, or null otherwise.

Since:

2.7.0

See Also:

getBooleanParserFormatForMIMEType(String, BooleanQueryResultFormat)

getBooleanParserFormatForMIMEType

public static BooleanQueryResultFormat getBooleanParserFormatForMIMEType(String mimeType,
                                                                         BooleanQueryResultFormat fallback)

Tries to match a MIME type against the list of boolean query result formats that can be parsed. This method calls FileFormat.matchMIMEType(String, Iterable) with the specified MIME type, the keys of BooleanQueryResultParserRegistry.getInstance() and the fallback format as parameters.

Parameters:

mimeType - A MIME type, e.g. "application/sparql-results+xml".

fallback - The format that will be returned if no match was found.

Returns:

The matching BooleanQueryResultFormat, or fallback if no match was found.

Since:

2.7.0

getBooleanParserFormatForFileName

public static BooleanQueryResultFormat getBooleanParserFormatForFileName(String fileName)

Tries to match the extension of a file name against the list of RDF formats that can be parsed.

Parameters:

fileName - A file name.

Returns:

An BooleanQueryResultFormat object if a match was found, or null otherwise.

Since:

2.7.0

See Also:

getBooleanParserFormatForFileName(String, BooleanQueryResultFormat)

getBooleanParserFormatForFileName

public static BooleanQueryResultFormat getBooleanParserFormatForFileName(String fileName,
                                                                         BooleanQueryResultFormat fallback)

Tries to match the extension of a file name against the list of RDF formats that can be parsed. This method calls FileFormat.matchFileName(String, Iterable, info.aduna.lang.FileFormat) with the specified MIME type, the keys of BooleanQueryResultParserRegistry.getInstance() and the fallback format as parameters.

Parameters:

fileName - A file name.

fallback - The format that will be returned if no match was found.

Returns:

The matching BooleanQueryResultFormat, or fallback if no match was found.

Since:

2.7.0

getBooleanWriterFormatForMIMEType

public static BooleanQueryResultFormat getBooleanWriterFormatForMIMEType(String mimeType)

Tries to match a MIME type against the list of boolean query result formats that can be written.

Parameters:

mimeType - A MIME type, e.g. "application/sparql-results+xml".

Returns:

An BooleanQueryResultFormat object if a match was found, or null otherwise.

Since:

2.7.0

See Also:

getBooleanWriterFormatForMIMEType(String, BooleanQueryResultFormat)

getBooleanWriterFormatForMIMEType

public static BooleanQueryResultFormat getBooleanWriterFormatForMIMEType(String mimeType,
                                                                         BooleanQueryResultFormat fallback)

Tries to match a MIME type against the list of boolean query result formats that can be written. This method calls FileFormat.matchMIMEType(String, Iterable, info.aduna.lang.FileFormat) with the specified MIME type, the keys of BooleanQueryResultWriterRegistry.getInstance() and the fallback format as parameters.

Parameters:

mimeType - A MIME type, e.g. "application/sparql-results+xml".

fallback - The format that will be returned if no match was found.

Returns:

The matching BooleanQueryResultFormat, or fallback if no match was found.

Since:

2.7.0

getBooleanWriterFormatForFileName

public static BooleanQueryResultFormat getBooleanWriterFormatForFileName(String fileName)

Tries to match the extension of a file name against the list of RDF formats that can be written.

Parameters:

fileName - A file name.

Returns:

An BooleanQueryResultFormat object if a match was found, or null otherwise.

Since:

2.7.0

See Also:

getBooleanWriterFormatForFileName(String, BooleanQueryResultFormat)

getBooleanWriterFormatForFileName

public static BooleanQueryResultFormat getBooleanWriterFormatForFileName(String fileName,
                                                                         BooleanQueryResultFormat fallback)

Tries to match the extension of a file name against the list of RDF formats that can be written. This method calls FileFormat.matchFileName(String, Iterable, info.aduna.lang.FileFormat) with the specified MIME type, the keys of BooleanQueryResultWriterRegistry.getInstance() and the fallback format as parameters.

Parameters:

fileName - A file name.

fallback - The format that will be returned if no match was found.

Returns:

The matching BooleanQueryResultFormat, or fallback if no match was found.

Since:

2.7.0

createParser

public static TupleQueryResultParser createParser(TupleQueryResultFormat format)
                                           throws UnsupportedQueryResultFormatException

Convenience methods for creating TupleQueryResultParser objects. This method uses the registry returned by TupleQueryResultParserRegistry.getInstance() to get a factory for the specified format and uses this factory to create the appropriate parser.

Throws:

UnsupportedQueryResultFormatException - If no parser is available for the specified tuple query result format.

createParser

public static TupleQueryResultParser createParser(TupleQueryResultFormat format,
                                                  ValueFactory valueFactory)
                                           throws UnsupportedQueryResultFormatException

Convenience methods for creating TupleQueryResultParser objects that use the specified ValueFactory to create RDF model objects.

Throws:

UnsupportedQueryResultFormatException - If no parser is available for the specified tuple query result format.

See Also:

createParser(TupleQueryResultFormat), QueryResultParser.setValueFactory(ValueFactory)

createWriter

public static TupleQueryResultWriter createWriter(TupleQueryResultFormat format,
                                                  OutputStream out)
                                           throws UnsupportedQueryResultFormatException

Convenience methods for creating TupleQueryResultWriter objects. This method uses the registry returned by TupleQueryResultWriterRegistry.getInstance() to get a factory for the specified format and uses this factory to create the appropriate writer.

Throws:

UnsupportedQueryResultFormatException - If no writer is available for the specified tuple query result format.

createParser

public static BooleanQueryResultParser createParser(BooleanQueryResultFormat format)
                                             throws UnsupportedQueryResultFormatException

Convenience methods for creating BooleanQueryResultParser objects. This method uses the registry returned by BooleanQueryResultParserRegistry.getInstance() to get a factory for the specified format and uses this factory to create the appropriate parser.

Throws:

UnsupportedQueryResultFormatException - If no parser is available for the specified boolean query result format.

createWriter

public static BooleanQueryResultWriter createWriter(BooleanQueryResultFormat format,
                                                    OutputStream out)
                                             throws UnsupportedQueryResultFormatException

Convenience methods for creating BooleanQueryResultWriter objects. This method uses the registry returned by BooleanQueryResultWriterRegistry.getInstance() to get a factory for the specified format and uses this factory to create the appropriate writer.

Throws:

UnsupportedQueryResultFormatException - If no writer is available for the specified boolean query result format.

createWriter

public static QueryResultWriter createWriter(QueryResultFormat format,
                                             OutputStream out)
                                      throws UnsupportedQueryResultFormatException

Convenience methods for creating QueryResultWriter objects. This method uses the registry returned by TupleQueryResultWriterRegistry.getInstance() to get a factory for the specified format and uses this factory to create the appropriate writer.

Throws:

UnsupportedQueryResultFormatException - If no writer is available for the specified tuple query result format.

Since:

2.7.0

parse

public static void parse(InputStream in,
                         TupleQueryResultFormat format,
                         TupleQueryResultHandler handler,
                         ValueFactory valueFactory)
                  throws IOException,
                         QueryResultParseException,
                         TupleQueryResultHandlerException,
                         UnsupportedQueryResultFormatException

Parses a query result document, reporting the parsed solutions to the supplied TupleQueryResultHandler.

Parameters:

in - An InputStream to read the query result document from.

format - The query result format of the document to parse. Supported formats are TupleQueryResultFormat.SPARQL and TupleQueryResultFormat.BINARY.

handler - The TupleQueryResultHandler to report the parse results to.

Throws:

IOException - If an I/O error occured while reading the query result document from the stream.

TupleQueryResultHandlerException - If such an exception is thrown by the supplied TupleQueryResultHandler.

UnsupportedQueryResultFormatException

IllegalArgumentException - If an unsupported query result file format was specified.

QueryResultParseException

parse

public static TupleQueryResult parse(InputStream in,
                                     TupleQueryResultFormat format)
                              throws IOException,
                                     QueryResultParseException,
                                     TupleQueryResultHandlerException,
                                     UnsupportedQueryResultFormatException

Parses a query result document and returns it as a TupleQueryResult object.

Parameters:

in - An InputStream to read the query result document from.

format - The query result format of the document to parse. Supported formats are TupleQueryResultFormat.SPARQL and TupleQueryResultFormat.BINARY.

Throws:

IOException - If an I/O error occured while reading the query result document from the stream.

TupleQueryResultHandlerException - If such an exception is thrown by the used query result parser.

UnsupportedQueryResultFormatException

IllegalArgumentException - If an unsupported query result file format was specified.

QueryResultParseException

parse

public static boolean parse(InputStream in,
                            BooleanQueryResultFormat format)
                     throws IOException,
                            QueryResultParseException,
                            UnsupportedQueryResultFormatException

Parses a boolean query result document and returns the parsed value.

Parameters:

in - An InputStream to read the query result document from.

format - The file format of the document to parse.

Throws:

IOException - If an I/O error occured while reading the query result document from the stream.

UnsupportedQueryResultFormatException - If an unsupported query result file format was specified.

QueryResultParseException

write

public static void write(TupleQueryResult tqr,
                         TupleQueryResultFormat format,
                         OutputStream out)
                  throws IOException,
                         TupleQueryResultHandlerException,
                         UnsupportedQueryResultFormatException,
                         QueryEvaluationException

Writes a query result document in a specific query result format to an output stream.

Parameters:

tqr - The query result to write.

format - The file format of the document to write.

out - An OutputStream to write the document to.

Throws:

IOException - If an I/O error occured while writing the query result document to the stream.

TupleQueryResultHandlerException - If such an exception is thrown by the used query result writer.

UnsupportedQueryResultFormatException

QueryEvaluationException - If an unsupported query result file format was specified.

write

@Deprecated
public static void write(boolean value,
                                     BooleanQueryResultFormat format,
                                     OutputStream out)
                              throws IOException,
                                     UnsupportedQueryResultFormatException

Deprecated. Use writeBoolean(boolean, BooleanQueryResultFormat, OutputStream) instead.

Writes a boolean query result document in a specific boolean query result format to an output stream.

Parameters:

value - The value to write.

format - The file format of the document to write.

out - An OutputStream to write the document to.

Throws:

IOException - If an I/O error occured while writing the query result document to the stream.

UnsupportedQueryResultFormatException - If an unsupported query result file format was specified.

writeBoolean

public static void writeBoolean(boolean value,
                                BooleanQueryResultFormat format,
                                OutputStream out)
                         throws QueryResultHandlerException,
                                UnsupportedQueryResultFormatException

Writes a boolean query result document in a specific boolean query result format to an output stream.

Parameters:

value - The value to write.

format - The file format of the document to write.

out - An OutputStream to write the document to.

Throws:

IOException - If an I/O error occured while writing the query result document to the stream.

UnsupportedQueryResultFormatException - If an unsupported query result file format was specified.

QueryResultHandlerException

Since:

2.7.0

write

public static void write(GraphQueryResult gqr,
                         RDFFormat format,
                         OutputStream out)
                  throws IOException,
                         RDFHandlerException,
                         UnsupportedRDFormatException,
                         QueryEvaluationException

Writes a graph query result document in a specific RDF format to an output stream.

Parameters:

gqr - The query result to write.

format - The file format of the document to write.

out - An OutputStream to write the document to.

Throws:

IOException - If an I/O error occured while writing the query result document to the stream.

RDFHandlerException - If such an exception is thrown by the used RDF writer.

QueryEvaluationException

UnsupportedRDFormatException - If an unsupported query result file format was specified.