Tutorial: Ontology Development

From Developer Documents
Revision as of 14:07, 25 October 2010 by Toni Kalajainen (talk | contribs)
Jump to navigation Jump to search

"What's up folks." This tutorial series is composed of four parts. As it is a trail, you should study them in order. Today we are going to create a movie database ontology for a client of your Acme company. Even though Simantics is intended for simulator integration platform, we decided to use movies as the theme. This basic level tutorial doesn't go into simulation specifics, and the subject is more familiar for any developer to relate to than a simulation specific one.

Step 1: Setup Ontology Plug-in

Ontologies are encapsulated in OSGi bundles. In eclipse we develop them as equinox plug-ins. An ontology bundle is a specialized package. It has the following content, graph source files (graph/*.pgraph), a compiled graph file (graph.tg), and Java files (src/ and bin/).

Open a New Plug-in Project wizard:

  • Open Plug-in Development Perspective
  • Select File >> New >> Other
  • Select Plug-in Development >> Plug-in Project

A New Plug-in Project wizard will open.

  • Our organization is Acme Software ltd and from there is our plug-in name derived, com.acme.movie.ontology. Insert that as project name. Next >
  • In the following page you should know that this plugin does not contribute to UI, does not need an activator and is not a rich client application. Next >
  • Use template Plug-in with a Simantics Ontology. Next >
  • Your company domain is com.acme.movie and ontology name Movie, and the inital version is 1.0. Finish

You have now a new project in Package Explorer. In it you will find META-INF/MANIFEST.MF, graph/Movie.pgraph, and graph.tg.

Step 2: Initialize Ontology

Open Movie.pgraph and start editing.

As you are using Layer0 concepts, it is a good idea to capture its namespace: 

 L0 = <http://www.simantics.org/Layer0-1.0>

Your acme company has a namespace. You are creating a new one so it must be stated. 

 <http://com.acme> : L0.Library
     @L0.new

The ontology has a representing resource, an instance of L0.Ontology. Don't forget to tell the compiler to create Resource file aswell. 

 mo = <http://com.acme/Movie-1.0> : L0.Ontology
     L0.HasResourceClass "com.acme.ontology.Movie"

Step 3: Export package

Now that you have some content, graph compiler has created a Resource class com.acme.ontology.Movie under src/ folder. When developing database code you can gain access to your ontology concepts using this class. In OSGi plugin environment, the access to other plugins' classes is denied by default. To share, you must export its Java package.

  • Open META-INF/MANIFEST.MF
  • Add Exported Packages >> com.acme.ontology

Your MANIFEST.MF should look like this. 

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Ontology
Bundle-SymbolicName: com.acme.movie.ontology
Bundle-Version: 1.0.0.qualifier
Bundle-Vendor: Acme Software ltd
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Require-Bundle: org.simantics.layer0;bundle-version="1.0.0"
Export-Package: com.acme.ontology

Step 4: Write your Movie Ontology

In movie database we are going to store objects such as movies, actors, directors and producers. There is going to be a few properties about them, and a couple of relations. At this point it is a good idea to take a look at the graph file format documentation. Good, open Movie.pgraph again.

  • Specify Types

First we need to specify object types for the concepts Movie, Character, Cast and Person. Actors, directors and producers are modelled as Persons. A person becomes a representative of a classification, say actor, once he/she has acted in a motion picture (modeled as interrelation statement). Cast is a anonymous resource that links between Person (actor) and Character. 

// Types
mo.Movie <T L0.Entity
mo.Character <T L0.Entity
mo.Person <T L0.Entity
mo.Cast <T L0.Entity
  • Specify Properties
// Properties
mo.HasDobYear <R L0.HasProperty
    L0.HasRange L0.Integer  
mo.HasAge <R L0.HasProperty
    L0.HasRange L0.Integer  
mo.HasGender <R L0.HasProperty
    L0.HasRange mo.Gender
mo.HasTitle <R L0.HasProperty // The english title
    L0.HasRange L0.String
  • Specify Literals

Numberic primitives are defined in Layer0, eg. L0.Integer. Gender is a special case, since it is not defined in Layer0 you must do it yourself. The syntax is defined in Datatype documentation. In it you will find out the format for your enumeration is |Male|Female. 

// Literals
mo.Gender <T L0.Literal
    @L0.assert L0.HasDataType $(|Male|Female)
  • Add the properties to your types

Add properties with @L0.singleProperty or @L0.optionalProperty. They are actually restrictions. The former means that an instance of Role is a valid instance only it has a single HasAge relation to an integer literal. 

// Add properties
mo.Character
    @L0.singleProperty mo.HasAge
    @L0.singleProperty mo.HasGender
mo.Person
    @L0.singleProperty mo.HasDobYear
    @L0.singleProperty mo.HasGender


  • Specify Relations
// Relations
mo.IsDirectedBy <R L0.IsRelatedTo
    L0.HasDomain mo.Movie
    L0.HasRange mo.Person
mo.IsDirectorOf <R L0.IsRelatedTo
    L0.HasDomain mo.Person
    L0.HasRange mo.Movie
    L0.InverseOf mo.IsDirectedBy

mo.IsProducedBy <R L0.IsRelatedTo
    L0.HasDomain mo.Movie
    L0.HasRange mo.Person
mo.IsProducerOf <R L0.IsRelatedTo
    L0.HasDomain mo.Movie
    L0.HasRange mo.Person
    L0.InverseOf mo.IsProducedBy

mo.HasCast <R L0.IsRelatedTo
    L0.HasDomain mo.Movie
    L0.HasRange mo.Cast

mo.IsPlayedBy <R L0.IsRelatedTo
    L0.HasDomain mo.Cast
    L0.HasRange mo.Person
mo.IsCastedTo <R L0.IsRelatedTo
    L0.HasDomain mo.Person
    L0.HasRange mo.Cast
    L0.InverseOf mo.IsPlayedBy

mo.OfRole <R L0.IsRelatedTo
    L0.HasDomain mo.Cast
    L0.HasRange mo.Character
mo.HasCasting <R L0.IsRelatedTo
    L0.InverseOf mo.OfRole
    L0.HasDomain mo.Character
    L0.HasRange mo.Cast
  • Create a template

Casting is a binding between a movie, a character and an actor. To state a casting in a database three statements and one instance is required. To make the code more readable, define a template. 

mo.Casting : L0.Template 
    @template %movie %character %actor
        %movie
            mo.HasCast _ : mo.Cast 
                mo.IsPlayedBy %actor
                mo.OfRole %character

Save file. Your Movie.java resource file should now contain a list of resources and URIs. Go on and take a look.

Step 5: Setup Build Properties

build.properties determines which files are included with the binary and the source release. A new ontology plug-in needs some fixing, you must add graph.tg to the binary build and graph-folder to source build. You can make the modification with the form editor.

  • Open build.properties and go to build-page.
  • Check graph.tg under Binary Build.
  • Check graph-folder under Source Build.

If you open the build.properties page, it should look like this. 

source.. = src/
output.. = bin/
bin.includes = META-INF/,\
               .,\
               graph.tg
src.includes = graph/

Step 6: Download MovieLibrary

We made a Movie Library for initial data. Download: File:MovieLibrary.pgraph and put in graph folder.

If you take a look inside you'll find a root resource at http://com.acme/MovieLibrary. All movies, actors and other persons are linked to/from the library with L0.PartOf/L0.ConsistsOf relations. 

db = <http://com.acme/MovieLibrary> : L0.Library
    @L0.new

You'll also find an example of the template in use: 

db.tt0381061 : mo.Movie
    @mo.Casting      db."James Bond"        db."Daniel Craig" 
    @mo.Casting      db."M"                 db."Judi Dench"


Handshake.png Congratulations You have now set-up an ontology.

Give your brains a break before proceeding to the next tutorial.
Next.png Tutorial 2: Project Development

Retrieved from "https://dev.simantics.org/index.php?title=Tutorial:_Ontology_Development&oldid=1160"