You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@clerezza.apache.org by ha...@apache.org on 2018/02/19 08:54:54 UTC
svn commit: r1824724 - in
/clerezza/site/production/getting-started/tutorial/tutorial-03: ./ index.html
Author: hasan
Date: Mon Feb 19 08:54:54 2018
New Revision: 1824724
URL: http://svn.apache.org/viewvc?rev=1824724&view=rev
Log:
CLEREZZA-1017: Add Tutorial 03
Added:
clerezza/site/production/getting-started/tutorial/tutorial-03/
clerezza/site/production/getting-started/tutorial/tutorial-03/index.html
Added: clerezza/site/production/getting-started/tutorial/tutorial-03/index.html
URL: http://svn.apache.org/viewvc/clerezza/site/production/getting-started/tutorial/tutorial-03/index.html?rev=1824724&view=auto
==============================================================================
--- clerezza/site/production/getting-started/tutorial/tutorial-03/index.html (added)
+++ clerezza/site/production/getting-started/tutorial/tutorial-03/index.html Mon Feb 19 08:54:54 2018
@@ -0,0 +1,349 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <link type="text/css" href="/style/style.css" rel="stylesheet"/>
+ <title>Tutorial 03 - Convert Serialized Graph Representation</title>
+ </head>
+ <body>
+ <div class="zz-header">
+ <div class="bar"></div>
+ <div class="logo">
+ <a href="http://clerezza.apache.org/" style="">
+ <img src="/images/logo.png" alt="logo"/>
+ </a>
+ </div>
+ </div>
+ <div class="column nav">
+ <ul>
+ <li class="top-nav-entry">
+ <div class="title">Documentation</div>
+ <ul class="nav-entries">
+ <li>
+ <a href="/getting-started/" class="active">Getting Started</a>
+ </li>
+ <li>
+ <a href="/architecture/">The Apache Clerezza Stack</a>
+ </li>
+ <li>
+ <a href="http://clerezza.apache.org/apidocs/" target="_blank">API docs</a>
+ </li>
+ <li>
+ <a href="/faq/">FAQ</a>
+ </li>
+ </ul>
+ </li>
+ <li class="top-nav-entry">
+ <div class="title">Project Infos</div>
+ <ul class="nav-entries">
+ <li>
+ <a href="/downloads/">Downloads</a>
+ </li>
+ <li>
+ <a href="/contributing/">Contributing</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/licenses/" target="_blank">License</a>
+ </li>
+ <li>
+ <a href="/mailinglists/">Mailing lists</a>
+ </li>
+ <li>
+ <a href="http://issues.apache.org/jira/browse/CLEREZZA" target="_blank">Issue Tracker</a>
+ </li>
+ <li>
+ <a href="https://git-wip-us.apache.org/repos/asf?p=clerezza.git" target="_blank">Source Repository</a>
+ </li>
+ </ul>
+ </li>
+ <li class="top-nav-entry">
+ <div class="title">Sponsorship</div>
+ <ul class="nav-entries">
+ <li>
+ <a href="/thanks/">Thanks</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">Become a Sponsor</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/foundation/buy_stuff.html" target="_blank">Buy Stuff</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ <div class="zz-content">
+ <h1>Tutorial 03 - Convert Serialized Graph Representation</h1>
+ <div class='tx-content'>
+ <div>
+ <div xmlns="http://www.w3.org/1999/xhtml" class="column one-column">
+ <div>
+ Author: Hasan (hasan@apache.org)
+ </div>
+ <div>
+ Last update: February 19, 2018
+ </div>
+ <p>
+ This tutorial aims at showing how we can use a parser and a serializer to convert a graph representation from one format to another format.
+ </p>
+ <h2>Problem Definition</h2>
+ <p>
+ Given a file containing a set of triples in <a href="https://www.w3.org/TR/turtle/">Turtle</a> serialization format (text/turtle), another file is to be created containing the same triples in <a href="https://www.w3.org/TR/rdf-syntax-grammar/">RDF/XML</a> serialization format. Assuming the content of the turtle file is as follows:
+ </p>
+ <div xmlns="http://www.w3.org/1999/xhtml" class="tx-blockcode">
+@prefix ex: <http://clerezza.apache.org/2017/01/example#> .
+_:a ex:hasFirstName "Hasan" .
+_:a ex:isA ex:ClerezzaUser .
+ </div>
+ <p>
+ the program should create a new file /tmp/example03.rdf containing the triples in RDF/XML format.
+ </p>
+ <h2>Solution</h2>
+ <p>
+ As shown in Tutorial 02, Apache Clerezza provides a Parser that can be used to read files containing triples in various serialization format. In this tutorial, we will also use a ParsingProvider based on Jena Parser to parse the turtle file into a Simple Graph. Afterwards the graph will be serialized using the Apache Clerezza Serializer. The Serializer makes use of SerializingProvider services which implement the functionality to serialized graphs to files of specific data format. We are going to use a SerializingProvider based on Jena Serializer.
+ </p>
+ <p>
+ The programme listed below reads the file example03.ttl, parses its content into a Graph, and serializes the Graph to /tmp/example03.rdf.
+ </p>
+ <div xmlns="http://www.w3.org/1999/xhtml" class="tx-blockcode">
+ 1 package org.apache.clerezza.tutorial;
+ 2
+ 3 import org.apache.clerezza.commons.rdf.Graph;
+ 4 import org.apache.clerezza.rdf.core.serializedform.Parser;
+ 5 import org.apache.clerezza.rdf.core.serializedform.Serializer;
+ 6 import org.apache.clerezza.rdf.core.serializedform.SupportedFormat;
+ 7 import org.apache.clerezza.rdf.core.serializedform.UnsupportedFormatException;
+ 8 import org.slf4j.Logger;
+ 9 import org.slf4j.LoggerFactory;
+ 10
+ 11 import java.io.FileNotFoundException;
+ 12 import java.io.FileOutputStream;
+ 13 import java.io.InputStream;
+ 14
+ 15 public class Example03 {
+ 16
+ 17 private static final Logger logger = LoggerFactory.getLogger(Example03.class);
+ 18
+ 19 public static void main(String[] args) {
+ 20 InputStream inputStream = Example03.class.getResourceAsStream("example03.ttl");
+ 21 Parser parser = Parser.getInstance();
+ 22
+ 23 Graph graph;
+ 24 try {
+ 25 graph = parser.parse(inputStream, SupportedFormat.TURTLE);
+ 26 } catch (UnsupportedFormatException ex) {
+ 27 logger.warn(String.format("%s is not supported by the used parser", SupportedFormat.TURTLE));
+ 28 return;
+ 29 }
+ 30
+ 31 Serializer serializer = Serializer.getInstance();
+ 32 try {
+ 33 FileOutputStream outputStream = new FileOutputStream("/tmp/example03.rdf");
+ 34 serializer.serialize(outputStream, graph, SupportedFormat.RDF_XML);
+ 35 } catch (FileNotFoundException ex) {
+ 36 logger.warn(ex.getMessage());
+ 37 } catch (UnsupportedFormatException ex) {
+ 38 logger.warn(String.format("%s is not supported by the used serializer", SupportedFormat.RDF_XML));
+ 39 }
+ 40 }
+ 41 }
+ </div>
+ <p>
+ We will use maven for building the program. The required POM file is as follows:
+ </p>
+ <div xmlns="http://www.w3.org/1999/xhtml" class="tx-blockcode">
+ 1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ 2 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ 3 <modelVersion>4.0.0</modelVersion>
+ 4 <groupId>org.apache.clerezza.tutorial</groupId>
+ 5 <artifactId>Example-03</artifactId>
+ 6 <packaging>jar</packaging>
+ 7 <version>1.0</version>
+ 8 <build>
+ 9 <plugins>
+ 10 <plugin>
+ 11 <groupId>org.apache.maven.plugins</groupId>
+ 12 <artifactId>maven-compiler-plugin</artifactId>
+ 13 <version>3.7.0</version>
+ 14 <configuration>
+ 15 <source>1.8</source>
+ 16 <target>1.8</target>
+ 17 </configuration>
+ 18 </plugin>
+ 19 <plugin>
+ 20 <groupId>org.codehaus.mojo</groupId>
+ 21 <artifactId>exec-maven-plugin</artifactId>
+ 22 <version>1.6.0</version>
+ 23 <executions>
+ 24 <execution>
+ 25 <goals>
+ 26 <goal>java</goal>
+ 27 </goals>
+ 28 </execution>
+ 29 </executions>
+ 30 <configuration>
+ 31 <mainClass>org.apache.clerezza.tutorial.Example03</mainClass>
+ 32 </configuration>
+ 33 </plugin>
+ 34 </plugins>
+ 35 </build>
+ 36 <name>Example-03</name>
+ 37 <url>http://maven.apache.org</url>
+ 38 <dependencies>
+ 39 <dependency>
+ 40 <groupId>org.apache.clerezza</groupId>
+ 41 <artifactId>rdf.core</artifactId>
+ 42 <version>1.0.1</version>
+ 43 </dependency>
+ 44 <dependency>
+ 45 <groupId>org.slf4j</groupId>
+ 46 <artifactId>slf4j-simple</artifactId>
+ 47 <version>1.7.25</version>
+ 48 </dependency>
+ 49 <dependency>
+ 50 <groupId>org.apache.clerezza</groupId>
+ 51 <artifactId>rdf.jena.parser</artifactId>
+ 52 <version>1.1.1</version>
+ 53 </dependency>
+ 54 <dependency>
+ 55 <groupId>org.apache.clerezza</groupId>
+ 56 <artifactId>rdf.jena.serializer</artifactId>
+ 57 <version>1.1.1</version>
+ 58 </dependency>
+ 59 </dependencies>
+ 60 </project>
+ </div>
+ <p>
+ The directory structure is simple as shown below:
+ </p>
+ <div xmlns="http://www.w3.org/1999/xhtml" class="tx-blockcode">
+ pom.xml
+ src/main/java/org/apache/clerezza/tutorial/Example03.java
+ src/main/resources/org/apache/clerezza/tutorial/example03.ttl
+ </div>
+ <p>
+ To build the jar, we should invoke:
+ </p>
+ <div xmlns="http://www.w3.org/1999/xhtml" class="tx-blockcode">
+ mvn package
+ </div>
+ <p>
+ Running the programme can be done by invoking
+ </p>
+ <div xmlns="http://www.w3.org/1999/xhtml" class="tx-blockcode">
+ mvn exec:java
+ </div>
+ <p>
+ The result of the programme execution is the file /tmp/example03.rdf, which contains the serialized graph as follows:
+ </p>
+ <div xmlns="http://www.w3.org/1999/xhtml" class="tx-blockcode">
+<rdf:RDF
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:j.0="http://clerezza.apache.org/2017/01/example#" >
+ <rdf:Description rdf:nodeID="A0">
+ <j.0:isA rdf:resource="http://clerezza.apache.org/2017/01/example#ClerezzaUser"/>
+ <j.0:hasFirstName rdf:datatype="http://www.w3.org/2001/XMLSchema#string">Hasan</j.0:hasFirstName>
+ </rdf:Description>
+</rdf:RDF>
+ </div>
+ <h2>Discussion</h2>
+ <p>
+ The maven POM file shows four libraries on which the programme directly depends:
+ </p>
+ <ul>
+ <li>
+ org.apache.clerezza.rdf.core: contains implementation of the Apache Clerezza Parser
+ </li>
+ <li>
+ org.apache.clerezza.rdf.jena.parser: contains ParsingProvider service based on Jena Parser
+ </li>
+ <li>
+ org.apache.clerezza.rdf.jena.serializer: contains SerializingProvider service based on Jena Serializer
+ </li>
+ <li>
+ org.slf4j.slf4j-simple: contains implementation of the logger
+ </li>
+ </ul>
+ <p>
+ The core of the programme lies at line 25 (parsing a stream of triples into a graph) and 34 (serializing a graph to a file).
+ </p>
+ <p>
+ Note: Any comments and suggestions for improvements are welcome. Please send your feedback to <a href="mailto:dev@clerezza.apache.org">dev@clerezza.apache.org</a>
+ </p>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="footer">
+ <div class="logos">
+ <img src="/images/feather.png"/>
+ <img src="/images/sw-vert-w3c.png"/>
+ <img src="/images/footer-logo.png"/>
+ </div>
+ <div class="divider"></div>
+ <div class="dark">
+ <div class="sitemap">
+ <div class="sitemap-title">Sitemap</div>
+ <div class="sitemap-content">
+ <div class="sitemap-column">
+ <div class="title">Documentation</div>
+ <ul>
+ <li>
+ <a href="/getting-started/">Getting Started</a>
+ </li>
+ <li>
+ <a href="/architecture/">The Apache Clerezza Stack</a>
+ </li>
+ <li>
+ <a href="http://clerezza,apache.org/apidocs/" target="_blank">API docs</a>
+ </li>
+ <li>
+ <a href="/faq/">FAQ</a>
+ </li>
+ </ul>
+ </div>
+ <div class="sitemap-column">
+ <div class="title">Project Infos</div>
+ <ul>
+ <li>
+ <a href="/downloads/">Downloads</a>
+ </li>
+ <li>
+ <a href="/contributing/">Contributing</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/licenses/" target="_blank">License</a>
+ </li>
+ <li>
+ <a href="mailinglists/">Mailing lists</a>
+ </li>
+ <li>
+ <a href="http://issues.apache.org/jira/browse/CLEREZZA" target="_blank">Issue Tracker</a>
+ </li>
+ <li>
+ <a href="https://git-wip-us.apache.org/repos/asf?p=clerezza.git" target="_blank">Source Repository</a>
+ </li>
+ </ul>
+ </div>
+ <div class="sitemap-column">
+ <div class="title">Sponsorship</div>
+ <ul>
+ <li>
+ <a href="/thanks/">Thanks</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">Become a Sponsor</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org/foundation/buy_stuff.html" target="_blank">Buy Stuff</a>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ <div class="copyright">Apache Clerezza, Clerezza, Apache, the Apache feather logo, and the Apache Clerezza project logo are trademarks of The Apache Software Foundation.
+ <br></br>© 2011 The Apache Software Foundation.
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
\ No newline at end of file