mirror of
https://github.com/cookiengineer/audacity
synced 2025-06-21 23:00:06 +02:00
350 lines
23 KiB
XML
350 lines
23 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
|
<!ENTITY version SYSTEM "version.xml">
|
|
]>
|
|
<refentry id="rasqal-section-query-results-formatter">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page" id="rasqal-section-query-results-formatter.top_of_page">Query Results Formatter</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>RASQAL Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>Query Results Formatter</refname>
|
|
<refpurpose>Query results formatted into a syntax.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv id="rasqal-section-query-results-formatter.synopsis" role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
<link linkend="int">int</link> <link linkend="rasqal-query-results-formats-check">rasqal_query_results_formats_check</link> (<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
const <link linkend="char">char</link> *name,
|
|
<link linkend="raptor-uri">raptor_uri</link> *uri,
|
|
const <link linkend="char">char</link> *mime_type);
|
|
#define <link linkend="RASQAL-QUERY-RESULTS-FORMAT-FLAG-READER:CAPS">RASQAL_QUERY_RESULTS_FORMAT_FLAG_READER</link>
|
|
#define <link linkend="RASQAL-QUERY-RESULTS-FORMAT-FLAG-WRITER:CAPS">RASQAL_QUERY_RESULTS_FORMAT_FLAG_WRITER</link>
|
|
<link linkend="int">int</link> <link linkend="rasqal-query-results-formats-enumerate">rasqal_query_results_formats_enumerate</link>
|
|
(<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
unsigned <link linkend="int">int</link> counter,
|
|
const <link linkend="char">char</link> **name,
|
|
const <link linkend="char">char</link> **label,
|
|
unsigned <link linkend="char">char</link> **uri_string,
|
|
const <link linkend="char">char</link> **mime_type,
|
|
<link linkend="int">int</link> *flags);
|
|
typedef <link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link>;
|
|
<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link>* <link linkend="rasqal-new-query-results-formatter">rasqal_new_query_results_formatter</link>
|
|
(<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
const <link linkend="char">char</link> *name,
|
|
<link linkend="raptor-uri">raptor_uri</link> *format_uri);
|
|
<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link>* <link linkend="rasqal-new-query-results-formatter-by-mime-type">rasqal_new_query_results_formatter_by_mime_type</link>
|
|
(<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
const <link linkend="char">char</link> *mime_type);
|
|
<link linkend="void">void</link> <link linkend="rasqal-free-query-results-formatter">rasqal_free_query_results_formatter</link> (<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link> *formatter);
|
|
const <link linkend="char">char</link>* <link linkend="rasqal-query-results-formatter-get-mime-type">rasqal_query_results_formatter_get_mime_type</link>
|
|
(<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link> *formatter);
|
|
<link linkend="int">int</link> <link linkend="rasqal-query-results-formatter-read">rasqal_query_results_formatter_read</link> (<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
|
|
<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link> *formatter,
|
|
<link linkend="rasqal-query-results">rasqal_query_results</link> *results,
|
|
<link linkend="raptor-uri">raptor_uri</link> *base_uri);
|
|
<link linkend="int">int</link> <link linkend="rasqal-query-results-formatter-write">rasqal_query_results_formatter_write</link>
|
|
(<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
|
|
<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link> *formatter,
|
|
<link linkend="rasqal-query-results">rasqal_query_results</link> *results,
|
|
<link linkend="raptor-uri">raptor_uri</link> *base_uri);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 id="rasqal-section-query-results-formatter.description" role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
Variable bindings and boolean query results can be formatted into
|
|
different syntaxes such as SPARQL Query Results Format or JSON.
|
|
The rasqal_query_results_formatter class allows choosing a formatter
|
|
for a particular syntax and writing the syntax to a raptor_iostream
|
|
which allows turning the syntax into a string, writing to a file
|
|
handle or other custom destination.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 id="rasqal-section-query-results-formatter.details" role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2 id="rasqal-query-results-formats-check" role="function">
|
|
<title>rasqal_query_results_formats_check ()</title>
|
|
<indexterm zone="rasqal-query-results-formats-check"><primary>rasqal_query_results_formats_check</primary></indexterm><programlisting><link linkend="int">int</link> rasqal_query_results_formats_check (<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
const <link linkend="char">char</link> *name,
|
|
<link linkend="raptor-uri">raptor_uri</link> *uri,
|
|
const <link linkend="char">char</link> *mime_type);</programlisting>
|
|
<para>
|
|
Check if a query results formatter exists for the requested format.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>world</parameter> :</term>
|
|
<listitem><simpara> rasqal_world object
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> the query results format name (or NULL)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>uri</parameter> :</term>
|
|
<listitem><simpara> <link linkend="raptor-uri"><type>raptor_uri</type></link> query results format uri (or NULL)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mime_type</parameter> :</term>
|
|
<listitem><simpara> mime type name
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 if a formatter exists.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="RASQAL-QUERY-RESULTS-FORMAT-FLAG-READER:CAPS" role="macro">
|
|
<title>RASQAL_QUERY_RESULTS_FORMAT_FLAG_READER</title>
|
|
<indexterm zone="RASQAL-QUERY-RESULTS-FORMAT-FLAG-READER:CAPS"><primary>RASQAL_QUERY_RESULTS_FORMAT_FLAG_READER</primary></indexterm><programlisting>#define RASQAL_QUERY_RESULTS_FORMAT_FLAG_READER 1
|
|
</programlisting>
|
|
<para>
|
|
Flag for <link linkend="rasqal-query-results-formats-enumerate"><function>rasqal_query_results_formats_enumerate()</function></link> to get query results formats that can be read.</para>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2 id="RASQAL-QUERY-RESULTS-FORMAT-FLAG-WRITER:CAPS" role="macro">
|
|
<title>RASQAL_QUERY_RESULTS_FORMAT_FLAG_WRITER</title>
|
|
<indexterm zone="RASQAL-QUERY-RESULTS-FORMAT-FLAG-WRITER:CAPS"><primary>RASQAL_QUERY_RESULTS_FORMAT_FLAG_WRITER</primary></indexterm><programlisting>#define RASQAL_QUERY_RESULTS_FORMAT_FLAG_WRITER 2
|
|
</programlisting>
|
|
<para>
|
|
Flag for <link linkend="rasqal-query-results-formats-enumerate"><function>rasqal_query_results_formats_enumerate()</function></link> to get query results formats that can be written.</para>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2 id="rasqal-query-results-formats-enumerate" role="function">
|
|
<title>rasqal_query_results_formats_enumerate ()</title>
|
|
<indexterm zone="rasqal-query-results-formats-enumerate"><primary>rasqal_query_results_formats_enumerate</primary></indexterm><programlisting><link linkend="int">int</link> rasqal_query_results_formats_enumerate
|
|
(<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
unsigned <link linkend="int">int</link> counter,
|
|
const <link linkend="char">char</link> **name,
|
|
const <link linkend="char">char</link> **label,
|
|
unsigned <link linkend="char">char</link> **uri_string,
|
|
const <link linkend="char">char</link> **mime_type,
|
|
<link linkend="int">int</link> *flags);</programlisting>
|
|
<para>
|
|
Get information on query result syntaxes.
|
|
</para>
|
|
<para>
|
|
The current list of format names/URI is given below however
|
|
the results of this function will always return the latest.
|
|
</para>
|
|
<para>
|
|
SPARQL XML Results 2007-06-14 (default format when <parameter>counter</parameter> is 0)
|
|
name '<literal>xml</literal>' with
|
|
URIs http://www.w3.org/TR/2006/WD-rdf-sparql-XMLres-20070614/ or
|
|
http://www.w3.org/2005/sparql-results#
|
|
</para>
|
|
<para>
|
|
JSON name '<literal>json</literal>' and
|
|
URI http://www.w3.org/2001/sw/DataAccess/json-sparql/
|
|
</para>
|
|
<para>
|
|
All returned strings are shared and must be copied if needed to be
|
|
used dynamically.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>world</parameter> :</term>
|
|
<listitem><simpara> rasqal_world object
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>counter</parameter> :</term>
|
|
<listitem><simpara> index into the list of query result syntaxes
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> pointer to store the name of the query result syntax (or NULL)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>label</parameter> :</term>
|
|
<listitem><simpara> pointer to store query result syntax readable label (or NULL)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>uri_string</parameter> :</term>
|
|
<listitem><simpara> pointer to store query result syntax URI string (or NULL)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mime_type</parameter> :</term>
|
|
<listitem><simpara> pointer to store query result syntax mime type string (or NULL)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>flags</parameter> :</term>
|
|
<listitem><simpara> pointer to store query result syntax flags (or NULL)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non 0 on failure of if counter is out of range
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="rasqal-query-results-formatter" role="typedef">
|
|
<title>rasqal_query_results_formatter</title>
|
|
<indexterm zone="rasqal-query-results-formatter"><primary>rasqal_query_results_formatter</primary></indexterm><programlisting>rasqal_graph_query_results_formatter* query_results_formatter;
|
|
</programlisting>
|
|
<para>
|
|
Rasqal query results formatter class.</para>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2 id="rasqal-new-query-results-formatter" role="function">
|
|
<title>rasqal_new_query_results_formatter ()</title>
|
|
<indexterm zone="rasqal-new-query-results-formatter"><primary>rasqal_new_query_results_formatter</primary></indexterm><programlisting><link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link>* rasqal_new_query_results_formatter
|
|
(<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
const <link linkend="char">char</link> *name,
|
|
<link linkend="raptor-uri">raptor_uri</link> *format_uri);</programlisting>
|
|
<para>
|
|
Constructor - create a new rasqal_query_results_formatter object by identified format.
|
|
</para>
|
|
<para>
|
|
A query results format can be named or identified by a URI, both
|
|
of which are optional. The default query results format will be used
|
|
if both are NULL. <link linkend="rasqal-query-results-formats-enumerate"><function>rasqal_query_results_formats_enumerate()</function></link> returns
|
|
information on the known query results names, labels and URIs.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>world</parameter> :</term>
|
|
<listitem><simpara> rasqal_world object
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> the query results format name (or NULL)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>format_uri</parameter> :</term>
|
|
<listitem><simpara> <link linkend="raptor-uri"><type>raptor_uri</type></link> query results format uri (or NULL)
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="rasqal-query-results-formatter"><type>rasqal_query_results_formatter</type></link> object or NULL on failure
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="rasqal-new-query-results-formatter-by-mime-type" role="function">
|
|
<title>rasqal_new_query_results_formatter_by_mime_type ()</title>
|
|
<indexterm zone="rasqal-new-query-results-formatter-by-mime-type"><primary>rasqal_new_query_results_formatter_by_mime_type</primary></indexterm><programlisting><link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link>* rasqal_new_query_results_formatter_by_mime_type
|
|
(<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
const <link linkend="char">char</link> *mime_type);</programlisting>
|
|
<para>
|
|
Constructor - create a new rasqal_query_results_formatter object by mime type.
|
|
</para>
|
|
<para>
|
|
A query results format generates a syntax with a mime type which
|
|
may be requested with this constructor.
|
|
</para>
|
|
<para>
|
|
Note that there may be several formatters that generate the same
|
|
MIME Type (such as SPARQL XML results format drafts) and in thot
|
|
case the <link linkend="rasqal-new-query-results-formatter"><function>rasqal_new_query_results_formatter()</function></link> constructor allows
|
|
selecting of a specific one by name or URI.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>world</parameter> :</term>
|
|
<listitem><simpara> rasqal_world object
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mime_type</parameter> :</term>
|
|
<listitem><simpara> mime type name
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="rasqal-query-results-formatter"><type>rasqal_query_results_formatter</type></link> object or NULL on failure
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="rasqal-free-query-results-formatter" role="function">
|
|
<title>rasqal_free_query_results_formatter ()</title>
|
|
<indexterm zone="rasqal-free-query-results-formatter"><primary>rasqal_free_query_results_formatter</primary></indexterm><programlisting><link linkend="void">void</link> rasqal_free_query_results_formatter (<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link> *formatter);</programlisting>
|
|
<para>
|
|
Destructor - destroy a <link linkend="rasqal-query-results-formatter"><type>rasqal_query_results_formatter</type></link> object.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>formatter</parameter> :</term>
|
|
<listitem><simpara> <link linkend="rasqal-query-results-formatter"><type>rasqal_query_results_formatter</type></link> object
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="rasqal-query-results-formatter-get-mime-type" role="function">
|
|
<title>rasqal_query_results_formatter_get_mime_type ()</title>
|
|
<indexterm zone="rasqal-query-results-formatter-get-mime-type"><primary>rasqal_query_results_formatter_get_mime_type</primary></indexterm><programlisting>const <link linkend="char">char</link>* rasqal_query_results_formatter_get_mime_type
|
|
(<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link> *formatter);</programlisting>
|
|
<para>
|
|
Get the mime type of the syntax being formatted.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>formatter</parameter> :</term>
|
|
<listitem><simpara> <link linkend="rasqal-query-results-formatter"><type>rasqal_query_results_formatter</type></link> object
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a shared mime type string
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="rasqal-query-results-formatter-read" role="function">
|
|
<title>rasqal_query_results_formatter_read ()</title>
|
|
<indexterm zone="rasqal-query-results-formatter-read"><primary>rasqal_query_results_formatter_read</primary></indexterm><programlisting><link linkend="int">int</link> rasqal_query_results_formatter_read (<link linkend="rasqal-world">rasqal_world</link> *world,
|
|
<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
|
|
<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link> *formatter,
|
|
<link linkend="rasqal-query-results">rasqal_query_results</link> *results,
|
|
<link linkend="raptor-uri">raptor_uri</link> *base_uri);</programlisting>
|
|
<para>
|
|
Read the query results using the given formatter from an iostream
|
|
</para>
|
|
<para>
|
|
See <link linkend="rasqal-query-results-formats-enumerate"><function>rasqal_query_results_formats_enumerate()</function></link> to get the
|
|
list of syntax URIs and their description.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>world</parameter> :</term>
|
|
<listitem><simpara> rasqal world object
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>iostr</parameter> :</term>
|
|
<listitem><simpara> <link linkend="raptor-iostream"><type>raptor_iostream</type></link> to read the query from
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>formatter</parameter> :</term>
|
|
<listitem><simpara> <link linkend="rasqal-query-results-formatter"><type>rasqal_query_results_formatter</type></link> object
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>results</parameter> :</term>
|
|
<listitem><simpara> <link linkend="rasqal-query-results"><type>rasqal_query_results</type></link> query results format
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>base_uri</parameter> :</term>
|
|
<listitem><simpara> <link linkend="raptor-uri"><type>raptor_uri</type></link> base URI of the input format
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="rasqal-query-results-formatter-write" role="function">
|
|
<title>rasqal_query_results_formatter_write ()</title>
|
|
<indexterm zone="rasqal-query-results-formatter-write"><primary>rasqal_query_results_formatter_write</primary></indexterm><programlisting><link linkend="int">int</link> rasqal_query_results_formatter_write
|
|
(<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
|
|
<link linkend="rasqal-query-results-formatter">rasqal_query_results_formatter</link> *formatter,
|
|
<link linkend="rasqal-query-results">rasqal_query_results</link> *results,
|
|
<link linkend="raptor-uri">raptor_uri</link> *base_uri);</programlisting>
|
|
<para>
|
|
Write the query results using the given formatter to an iostream
|
|
</para>
|
|
<para>
|
|
See <link linkend="rasqal-query-results-formats-enumerate"><function>rasqal_query_results_formats_enumerate()</function></link> to get the
|
|
list of syntax URIs and their description.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>iostr</parameter> :</term>
|
|
<listitem><simpara> <link linkend="raptor-iostream"><type>raptor_iostream</type></link> to write the query to
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>formatter</parameter> :</term>
|
|
<listitem><simpara> <link linkend="rasqal-query-results-formatter"><type>rasqal_query_results_formatter</type></link> object
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>results</parameter> :</term>
|
|
<listitem><simpara> <link linkend="rasqal-query-results"><type>rasqal_query_results</type></link> query results format
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>base_uri</parameter> :</term>
|
|
<listitem><simpara> <link linkend="raptor-uri"><type>raptor_uri</type></link> base URI of the output format
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|