Documentation

gloucklegnou edited this page Apr 13, 2016 · 13 revisions

Javadoc

Javadoc for the API is available online and included in the distribution.

HOWTO

In order to use the API in your own applications, you should download the latest binary release and ensure that all of the jar files are in the application classpath.

Alternatively, use a Maven dependency (this example is for 4.2.3, most recent release for version 4)

<dependency>
    <groupId>net.sourceforge.owlapi</groupId>
    <artifactId>owlapi-distribution</artifactId>
    <version>4.2.3</version>
</dependency>

Java version: 6 or newer.

OWL API 3.5.x requires Java 6 or newer. It has been compiled and tested on Oracle JDK 8, and built with JDK 7 and 8. If you find it not working on any JRE 6 or newer, please let us know in the bug section.

OWL API 4 requires Java 7 or newer. It has been built with Java 7 and Java 8.

Build your own

If you want to check out the source code and build the binaries yourself, you can either use ANT (build file is in the antbuild folder) or Maven. Maven is the build system currently used for official builds, and it includes OSGI compatibility in the builds (experimental feature).

Programming with the OWL API

The central point of access is the OWLOntologyManager, which is used to load, create and access ontologies. The examples below show how to create an instance of this class and how to use it.

Code examples

  • The Rough Guide to the OWL API, a tutorial presented at OWLED 2011 (The PDF will be updated to version 4, but it is currently suitable for version 3.4 and 3.5.
  • Source code for version 3 for The Rough Guide to the OWL API (includes most of the code available in the subsequent examples).
  • Source code for version 4 for The Rough Guide to the OWL API (includes most of the code available in the subsequent examples).
  • DL Query Example for 3.x presents an example of how to query an ontology.
  • DL Query Example for 4 presents an example of how to query an ontology.
  • Examples for 3.x * Examples for 4 include:
  • How to load an ontology.
  • How to save an ontology.
  • How to obtain references to entities (classes, properties, individuals etc.).
  • How to work with data types and other data ranges.
  • How to work with user defined data ranges (e.g. int > 10).
  • How to work with string, data values and language tags.
  • How to create an empty ontology, add axioms and save.
  • How to specify that an individual is an instance of a class.
  • How to specify that two individuals are related to each other.
  • How to add an object property assertion (triple) to an ontology.
  • How to delete entities (classes, properties and individuals) from an ontology.
  • How to create restrictions and ''add them to classes'' as superclasses.
  • How to create an ontology and add some rules.
  • How to interact with a reasoner.
  • How to collect the properties that are used in restrictions on a given class.
  • How to work with annotations such as labels and comments.
  • How to save *inferred axioms into a new ontology, or back into an existing ontology.
  • How two (or more) ontologies can be merged in a simple way.
  • How to 'walk' over the asserted structure of an ontology.
  • How to use OWLOntologyIRIMapper to redirect loading and loading of imports.
  • How to extract a locality based module from an ontology.

More Code Examples

Simple Hierarchy

This example for version 3.x and example for version 4 show how we can calculate and display a basic ontology hierarchy. The example makes use of an OWLReasoner to calculate the class hierarchy, then navigates the structure obtained, printing out basic information for each of the classes. The example uses a StructuralReasoner, which returns information about the hierarchy based solely on the assertions that are made in the ontology.

Rendering example

This example for 3.x and example for 4 show the definition of a simple renderer. The renderer provided an HTML page describing the entities in the ontology.

Closure Axioms

This example for 3.x and example for 4 illustrates manipulation of axioms in an ontology.

Debugging

This example for 3.x and example for 4 illustrate the use of the debugger. The debugger identifies axioms causing inconsistencies in OWL ontologies.