| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| |
| <title>Apache Jena - Schemagen Maven</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <link href="/css/bootstrap.min.css" rel="stylesheet" media="screen"> |
| <link href="/css/bootstrap-extension.css" rel="stylesheet" type="text/css"> |
| <link href="/css/jena.css" rel="stylesheet" type="text/css"> |
| <link rel="shortcut icon" href="/images/favicon.ico" /> |
| |
| <script src="https://code.jquery.com/jquery-2.2.4.min.js" |
| integrity="sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=" |
| crossorigin="anonymous"></script> |
| <script src="/js/jena-navigation.js" type="text/javascript"></script> |
| <script src="/js/bootstrap.min.js" type="text/javascript"></script> |
| |
| <script src="/js/improve.js" type="text/javascript"></script> |
| |
| |
| </head> |
| |
| <body> |
| |
| <nav class="navbar navbar-default" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse"> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="/index.html"> |
| <img class="logo-menu" src="/images/jena-logo/jena-logo-notext-small.png" alt="jena logo">Apache Jena</a> |
| </div> |
| |
| <div class="collapse navbar-collapse navbar-ex1-collapse"> |
| <ul class="nav navbar-nav"> |
| <li id="homepage"><a href="/index.html"><span class="glyphicon glyphicon-home"></span> Home</a></li> |
| <li id="download"><a href="/download/index.cgi"><span class="glyphicon glyphicon-download-alt"></span> Download</a></li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-book"></span> Learn <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li class="dropdown-header">Tutorials</li> |
| <li><a href="/tutorials/index.html">Overview</a></li> |
| <li><a href="/documentation/fuseki2/index.html">Fuseki Triplestore</a></li> |
| <li><a href="/documentation/notes/index.html">How-To's</a></li> |
| <li><a href="/documentation/query/manipulating_sparql_using_arq.html">Manipulating SPARQL using ARQ</a></li> |
| <li><a href="/tutorials/rdf_api.html">RDF core API tutorial</a></li> |
| <li><a href="/tutorials/sparql.html">SPARQL tutorial</a></li> |
| <li><a href="/tutorials/using_jena_with_eclipse.html">Using Jena with Eclipse</a></li> |
| <li class="divider"></li> |
| <li class="dropdown-header">References</li> |
| <li><a href="/documentation/index.html">Overview</a></li> |
| <li><a href="/documentation/query/index.html">ARQ (SPARQL)</a></li> |
| <li><a href="/documentation/assembler/index.html">Assembler</a></li> |
| <li><a href="/documentation/tools/index.html">Command-line tools</a></li> |
| <li><a href="/documentation/rdfs/">Data with RDFS Inferencing</a></li> |
| <li><a href="/documentation/geosparql/index.html">GeoSPARQL</a></li> |
| <li><a href="/documentation/inference/index.html">Inference API</a></li> |
| <li><a href="/documentation/javadoc.html">Javadoc</a></li> |
| <li><a href="/documentation/ontology/">Ontology API</a></li> |
| <li><a href="/documentation/permissions/index.html">Permissions</a></li> |
| <li><a href="/documentation/extras/querybuilder/index.html">Query Builder</a></li> |
| <li><a href="/documentation/rdf/index.html">RDF API</a></li> |
| <li><a href="/documentation/rdfconnection/">RDF Connection - SPARQL API</a></li> |
| <li><a href="/documentation/io/">RDF I/O</a></li> |
| <li><a href="/documentation/rdfstar/index.html">RDF-star</a></li> |
| <li><a href="/documentation/shacl/index.html">SHACL</a></li> |
| <li><a href="/documentation/shex/index.html">ShEx</a></li> |
| <li><a href="/documentation/jdbc/index.html">SPARQL over JDBC</a></li> |
| <li><a href="/documentation/tdb/index.html">TDB</a></li> |
| <li><a href="/documentation/tdb2/index.html">TDB2</a></li> |
| <li><a href="/documentation/query/text-query.html">Text Search</a></li> |
| </ul> |
| </li> |
| |
| <li class="drop down"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-book"></span> Javadoc <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/documentation/javadoc.html">All Javadoc</a></li> |
| <li><a href="/documentation/javadoc/arq/">ARQ</a></li> |
| <li><a href="/documentation/javadoc_elephas.html">Elephas</a></li> |
| <li><a href="/documentation/javadoc/fuseki2/">Fuseki</a></li> |
| <li><a href="/documentation/javadoc/geosparql/">GeoSPARQL</a></li> |
| <li><a href="/documentation/javadoc/jdbc/">JDBC</a></li> |
| <li><a href="/documentation/javadoc/jena/">Jena Core</a></li> |
| <li><a href="/documentation/javadoc/permissions/">Permissions</a></li> |
| <li><a href="/documentation/javadoc/extras/querybuilder/">Query Builder</a></li> |
| <li><a href="/documentation/javadoc/shacl/">SHACL</a></li> |
| <li><a href="/documentation/javadoc/tdb/">TDB</a></li> |
| <li><a href="/documentation/javadoc/text/">Text Search</a></li> |
| </ul> |
| </li> |
| |
| <li id="ask"><a href="/help_and_support/index.html"><span class="glyphicon glyphicon-question-sign"></span> Ask</a></li> |
| |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown"><span class="glyphicon glyphicon-bullhorn"></span> Get involved <b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/getting_involved/index.html">Contribute</a></li> |
| <li><a href="/help_and_support/bugs_and_suggestions.html">Report a bug</a></li> |
| <li class="divider"></li> |
| <li class="dropdown-header">Project</li> |
| <li><a href="/about_jena/about.html">About Jena</a></li> |
| <li><a href="/about_jena/architecture.html">Architecture</a></li> |
| <li><a href="/about_jena/citing.html">Citing</a></li> |
| <li><a href="/about_jena/team.html">Project team</a></li> |
| <li><a href="/about_jena/contributions.html">Related projects</a></li> |
| <li><a href="/about_jena/roadmap.html">Roadmap</a></li> |
| <li class="divider"></li> |
| <li class="dropdown-header">ASF</li> |
| <li><a href="http://www.apache.org/">Apache Software Foundation</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li> |
| <li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li> |
| <li><a href="http://www.apache.org/security/">Security</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| </ul> |
| </li> |
| |
| |
| |
| |
| <li id="edit"><a href="https://github.com/apache/jena-site/edit/main/source/documentation/tools/schemagen-maven.md" title="Edit this page on GitHub"><span class="glyphicon glyphicon-pencil"></span> Edit this page</a></li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-12"> |
| <div id="breadcrumbs"> |
| |
|
|
|
|
|
|
|
|
|
|
|
|
| <ol class="breadcrumb">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li><a href='/documentation'>DOCUMENTATION</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li><a href='/documentation/tools'>TOOLS</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <li class="active">SCHEMAGEN MAVEN</li>
|
|
|
|
|
|
|
|
|
| </ol>
|
|
|
|
|
|
|
| |
| |
| </div> |
| <h1 class="title">Schemagen Maven</h1> |
| |
| <h1 id="schemagen-maven-generating-java-source-files-from-owl-and-rdfs-ontologies-via-maven">Schemagen-maven: generating Java source files from OWL and RDFS ontologies via Maven</h1> |
| <p>The <a href="/">Apache Jena</a> command line tool |
| <a href="/documentation/tools/schemagen.html"><code>schemagen</code></a> |
| provides an automated way of creating |
| Java source code constants from ontology files in an RDF-based project. This |
| can be very convenient, as it provides both a level of robustness that the |
| names of RDF classes, properties and individuals are being used correctly, and |
| it can be used by IDE’s such as Eclipse to provide name-completion for |
| constants from the ontology.</p> |
| <p>For some projects, invoking <code>schemagen</code> from the command line, perhaps via <code>ant</code>, |
| is sufficient. For projects organised around Apache Maven, it would be convenient to integrate |
| the schemagen translation step into Maven’s normal build process. This plugin |
| provides a means to do just that.</p> |
| <h2 id="pre-requisites">Pre-requisites</h2> |
| <p>This plugin adds a step to the Maven build process to automatically translate RDFS |
| and OWL files, encoded as RDF/XML, Turtle or N-triples into Java source files. |
| This plugin is designed to be used with a Java project that is already using Apache Maven to |
| control the build. Non-Java projects do not need this tool. Projects that are |
| not using Maven should see the <a href="schemagen.html">schemagen documentation</a> |
| for ways to run <code>schemagen</code> from the command line.</p> |
| <h2 id="installing">Installing</h2> |
| <p>Schemagen is available from the maven central repository. To use it, add |
| the following dependency to your <code>pom.xml</code>:</p> |
| <pre><code><build> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.jena</groupId> |
| <artifactId>jena-maven-tools</artifactId> |
| <version>x.y.z</version> |
| <executions> |
| <execution> |
| <id>schemagen</id> |
| <goals> |
| <goal>translate</goal> |
| </goals> |
| </execution> |
| </executions> |
| </plugin> |
| </plugins> |
| </build> |
| <dependencies> |
| <dependency> |
| <groupId>org.apache.jena</groupId> |
| <artifactId>jena-core</artifactId> |
| <version>x.y.z</version> |
| </dependency> |
| </dependencies> |
| </code></pre> |
| <p>Replace the <code>x.y.z</code> above with the latest versions as found by |
| browsing <a href="http://central.maven.org/maven2/org/apache/jena/jena-maven-tools/">jena-maven-tools</a> |
| and <a href="http://central.maven.org/maven2/org/apache/jena/jena-core/">jena-core</a> in Maven Central.</p> |
| <h2 id="configuration-basic-principles">Configuration: basic principles</h2> |
| <p>Schemagen supports a large number of options, controlling such things as the name of the |
| input file, the RDF namespace to expect, which Java package to place the output in and |
| so forth. For a command line or Ant-based build, these options are normally passed on |
| a per-file basis. When using maven, however, we point the plugin at a whole collection of input |
| files to be converted to Java, and let the plugin figure out which ones need updating (e.g. because |
| the RDF source is newer than the Java output, or because the Java file has not yet |
| been generated). So we need:</p> |
| <ul> |
| <li>a mechanism to specify which files to process</li> |
| <li>a mechanism to specify common options for all input files</li> |
| <li>a mechanism to specify per-file unique options</li> |
| </ul> |
| <p>In Maven, all such configuration information is provided via the <code>pom.xml</code> file. We tell |
| Maven to use the plugin via the <code><build> <plugins></code> section:</p> |
| <pre><code><build> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.jena</groupId> |
| <artifactId>jena-maven-tools</artifactId> |
| <version>x.y.z</version> |
| <configuration> |
| </configuration> |
| <executions> |
| <execution> |
| <id>schemagen</id> |
| <goals> |
| <goal>translate</goal> |
| </goals> |
| </execution> |
| </executions> |
| </plugin> |
| </plugins> |
| </build> |
| </code></pre> |
| <p>Replace the <code>x.y.z</code> above with the latest versions as found by |
| browsing <a href="http://central.maven.org/maven2/org/apache/jena/jena-maven-tools/">jena-maven-tools</a> |
| in Maven Central.</p> |
| <p>The configuration options all nest inside the <code><configuration></code> section.</p> |
| <h3 id="specifying-files-to-process">Specifying files to process</h3> |
| <p>An <code><include></code> directive specifies one file pattern to include in the set of |
| files to process. Wildcards may be used. For example, the following section |
| specifies that the tool will process all Turtle files, and the <code>foaf.rdf</code> file, |
| in <code>src/main/vocabs</code>:</p> |
| <pre><code><includes> |
| <include>src/main/vocabs/*.ttl</include> |
| <include>src/main/vocabs/foaf.rdf</include> |
| </includes> |
| </code></pre> |
| <h3 id="specifying-processing-options">Specifying processing options</h3> |
| <p>Options are, in general, given in the <code><fileOptions></code> section. A given |
| <code><source></code> refers to one input source - one file - as named by the |
| <code><input></code> name. The actual option names are taken from the RDF <a href="/documentation/tools/schemagen.html">config |
| file property names</a>, |
| omitting the namespace:</p> |
| <pre><code> <fileOptions> |
| <source> |
| <!-- Test2.java (only) will contain OntModel declarations --> |
| <input>src/main/vocabs/demo2.ttl</input> |
| <ontology>true</ontology> |
| </source> |
| </fileOptions> |
| </code></pre> |
| <p>The special source <code>default</code> provides a mechanism for specifying shared defaults |
| across all input sources:</p> |
| <pre><code> <source> |
| <input>default</input> |
| <package-name>org.example.test</package-name> |
| </source> |
| </code></pre> |
| <h2 id="example-configuration">Example configuration</h2> |
| <p><strong>Note:</strong> Replace the <code>x.y.z</code> below with the latest versions as found by |
| browsing <a href="http://central.maven.org/maven2/org/apache/jena/jena-maven-tools/">jena-maven-tools</a> |
| and <a href="http://central.maven.org/maven2/org/apache/jena/jena-core/">jena-core</a> in Maven Central.</p> |
| <pre><code><build> |
| <plugins> |
| <plugin> |
| <groupId>org.apache.jena</groupId> |
| <artifactId>jena-maven-tools</artifactId> |
| <version>x.y.z</version> |
| <configuration> |
| <includes> |
| <include>src/main/vocabs/*.ttl</include> |
| <include>src/main/vocabs/foaf.rdf</include> |
| </includes> |
| <fileOptions> |
| <source> |
| <input>default</input> |
| <package-name>org.example.test</package-name> |
| </source> |
| <source> |
| <!-- Test2.java (only) will contain OntModel declarations --> |
| <input>src/main/vocabs/demo2.ttl</input> |
| <ontology>true</ontology> |
| <!-- caution: the config file property name 'inference' is mapped to 'use-inf' --> |
| <use-inf>true</use-inf> |
| </source> |
| </fileOptions> |
| </configuration> |
| <executions> |
| <execution> |
| <id>schemagen</id> |
| <goals> |
| <goal>translate</goal> |
| </goals> |
| </execution> |
| </executions> |
| </plugin> |
| </plugins> |
| </build> |
| <dependencies> |
| <dependency> |
| <groupId>org.apache.jena</groupId> |
| <artifactId>jena-core</artifactId> |
| <version>x.y.z</version> |
| </dependency> |
| </dependencies> |
| </code></pre> |
| |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| <footer class="footer"> |
| <div class="container" style="font-size:80%" > |
| <p> |
| Copyright © 2011–2022 The Apache Software Foundation, Licensed under the |
| <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>. |
| </p> |
| <p> |
| Apache Jena, Jena, the Apache Jena project logo, Apache and the Apache feather logos are trademarks of |
| The Apache Software Foundation. |
| <br/> |
| <a href="https://privacy.apache.org/policies/privacy-policy-public.html" |
| >Apache Software Foundation Privacy Policy</a>. |
| </p> |
| </div> |
| </footer> |
| |
| |
| <script type="text/javascript"> |
| var link = $('a[href="' + this.location.pathname + '"]'); |
| if (link != undefined) |
| link.parents('li,ul').addClass('active'); |
| </script> |
| |
| </body> |
| </html> |
