Class BooleanQueryResultFormat

java.lang.Object

org.eclipse.rdf4j.common.lang.FileFormat

org.eclipse.rdf4j.query.resultio.QueryResultFormat

org.eclipse.rdf4j.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	Description
static final BooleanQueryResultFormat	JSON	SPARQL Query Results JSON Format.
static final BooleanQueryResultFormat	SPARQL	SPARQL Query Results XML Format.
static final BooleanQueryResultFormat	TEXT	Plain text encoding using values "true" and "false" (case-insensitive).

Fields inherited from class QueryResultFormat

SPARQL_RESULTS_CSV_URI, SPARQL_RESULTS_JSON_URI, SPARQL_RESULTS_TSV_URI, SPARQL_RESULTS_XML_URI

Modifier and Type	Field	Description
protected static final IRI	SPARQL_RESULTS_CSV_URI	Local constant for tuple formats for SPARQL Results CSV.
protected static final IRI	SPARQL_RESULTS_JSON_URI	Local constant reused across boolean and tuple formats for SPARQL Results JSON.
protected static final IRI	SPARQL_RESULTS_TSV_URI	Local constant for tuple formats for SPARQL Results TSV.
protected static final IRI	SPARQL_RESULTS_XML_URI	Local constant reused across boolean and tuple formats for SPARQL Results XML.

Constructor Summary

Constructors

Constructor	Description
BooleanQueryResultFormat(String name, String mimeType, String fileExt)	Creates a new BooleanQueryResultFormat object.
BooleanQueryResultFormat(String name, String mimeType, Charset charset, String fileExt)	Creates a new BooleanQueryResultFormat object.
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, IRI standardURI)	Creates a new BooleanQueryResultFormat object.

Method Summary

Methods inherited from class QueryResultFormat

getStandardURI, hasStandardURI

Modifier and Type	Method	Description
IRI	getStandardURI()
boolean	hasStandardURI()

Methods inherited from class FileFormat

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

Modifier and Type	Method	Description
boolean	equals(Object other)	Compares FileFormat objects based on their name, ignoring case.
Charset	getCharset()	Get the (default) charset for this file format.
String	getDefaultFileExtension()	Gets the default file name extension for this file format.
String	getDefaultMIMEType()	Gets the default MIME type for this file format.
List<String>	getFileExtensions()	Gets the file format's file extensions.
List<String>	getMIMETypes()	Gets the file format's MIME types.
String	getName()	Gets the name of this file format.
boolean	hasCharset()	Checks if the FileFormat has a (default) charset.
boolean	hasDefaultFileExtension(String extension)	Checks if the specified file name extension matches the FileFormat's default file name extension.
boolean	hasDefaultMIMEType(String mimeType)	Checks if the specified MIME type matches the FileFormat's default MIME type.
boolean	hasFileExtension(String extension)	Checks if the FileFormat's file extension is equal to the specified file extension.
int	hashCode()
boolean	hasMIMEType(String mimeType)	Checks if specified MIME type matches one of the FileFormat's MIME types.
static <FF extends FileFormat> Optional<FF>	matchFileName(String fileName, Iterable<FF> fileFormats)	Tries to match the specified file name with the file extensions of the supplied file formats.
static <FF extends FileFormat> Optional<FF>	matchMIMEType(String mimeType, Iterable<FF> fileFormats)	Tries to match the specified MIME type with the MIME types of the supplied file formats.
String	toString()

Methods inherited from class Object

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

Field Details

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 Details

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,
 IRI 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.