Class TupleQueryResultFormat

java.lang.Object

org.eclipse.rdf4j.common.lang.FileFormat

org.eclipse.rdf4j.query.resultio.QueryResultFormat

org.eclipse.rdf4j.query.resultio.TupleQueryResultFormat

public class TupleQueryResultFormat
extends QueryResultFormat

Represents the concept of an tuple query result serialization format. Tuple 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 TupleQueryResultFormat	BINARY	Binary RDF results table format.
static final TupleQueryResultFormat	CSV	SPARQL Query Result CSV Format.
static final TupleQueryResultFormat	JSON	SPARQL Query Results JSON Format.
static final TupleQueryResultFormat	JSON_STAR	SPARQL-star Query Results JSON Format (like SPARQL JSON but with RDF-star support).
static final TupleQueryResultFormat	ODS
static final TupleQueryResultFormat	SPARQL	SPARQL Query Results XML Format.
static final TupleQueryResultFormat	SPARQL_STAR	SPARQL-star Query Results XML Format (like SPARQL/XML but with native RDF-star support).
static final TupleQueryResultFormat	TSV	SPARQL Query Result TSV Format.
static final TupleQueryResultFormat	TSV_STAR	SPARQL-star Query Results TSV Format (like SPARQL TSV but with RDF-star support).
static final TupleQueryResultFormat	XSLX

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
TupleQueryResultFormat(String name, String mimeType, String fileExt)	Creates a new TupleQueryResultFormat object.
TupleQueryResultFormat(String name, String mimeType, String fileExt, boolean supportsRDFStar)	Creates a new TupleQueryResultFormat object.
TupleQueryResultFormat(String name, String mimeType, Charset charset, String fileExt)	Creates a new TupleQueryResultFormat object.
TupleQueryResultFormat(String name, String mimeType, Charset charset, String fileExt, boolean supportsRDFStar)	Creates a new TupleQueryResultFormat object.
TupleQueryResultFormat(String name, Collection<String> mimeTypes, Charset charset, Collection<String> fileExtensions)	Creates a new TupleQueryResultFormat object.
TupleQueryResultFormat(String name, Collection<String> mimeTypes, Charset charset, Collection<String> fileExtensions, boolean supportsRDFStar)	Creates a new TupleQueryResultFormat object.
TupleQueryResultFormat(String name, Collection<String> mimeTypes, Charset charset, Collection<String> fileExtensions, IRI standardURI)	Creates a new TupleQueryResultFormat object.
TupleQueryResultFormat(String name, Collection<String> mimeTypes, Charset charset, Collection<String> fileExtensions, IRI standardURI, boolean supportsRDFStar)	Creates a new TupleQueryResultFormat object.

Method Summary

Modifier and Type	Method	Description
boolean	supportsRDFStar()	Return true if the TupleQueryResultFormat supports the encoding of RDF-star triples natively.

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 TupleQueryResultFormat SPARQL

SPARQL Query Results XML Format.

SPARQL_STAR

@Experimental
public static final TupleQueryResultFormat SPARQL_STAR

SPARQL-star Query Results XML Format (like SPARQL/XML but with native RDF-star support).

BINARY

public static final TupleQueryResultFormat BINARY

Binary RDF results table format.

JSON

public static final TupleQueryResultFormat JSON

SPARQL Query Results JSON Format.

JSON_STAR

@Experimental
public static final TupleQueryResultFormat JSON_STAR

SPARQL-star Query Results JSON Format (like SPARQL JSON but with RDF-star support).

CSV

public static final TupleQueryResultFormat CSV

SPARQL Query Result CSV Format.

TSV

public static final TupleQueryResultFormat TSV

SPARQL Query Result TSV Format.

TSV_STAR

public static final TupleQueryResultFormat TSV_STAR

SPARQL-star Query Results TSV Format (like SPARQL TSV but with RDF-star support).

XSLX

public static final TupleQueryResultFormat XSLX

ODS

public static final TupleQueryResultFormat ODS

Constructor Details

TupleQueryResultFormat

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

Creates a new TupleQueryResultFormat 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.

TupleQueryResultFormat

public TupleQueryResultFormat(String name,
 String mimeType,
 String fileExt,
 boolean supportsRDFStar)

Creates a new TupleQueryResultFormat 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.

supportsRDFStar - True if the TupleQueryResultFormat supports the encoding of RDF-star triples natively and false otherwise.

Since:

3.2.0

TupleQueryResultFormat

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

Creates a new TupleQueryResultFormat 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.

TupleQueryResultFormat

public TupleQueryResultFormat(String name,
 String mimeType,
 Charset charset,
 String fileExt,
 boolean supportsRDFStar)

Creates a new TupleQueryResultFormat 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.

supportsRDFStar - True if the TupleQueryResultFormat supports the encoding of RDF-star triples natively and false otherwise.

Since:

3.2.0

TupleQueryResultFormat

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

Creates a new TupleQueryResultFormat 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.

TupleQueryResultFormat

public TupleQueryResultFormat(String name,
 Collection<String> mimeTypes,
 Charset charset,
 Collection<String> fileExtensions,
 boolean supportsRDFStar)

Creates a new TupleQueryResultFormat 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.

supportsRDFStar - True if the TupleQueryResultFormat supports the encoding of RDF-star triples natively and false otherwise.

Since:

3.2.0

TupleQueryResultFormat

public TupleQueryResultFormat(String name,
 Collection<String> mimeTypes,
 Charset charset,
 Collection<String> fileExtensions,
 IRI standardURI)

Creates a new TupleQueryResultFormat 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:

3.2.0

TupleQueryResultFormat

public TupleQueryResultFormat(String name,
 Collection<String> mimeTypes,
 Charset charset,
 Collection<String> fileExtensions,
 IRI standardURI,
 boolean supportsRDFStar)

Creates a new TupleQueryResultFormat 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.

supportsRDFStar - True if the TupleQueryResultFormat supports the encoding of RDF-star triples natively and false otherwise.

Since:

3.2.0

Method Details

supportsRDFStar

public boolean supportsRDFStar()

Return true if the TupleQueryResultFormat supports the encoding of RDF-star triples natively.

Since:

3.2.0