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 2011/12/11 23:05:43 UTC
svn commit: r800095 - in
/websites/staging/jena/trunk/content/jena/documentation/io: index.html
riot.html
Author: buildbot
Date: Sun Dec 11 22:05:43 2011
New Revision: 800095
Log:
Staging update by buildbot
Added:
websites/staging/jena/trunk/content/jena/documentation/io/riot.html
Modified:
websites/staging/jena/trunk/content/jena/documentation/io/index.html
Modified: websites/staging/jena/trunk/content/jena/documentation/io/index.html
==============================================================================
--- websites/staging/jena/trunk/content/jena/documentation/io/index.html (original)
+++ websites/staging/jena/trunk/content/jena/documentation/io/index.html Sun Dec 11 22:05:43 2011
@@ -162,6 +162,7 @@ are documented in the RIOT subsystem [TO
<li><a href="features.html">ARP Features</a></li>
<li><a href="standalone.html">Using ARP without Jena</a></li>
<li><a href="sax.html">Using other SAX and DOM XML sources</a></li>
+<li><a href="riot.html">RDF I/O with RIOT</a></li>
</ul>
</div>
Added: websites/staging/jena/trunk/content/jena/documentation/io/riot.html
==============================================================================
--- websites/staging/jena/trunk/content/jena/documentation/io/riot.html (added)
+++ websites/staging/jena/trunk/content/jena/documentation/io/riot.html Sun Dec 11 22:05:43 2011
@@ -0,0 +1,282 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/jena/css/jena.css" rel="stylesheet" type="text/css">
+ <title>Apache Jena - RDF I/O with RIOT</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <script src="/jena/js/jquery-1.6.4.min.js" type="text/javascript"></script>
+ <script src="/jena/js/jena-navigation.js" type="text/javascript"></script>
+</head>
+
+<body>
+ <div id="header">
+ <div id="logoblock">
+ <img alt="Apache Jena" src="/jena/images/jena-logo/jena-logo-small.png"/>
+ </div>
+
+ <div id="titleblock">
+ <h1 class="title">Apache Jena</h1>
+ <div id="topmenu" class="tabbar round-10">
+ <ul>
+ <li class="round-top-8"><a class="round-top-8" href="/jena/index.html" id="home_menu">Home</a></li>
+ <li class="round-top-8"><a class="round-top-8" href="/jena/help_and_support/index.html">Support</a></li>
+ <li class="round-top-8"><a class="round-top-8" href="/jena/getting_started/index.html">Getting started</a></li>
+ <li class="round-top-8"><a class="round-top-8" href="/jena/tutorials/index.html">Tutorials</a></li>
+ <li class="round-top-8"><a class="round-top-8" href="/jena/documentation/index.html">Documentation</a></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+
+ <div id="navigation" class="clear">
+ <h1 id="quick_links">Quick links</h1>
+<ul>
+<li><a href="/jena/index.html">Home</a></li>
+<li><a href="/jena/download/index.html">Downloads</a></li>
+<li><a href="/jena/help_and_support/index.html">Help and support</a></li>
+<li><a href="/jena/help_and_support/bugs_and_suggestions.html">Report a bug</a></li>
+<li><a href="/jena/about_jena/roadmap.html">Roadmap</a></li>
+<li><a href="/jena/getting_involved/index.html">Getting involved</a></li>
+<li><a href="/jena/documentation/">Documentation</a></li>
+</ul>
+<h1 id="about_jena">About Jena</h1>
+<ul>
+<li><a href="/jena/index.html">Home</a></li>
+<li><a href="/jena/about_jena/about.html">About Jena</a></li>
+<li><a href="/jena/about_jena/architecture.html">Architecture</a></li>
+<li><a href="/jena/about_jena/roadmap.html">Roadmap</a></li>
+<li><a href="/jena/about_jena/team.html">Project team</a></li>
+<li><a href="/jena/about_jena/contributions.html">Related projects</a></li>
+</ul>
+<h1 id="download">Download</h1>
+<ul>
+<li><a href="/jena/download/index.html">Downloading Jena</a></li>
+<li><a href="/jena/download/maven.html">Using Maven</a></li>
+<li><a href="/jena/download/osgi.html">Using OSGi</a></li>
+</ul>
+<h1 id="help_and_support">Help and support</h1>
+<ul>
+<li><a href="/jena/help_and_support/index.html">Getting help</a></li>
+<li><a href="/jena/help_and_support/bugs_and_suggestions.html">Bugs and suggestions</a></li>
+</ul>
+<h1 id="getting_started">Getting Started</h1>
+<ul>
+<li><a href="/jena/getting_started/index.html">A first Jena project</a></li>
+<li><a href="/jena/getting_started/rdf_api.html">RDF API overview</a></li>
+<li><a href="/jena/getting_started/sparql.html">Querying RDF with SPARQL</a></li>
+<li><a href="/jena/getting_started/fuseki.html">Serving RDF over HTTP</a></li>
+<li><a href="/jena/getting_started/tell_me_how.html">Tell me how to ...</a></li>
+</ul>
+<h1 id="tutorials">Tutorials</h1>
+<ul>
+<li><a href="/jena/tutorials/index.html">Tutorials index</a></li>
+<li><a href="/jena/tutorials/rdf_api.html">RDF tutorial</a></li>
+<li><a href="/jena/tutorials/sparql.html">SPARQL queries</a></li>
+<li><a href="/jena/tutorials/using_jena_with_eclipse.html">Using Jena with Eclipse</a></li>
+</ul>
+<h1 id="documentation">Documentation</h1>
+<ul>
+<li><a href="/jena/documentation/index.html">Overview</a></li>
+<li><a href="/jena/documentation/javadoc">Javadoc</a></li>
+<li><a href="/jena/documentation/rdf/index.html">RDF</a></li>
+<li><a href="/jena/documentation/query/index.html">SPARQL (ARQ)</a></li>
+<li><a href="/jena/documentation/tdb/index.html">TDB</a></li>
+<li><a href="/jena/documentation/sdb/index.html">SDB</a><ul>
+<li><a href="/jena/documentation/sdb/installation.html">Installation</a></li>
+<li><a href="/jena/documentation/sdb/quickstart.html">Quick start</a></li>
+<li><a href="/jena/documentation/sdb/commands.html">Cmd line</a></li>
+<li><a href="/jena/documentation/sdb/javaapi.html">Java API</a></li>
+<li><a href="/jena/documentation/sdb/configuration.html">Config</a></li>
+<li><a href="/jena/documentation/sdb/databases_supported.html">Databases</a></li>
+</ul>
+</li>
+<li><a href="/jena/documentation/larq/index.html">LARQ</a></li>
+<li><a href="/jena/documentation/serving_data/index.html">Fuseki: Serving Data</a></li>
+<li><a href="/jena/documentation/ontology/index.html">Ontology</a></li>
+<li><a href="/jena/documentation/inference/index.html">Inference</a></li>
+<li><a href="/jena/documentation/assembler/index.html">Assembler</a><ul>
+<li><a href="/jena/documentation/assembler/assembler-howto.html">Assembler how-to</a></li>
+<li><a href="/jena/documentation/assembler/inside-assemblers.html">Inside assemblers</a></li>
+</ul>
+</li>
+<li><a href="/jena/documentation/io/index.html">I/O</a><ul>
+<li><a href="/jena/documentation/io/iohowto.html">I/O how-to</a></li>
+</ul>
+</li>
+<li><a href="/jena/documentation/notes/index.html">Notes</a><ul>
+<li><a href="/jena/documentation/notes/concurrency-howto.html">Concurrency how-to</a></li>
+<li><a href="/jena/documentation/notes/event-handler-howto.html">Event handler how-to</a></li>
+<li><a href="/jena/documentation/notes/file-manager.html">File manager how-to</a></li>
+<li><a href="/jena/documentation/notes/model-factory.html">Model factory how-to</a></li>
+<li><a href="/jena/documentation/notes/rdf-frames.html">RDF frames</a></li>
+<li><a href="/jena/documentation/notes/reification.html">Reification how-to</a></li>
+<li><a href="/jena/documentation/notes/typed-literals.html">Typed literals how-to</a></li>
+</ul>
+</li>
+<li><a href="/jena/documentation/tools/index.html">Tools</a><ul>
+<li><a href="/jena/documentation/tools/schemagen.html">schemagen</a></li>
+<li><a href="/jena/documentation/tools/eyeball-getting-started.html">eyeball</a></li>
+</ul>
+</li>
+</ul>
+<h1 id="getting_involved">Getting Involved</h1>
+<ul>
+<li><a href="/jena/getting_involved/index.html">Contributing to Jena</a></li>
+</ul>
+<h1 id="asf_links">ASF links</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">RDF I/O with RIOT</h1>
+ <p>RIOT - <em>RDF I/O Technology</em> - is a code library to support parsing
+and writing of RDF in non-XML formats. At the moment, the module
+focused on input.</p>
+<p>Currently supported input syntaxes are:</p>
+<ul>
+<li><a href="http://www.w3.org/TeamSubmission/turtle/">Turtle</a></li>
+<li><a href="http://www.w3.org/TR/rdf-testcases/#ntriples">N-Triples</a></li>
+<li><a href="http://www4.wiwiss.fu-berlin.de/bizer/TriG/">TriG</a></li>
+<li><a href="http://sw.deri.org/2008/07/n-quads/">N-Quads</a></li>
+</ul>
+<h2 id="contents">Contents</h2>
+<ul>
+<li><a href="#status">Status</a></li>
+<li><a href="#commands">Commands</a></li>
+<li><a href="#inference">Inference</a></li>
+<li><a href="#api">API</a></li>
+<li><a href="#output_and_logging">Output and Logging</a></li>
+<li><a href="#wiring_into_jena">Wiring into Jena</a></li>
+<li><a href="#notes">Notes</a></li>
+<li><a href="#see_also">See Also</a></li>
+<li><a href="#contributions">Contributions</a></li>
+<li><a href="#support">Support</a></li>
+</ul>
+<h2 id="status">Status</h2>
+<p>RIOT is currently distributed as part of
+<a href="arq1.html" title="http://openjena.org/ARQ">ARQ</a>.</p>
+<h2 id="commands">Commands</h2>
+<p>There are Linux bash scripts in /ARQ/bin to run these commands, and
+indirection scripts that can be drop into any directory on the
+PATH.</p>
+<ul>
+<li><code>riot</code> -- parse, guessing the syntax from the file extension.
+ Assumed N-Quads/N-Triples from stdin.</li>
+<li><code>turtle</code>, <code>ntriples</code>, <code>nquads</code>, <code>trig</code> -- parse a particular language</li>
+</ul>
+<p>The file extensions are:</p>
+<ul>
+<li>.nt -- N-triples</li>
+<li>.ttl -- Turtle</li>
+<li>.nq -- N-Quads</li>
+<li>.trig -- TriG</li>
+</ul>
+<p>In addition, if the extension is .gz the file is assumed to be gzip
+compressed. The file name is examined for an inner extension. For
+example, <code>.nt.gz</code> is gzip compressed N-Triples.</p>
+<p>Each script calls a Java program.</p>
+<p>The scripts all accept the same arguments (type "riot --help" to
+get command line reminders):</p>
+<ul>
+<li><code>--validate</code>: Checking mode: same as --strict --sink --check=true</li>
+<li><code>--check=true/false</code>: Run with checking of literals and IRIs
+ either on or off.</li>
+<li><code>--sink</code>: No output of triples or quads.</li>
+<li><code>--time</code>: Output timing information.</li>
+</ul>
+<p>To aid in checking for errors in UTF8-encoded files, there is a
+utility which reads a file of bytes as UTF8 and checks the
+codepoints are defined.</p>
+<ul>
+<li><code>utf8</code> -- read bytes as UTF8</li>
+</ul>
+<h2 id="inference">Inference</h2>
+<p>RIOT support creation of inferred triples during the parsing
+process:</p>
+<div class="codehilite"><pre><span class="n">riotcmd</span><span class="o">.</span><span class="n">infer</span> <span class="o">--</span><span class="n">rdfs</span> <span class="n">VOCAB</span> <span class="n">FILE</span> <span class="n">FILE</span> <span class="o">...</span>
+</pre></div>
+
+
+<p>Output will contain the base data and triples inferred based on
+subclass, subproperty, domain and range.</p>
+<h2 id="api">API</h2>
+<p>The formal, stable API to RIOT does not yet exist. Future code
+reorganized will occur but there are there are certain key classes
+that provide access to the facilities:</p>
+<ul>
+<li>RiotReader -- create parsers</li>
+<li>RiotLoader -- parse into datasets and graphs</li>
+<li>WebReader -- read data fro the web (content negotiation etc)
+ [Not implemented]</li>
+<li>SysRIOT -- constants and setup</li>
+</ul>
+<h2 id="output_and_logging">Output and Logging</h2>
+<p>Messages from RIOT are output using
+<a href="http://slf4j.org/">SLF4J</a>. Any logging system
+that provides an implementation or adapter for
+<a href="http://slf4j.org/">SLF4J</a> can be used to
+direct the output. This includes
+<a href="http://logging.apache.org/log4j/index.html">Apache log4j</a>
+and <code>java.util.logging</code>.</p>
+<p>The logger name is "org.openjena.riot" (the constant
+<code>SysRIOT.riotLoggerName</code>), and the logger can be obtained using the
+call <code>SysRIOT.getLogger()</code>.</p>
+<h2 id="wiring_into_jena">Wiring into Jena</h2>
+<p>The call SysRIOT.wireIntoJena() will replace the usual Jena readers
+with the RIOT ones. Then calls to model.read for the appropriate
+syntax will use the RIOT parsers.</p>
+<p>The usual Jena readers can be reinstalled with
+SysRIOT.resetJenaReaders()</p>
+<h2 id="notes">Notes</h2>
+<p>N-Quads: only IRIs for the fourth field are supported.</p>
+<p>For TriG and N-Quads, bNode labels are assumed to be file-scoped.
+(See
+<a href="http://seaborne.blogspot.com/2010/06/standardising-rdf-syntaxes.html">here</a>
+for a discussion.)</p>
+<h2 id="see_also">See Also</h2>
+<p><a href="http://seaborne.blogspot.com/2010/06/standardising-rdf-syntaxes.html">Notes on RDF syntaxes (June 2010)</a></p>
+<h2 id="contributions">Contributions</h2>
+<p>Please send patches to
+<a href="https://issues.apache.org/jira/browse/JENA">Apache Jena JIRA</a>.</p>
+<h2 id="support">Support</h2>
+<p>Please email jena-users@incubator.apache.org.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2011 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache Jena, Jena, the Apache Jena project logo,
+ Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>