org.openrdf.query.resultio

Class BooleanQueryResultFormat

java.lang.Object

info.aduna.lang.FileFormat

org.openrdf.query.resultio.QueryResultFormat

org.openrdf.query.resultio.BooleanQueryResultFormat

public class BooleanQueryResultFormat
extends QueryResultFormat

Represents the concept of a boolean query result serialization format. Boolean query result formats are identified by a name and can have one or more associated MIME types, zero or more associated file extensions and can specify a (default) character encoding.

Author:

Arjohn Kampman

Field Summary

Fields

Modifier and Type	Field and Description
static BooleanQueryResultFormat	JSON SPARQL Query Results JSON Format.
static BooleanQueryResultFormat	SPARQL SPARQL Query Results XML Format.
static BooleanQueryResultFormat	TEXT Plain text encoding using values "true" and "false" (case-insensitive).

Fields inherited from class org.openrdf.query.resultio.QueryResultFormat

SPARQL_RESULTS_CSV_URI, SPARQL_RESULTS_JSON_URI, SPARQL_RESULTS_TSV_URI, SPARQL_RESULTS_XML_URI

Constructor Summary

Constructors

Constructor and Description
BooleanQueryResultFormat(String name, Collection<String> mimeTypes, Charset charset, Collection<String> fileExtensions) Creates a new BooleanQueryResultFormat object.
BooleanQueryResultFormat(String name, Collection<String> mimeTypes, Charset charset, Collection<String> fileExtensions, URI standardURI) Creates a new BooleanQueryResultFormat object.
BooleanQueryResultFormat(String name, String mimeType, Charset charset, String fileExt) Creates a new BooleanQueryResultFormat object.
BooleanQueryResultFormat(String name, String mimeType, String fileExt) Creates a new BooleanQueryResultFormat object.

Method Summary

Modifier and Type	Method and Description
static BooleanQueryResultFormat	forFileName(String fileName) Tries to determine the appropriate boolean file format for a file, based on the extension specified in a file name.
static BooleanQueryResultFormat	forFileName(String fileName, BooleanQueryResultFormat fallback) Tries to determine the appropriate boolean file format for a file, based on the extension specified in a file name.
static BooleanQueryResultFormat	forMIMEType(String mimeType) Tries to determine the appropriate boolean file format based on the a MIME type that describes the content type.
static BooleanQueryResultFormat	forMIMEType(String mimeType, BooleanQueryResultFormat fallback) Tries to determine the appropriate boolean file format based on the a MIME type that describes the content type.
static void	register(BooleanQueryResultFormat format) Registers the specified boolean query result format.
static BooleanQueryResultFormat	register(String name, String mimeType, String fileExt) Registers the specified boolean query result format.
static Collection<BooleanQueryResultFormat>	values() Returns all known/registered boolean query result formats.

Methods inherited from class org.openrdf.query.resultio.QueryResultFormat

getStandardURI, hasStandardURI

Methods inherited from class info.aduna.lang.FileFormat

equals, getCharset, getDefaultFileExtension, getDefaultMIMEType, getFileExtensions, getMIMETypes, getName, hasCharset, hasDefaultFileExtension, hasDefaultMIMEType, hasFileExtension, hashCode, hasMIMEType, matchFileName, matchFileName, matchMIMEType, matchMIMEType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SPARQL

public static final BooleanQueryResultFormat SPARQL

SPARQL Query Results XML Format.

JSON

public static final BooleanQueryResultFormat JSON

SPARQL Query Results JSON Format.

TEXT

public static final BooleanQueryResultFormat TEXT

Plain text encoding using values "true" and "false" (case-insensitive).

Constructor Detail

BooleanQueryResultFormat

public BooleanQueryResultFormat(String name,
                                String mimeType,
                                String fileExt)

Creates a new BooleanQueryResultFormat object.

Parameters:

name - The name of the format, e.g. "SPARQL/XML".

mimeType - The MIME type of the format, e.g. application/sparql-results+xml for the SPARQL/XML format.

fileExt - The (default) file extension for the format, e.g. srx for SPARQL/XML.

BooleanQueryResultFormat

public BooleanQueryResultFormat(String name,
                                String mimeType,
                                Charset charset,
                                String fileExt)

Creates a new BooleanQueryResultFormat object.

Parameters:

name - The name of the format, e.g. "SPARQL/XML".

mimeType - The MIME type of the format, e.g. application/sparql-results+xml for the SPARQL/XML format.

charset - The default character encoding of the format. Specify null if not applicable.

fileExt - The (default) file extension for the format, e.g. srx for SPARQL/XML.

BooleanQueryResultFormat

public BooleanQueryResultFormat(String name,
                                Collection<String> mimeTypes,
                                Charset charset,
                                Collection<String> fileExtensions)

Creates a new BooleanQueryResultFormat object.

Parameters:

name - The name of the format, e.g. "SPARQL/XML".

mimeTypes - The MIME types of the format, e.g. application/sparql-results+xml for the SPARQL/XML format. The first item in the list is interpreted as the default MIME type for the format.

charset - The default character encoding of the format. Specify null if not applicable.

fileExtensions - The format's file extensions, e.g. srx for SPARQL/XML files. The first item in the list is interpreted as the default file extension for the format.

BooleanQueryResultFormat

public BooleanQueryResultFormat(String name,
                                Collection<String> mimeTypes,
                                Charset charset,
                                Collection<String> fileExtensions,
                                URI standardURI)

Creates a new BooleanQueryResultFormat object.

Parameters:

name - The name of the format, e.g. "SPARQL/XML".

mimeTypes - The MIME types of the format, e.g. application/sparql-results+xml for the SPARQL/XML format. The first item in the list is interpreted as the default MIME type for the format.

charset - The default character encoding of the format. Specify null if not applicable.

fileExtensions - The format's file extensions, e.g. srx for SPARQL/XML files. The first item in the list is interpreted as the default file extension for the format.

standardURI - The standard URI that has been assigned to this format by a standards organisation or null if it does not currently have a standard URI.

Since:

2.8.0

Method Detail

values

public static Collection<BooleanQueryResultFormat> values()

Returns all known/registered boolean query result formats.

register

public static BooleanQueryResultFormat register(String name,
                                                String mimeType,
                                                String fileExt)

Registers the specified boolean query result format.

Parameters:

name - The name of the format, e.g. "SPARQL/XML".

mimeType - The MIME type of the format, e.g. application/sparql-results+xml for the SPARQL/XML file format.

fileExt - The (default) file extension for the format, e.g. srx for SPARQL/XML files.

register

public static void register(BooleanQueryResultFormat format)

Registers the specified boolean query result format.

forMIMEType

public static BooleanQueryResultFormat forMIMEType(String mimeType)

Tries to determine the appropriate boolean file format based on the a MIME type that describes the content type.

NOTE: This method may not take into account dynamically loaded formats. Use QueryResultIO.getBooleanParserFormatForMIMEType(String) and QueryResultIO.getBooleanWriterFormatForMIMEType(String) to find all dynamically loaded parser and writer formats, respectively.

Parameters:

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

Returns:

A TupleQueryResultFormat object if the MIME type was recognized, or null otherwise.

See Also:

forMIMEType(String,BooleanQueryResultFormat), FileFormat.getMIMETypes()

forMIMEType

public static BooleanQueryResultFormat forMIMEType(String mimeType,
                                                   BooleanQueryResultFormat fallback)

Tries to determine the appropriate boolean file format based on the a MIME type that describes the content type. The supplied fallback format will be returned when the MIME type was not recognized.

NOTE: This method may not take into account dynamically loaded formats. Use QueryResultIO.getBooleanParserFormatForMIMEType(String, BooleanQueryResultFormat) and QueryResultIO.getBooleanWriterFormatForMIMEType(String, BooleanQueryResultFormat) to find all dynamically loaded parser and writer formats, respectively.

Parameters:

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

fallback - a fallback TupleQueryResultFormat that will be returned by the method if no match for the supplied MIME type can be found.

Returns:

A TupleQueryResultFormat that matches the MIME type, or the fallback format if the extension was not recognized.

See Also:

forMIMEType(String), FileFormat.getMIMETypes()

forFileName

public static BooleanQueryResultFormat forFileName(String fileName)

Tries to determine the appropriate boolean file format for a file, based on the extension specified in a file name.

NOTE: This method may not take into account dynamically loaded formats. Use QueryResultIO.getBooleanParserFormatForFileName(String) and QueryResultIO.getBooleanWriterFormatForFileName(String) to find all dynamically loaded parser and writer formats, respectively.

Parameters:

fileName - A file name.

Returns:

A TupleQueryResultFormat object if the file extension was recognized, or null otherwise.

See Also:

forFileName(String,BooleanQueryResultFormat), FileFormat.getFileExtensions()

forFileName

public static BooleanQueryResultFormat forFileName(String fileName,
                                                   BooleanQueryResultFormat fallback)

Tries to determine the appropriate boolean file format for a file, based on the extension specified in a file name. The supplied fallback format will be returned when the file name extension was not recognized.

NOTE: This method may not take into account dynamically loaded formats. Use QueryResultIO.getBooleanParserFormatForFileName(String, BooleanQueryResultFormat) and QueryResultIO.getBooleanWriterFormatForFileName(String, BooleanQueryResultFormat) to find all dynamically loaded parser and writer formats, respectively.

Parameters:

fileName - A file name.

Returns:

A TupleQueryResultFormat that matches the file name extension, or the fallback format if the extension was not recognized.

See Also:

forFileName(String), FileFormat.getFileExtensions()