You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by bu...@apache.org on 2014/09/03 17:03:34 UTC

svn commit: r921146 - in /websites/staging/jena/trunk/content: ./ documentation/io/streaming-io.html

Author: buildbot
Date: Wed Sep  3 15:03:34 2014
New Revision: 921146

Log:
Staging update by buildbot for jena

Modified:
    websites/staging/jena/trunk/content/   (props changed)
    websites/staging/jena/trunk/content/documentation/io/streaming-io.html

Propchange: websites/staging/jena/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Sep  3 15:03:34 2014
@@ -1 +1 @@
-1622276
+1622278

Modified: websites/staging/jena/trunk/content/documentation/io/streaming-io.html
==============================================================================
--- websites/staging/jena/trunk/content/documentation/io/streaming-io.html (original)
+++ websites/staging/jena/trunk/content/documentation/io/streaming-io.html Wed Sep  3 15:03:34 2014
@@ -155,40 +155,38 @@ input parsing performance using W3C Stan
 <p>Files ending in <code>.gz</code> are assumed to be gzip-compressed. Input and output
 to such files takes this into account, including looking for the other file
 extension.  <code>data.nt.gz</code> is a parsed as a gzip-compressed N-Triples file.</p>
-<p>== <code>StreamRDF</code></p>
+<h2 id="streamrdf"><code>StreamRDF</code></h2>
 <p>The central abstraction is <code>StreamRDF</code> which is an interface for streamed
 RDF data.  It covers triples and quads, and also parser events such as
 prefix settings and base URI declarations.</p>
-<p>```
-public interface StreamRDF {}
-{
-    /*<em> Start parsing </em>/
-    public void start() ;</p>
-<div class="codehilite"><pre><span class="cm">/** Triple emitted */</span>
-<span class="n">public</span> <span class="k">void</span> <span class="n">triple</span><span class="p">(</span><span class="n">Triple</span> <span class="n">triple</span><span class="p">)</span> <span class="p">;</span>
-
-<span class="cm">/** Quad emitted */</span>
-<span class="n">public</span> <span class="k">void</span> <span class="n">quad</span><span class="p">(</span><span class="n">Quad</span> <span class="n">quad</span><span class="p">)</span> <span class="p">;</span>
+<div class="codehilite"><pre><span class="n">public</span> <span class="n">interface</span> <span class="n">StreamRDF</span> <span class="p">{</span>
+    <span class="o">/**</span> <span class="n">Start</span> <span class="n">parsing</span> <span class="o">*/</span>
+    <span class="n">public</span> <span class="n">void</span> <span class="n">start</span><span class="p">()</span> <span class="p">;</span>
 
-<span class="cm">/** base declaration seen */</span>
-<span class="n">public</span> <span class="k">void</span> <span class="n">base</span><span class="p">(</span><span class="n">String</span> <span class="n">base</span><span class="p">)</span> <span class="p">;</span>
+    <span class="o">/**</span> <span class="n">Triple</span> <span class="n">emitted</span> <span class="o">*/</span>
+    <span class="n">public</span> <span class="n">void</span> <span class="n">triple</span><span class="p">(</span><span class="n">Triple</span> <span class="n">triple</span><span class="p">)</span> <span class="p">;</span>
 
-<span class="cm">/** prefix declaration seen */</span>
-<span class="n">public</span> <span class="k">void</span> <span class="n">prefix</span><span class="p">(</span><span class="n">String</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">String</span> <span class="n">iri</span><span class="p">)</span> <span class="p">;</span>
+    <span class="o">/**</span> <span class="n">Quad</span> <span class="n">emitted</span> <span class="o">*/</span>
+    <span class="n">public</span> <span class="n">void</span> <span class="n">quad</span><span class="p">(</span><span class="n">Quad</span> <span class="n">quad</span><span class="p">)</span> <span class="p">;</span>
 
-<span class="cm">/** Finish parsing */</span>
-<span class="n">public</span> <span class="k">void</span> <span class="n">finish</span><span class="p">()</span> <span class="p">;</span>
+    <span class="o">/**</span> <span class="n">base</span> <span class="n">declaration</span> <span class="n">seen</span> <span class="o">*/</span>
+    <span class="n">public</span> <span class="n">void</span> <span class="n">base</span><span class="p">(</span><span class="n">String</span> <span class="n">base</span><span class="p">)</span> <span class="p">;</span>
+
+    <span class="o">/**</span> <span class="n">prefix</span> <span class="n">declaration</span> <span class="n">seen</span> <span class="o">*/</span>
+    <span class="n">public</span> <span class="n">void</span> <span class="n">prefix</span><span class="p">(</span><span class="n">String</span> <span class="n">prefix</span><span class="p">,</span> <span class="n">String</span> <span class="n">iri</span><span class="p">)</span> <span class="p">;</span>
+
+    <span class="o">/**</span> <span class="n">Finish</span> <span class="n">parsing</span> <span class="o">*/</span>
+    <span class="n">public</span> <span class="n">void</span> <span class="n">finish</span><span class="p">()</span> <span class="p">;</span>
+<span class="p">}</span>
 </pre></div>
 
 
-<p>}
-```</p>
 <p>There are utilities to help:</p>
 <ul>
 <li><code>StreamRDFLib</code> -- create <code>StreamRDF</code> objects</li>
 <li><code>StreamOps</code> -- helpers for sending RDF data to <code>StreamRDF</code> objects</li>
 </ul>
-<p>== Reading data</p>
+<h2 id="reading-data">Reading data</h2>
 <p>All parses of RDF syntaxes provided by RIOT are streaming with the
 exception of JSON-LD.  A JSON object can have members in any order so the
 parser may need the whole top-level object in order to have the information
@@ -202,7 +200,7 @@ needed for parsing.</p>
 
 <p>reads the remote URL, with content negotiation, and send the triples to the
 <code>destination</code>.</p>
-<p>== Writing data</p>
+<h2 id="writing-data">Writing data</h2>
 <p>Not all RDF formats are suitable for writing as a stream.  Formats that
 provide pretty printing (for example the default <code>RDFFormat</code> for each of
 Turtle, TriG and RDF/XML) require analysis of the whole of a model in order
@@ -229,46 +227,46 @@ an<code>StreamRDF</code> backed by a str
 <table>
 <thead>
 <tr>
-<th>Lang</th>
 <th>RDFFormat</th>
+<th>Lang shortcut</th>
 </tr>
 </thead>
 <tbody>
 <tr>
-<td><code>Lang.TURTLE</code></td>
 <td><code>RDFFormat.TURTLE_BLOCKS</code></td>
+<td><code>Lang.TURTLE</code></td>
 </tr>
 <tr>
-<td></td>
 <td><code>RDFFormat.TURTLE_FLAT</code></td>
+<td></td>
 </tr>
 <tr>
-<td><code>Lang.TRIG</code></td>
 <td><code>RDFFormat.TRIG_BLOCKS</code></td>
+<td><code>Lang.TRIG</code></td>
 </tr>
 <tr>
-<td></td>
 <td><code>RDFFormat.TRIG_FLAT</code></td>
+<td></td>
 </tr>
 <tr>
-<td><code>Lang.NTRIPLES</code></td>
 <td><code>RDFFormat.NTRIPLES_UTF8</code></td>
+<td><code>Lang.NTRIPLES</code></td>
 </tr>
 <tr>
-<td></td>
 <td><code>RDFFormat.NTRIPLES_ASCII</code></td>
+<td></td>
 </tr>
 <tr>
-<td><code>Lang.NQUADS</code></td>
 <td><code>RDFFormat.NQUADS_UTF8</code></td>
+<td><code>Lang.NQUADS</code></td>
 </tr>
 <tr>
-<td></td>
 <td><code>RDFFormat.NQUADS_ASCII</code></td>
+<td></td>
 </tr>
 <tr>
-<td><code>Lang.RDFTHRIFT</code></td>
 <td><code>RDFFormat.RDF_THRIFT</code></td>
+<td><code>Lang.RDFTHRIFT</code></td>
 </tr>
 </tbody>
 </table>