Difference between revisions of "OntologyBeanGenerator"

From Protege Wiki
Jump to: navigation, search
m (added plugin author)
(→‎Download: Updated links to source code)
 
(2 intermediate revisions by the same user not shown)
Line 16: Line 16:
 
* Download the '''binary distribution''' of the version of the plug-in that is compatible with the version of Protégé that you are using, by consulting the [[#Versions_.26_Compatibility|Versions & Compatibility]] table above, and following the "Download" link in the info box of the plug-in version wiki page.
 
* Download the '''binary distribution''' of the version of the plug-in that is compatible with the version of Protégé that you are using, by consulting the [[#Versions_.26_Compatibility|Versions & Compatibility]] table above, and following the "Download" link in the info box of the plug-in version wiki page.
  
−
* The '''JADE Abstract ontologies''' are included in the binary distribution in the ''projects'' subfolder. They can also be downloaded from here: abstractJadeOnt.zip
+
* The '''JADE Abstract ontologies''' are included in the binary distribution in the ''projects'' subfolder. They can also be downloaded from here: [http://protegewiki.stanford.edu/images/8/83/AbstractJadeOntology.zip abstractJadeOntology.zip]
  
−
* The '''bean generator example ontologies''' are included in the binary distribution in the ''examples'' subfolder. They can also be downloaded from here: beangenerator_examples.zip
+
* The '''bean generator example ontologies''' are included in the binary distribution in the ''examples'' subfolder. They can also be downloaded from here: [http://protegewiki.stanford.edu/images/5/55/Beangenerator_examples.zip beangenerator_examples.zip]
  
−
* '''Source code''' is available at: http://jade.tilab.com/community-source.htm
+
* '''Source code''' of the latest version is available at: https://bmir-gforge.stanford.edu/gf/project/biostorm/scmsvn/?action=browse&path=%2FOntologyBeanGenerator%2F
 +
&nbsp;&nbsp;&nbsp;&nbsp;Anonymous SVN access to it: <code>svn checkout https://bmir-gforge.stanford.edu/svn/biostorm/OntologyBeanGenerator</code>
 +
 
 +
&nbsp;&nbsp;&nbsp;&nbsp;The original version is linked from  the JADE website at: http://jade.tilab.com/download/add-ons/
  
 
== Installation ==
 
== Installation ==
Line 36: Line 39:
  
 
* Fill the ontology:
 
* Fill the ontology:
−
** Create concepts by making subclasses of the class Concept , e.g. CD, Items.
+
** Create concepts by making subclasses of the class <code>Concept</code> , e.g. <code>CD</code>, <code>Items</code>.
−
** Create agentactions by making subclasses of the class AgentAction , e.g. Sell, Buy.
+
** Create agentactions by making subclasses of the class <code>AgentAction</code> , e.g. <code>Sell</code>, <code>Buy</code>.
−
** Create agents by making subclasses of the class AID , e.g. Seller, Buyer.
+
** Create agents by making subclasses of the class <code>AID</code> , e.g. <code>Seller</code>, <code>Buyer</code>.
−
** Create predicates by making subclasses of the class Predicate , e.g. Owns, Contains.
+
** Create predicates by making subclasses of the class <code>Predicate</code> , e.g. <code>Owns</code>, <code>Contains</code>.
  
 
* Go to menu of Protégé: Project -> Configure... and select the OntologyBeanGeneratorTab checkbox
 
* Go to menu of Protégé: Project -> Configure... and select the OntologyBeanGeneratorTab checkbox
  
 
* Export the Java files
 
* Export the Java files
−
** Select the OntologyBeanGenerator tab   (6Y6)
+
** Select the OntologyBeanGenerator tab
 
** Specify (or select from the combobox) a package name, e.g. ''mypackage.onto''
 
** Specify (or select from the combobox) a package name, e.g. ''mypackage.onto''
 
** Specify (or select from the combobox or from the [...] button) a location where the java files are to be created (make sure the directory exists) e.g. ''.../projects/mypackage/src/mypackage/onto''
 
** Specify (or select from the combobox or from the [...] button) a location where the java files are to be created (make sure the directory exists) e.g. ''.../projects/mypackage/src/mypackage/onto''
 
** Specify (or select from the combobox) a ontology name: e.g. Newspaper
 
** Specify (or select from the combobox) a ontology name: e.g. Newspaper
−
** Press the generate button (old generated files will be overwritten)
+
** Press the generate button (note: old generated files will be overwritten)
  
 
* Use the exported Java files
 
* Use the exported Java files
Line 65: Line 68:
 
== Screenshot from MusicShopOntology example ==
 
== Screenshot from MusicShopOntology example ==
  
−
http://protege.cim3.net/file/pub/images/beanGenerator/beangenerator_screenshot.jpg    (6Z2)
+
[[Image:OntologyBeanGenerator_screenshot_Musicshop.png|500px]]
 +
 
 
== Related links ==
 
== Related links ==
  

Latest revision as of 12:15, October 17, 2016

OntologyBeanGenerator

by Chris van Aart

Type Tab Widget
Author(s) Chris van Aart
Last Update December 19, 2007
License not available
Homepage not available
For Application
Topic(s)
Affiliation not available

The ontology bean generator plugin is a Protégé Tab widget which generates java files representing an ontology that can be used with the JADE environment. With the beangenerator tool you can generate FIPA/JADE compliant ontologies from RDF(S), XML and Protégé projects. This plugin works with both Protégé frames and Protégé OWL ontologies.

Versions & Compatibility

This section lists available versions of OntologyBeanGenerator.

VersionCompatible withDependencies
OntologyBeanGenerator 4.1Protege-Frames 3.4
Protege-OWL 3.4		SimpleJADEAbstractOntology.pprj (for Protege-Frames ontologies)
OWLSimpleJADEAbstractOntology.pprj (for Protege-OWL ontologies)
OntologyBeanGenerator 4.0Protege-Frames 3.3.1
Protege-OWL 3.3.1		SimpleJADEAbstractOntology.pprj (for Protege-Frames ontologies)
OWLSimpleJADEAbstractOntology.pprj (for Protege-OWL ontologies)
OntologyBeanGenerator 3.1Protege-Frames 3.2.1
Protege-OWL 3.2.1
JADE 3.4.1		SimpleJADEAbstractOntology.pprj (for Protege-Frames ontologies)
OWLSimpleJADEAbstractOntology.pprj (for Protege-OWL ontologies)

If you click on the button below to add a new version of OntologyBeanGenerator, you will be asked to define a page title for the new version. Please adhere to the naming convention of OntologyBeanGenerator X.X.X when you define the new page!

Changelog

VersionChanges in this version
OntologyBeanGenerator 4.1Adapted to work with the non-backwards-compatible changes that happened between Protege version 3.3 and 3.4.
OntologyBeanGenerator 4.0see page for more details
OntologyBeanGenerator 3.1Updated to work with Protege-OWL, Compiled with Protege 3.2.1


Download

  • Download the binary distribution of the version of the plug-in that is compatible with the version of Protégé that you are using, by consulting the Versions & Compatibility table above, and following the "Download" link in the info box of the plug-in version wiki page.
  • The JADE Abstract ontologies are included in the binary distribution in the projects subfolder. They can also be downloaded from here: abstractJadeOntology.zip
  • The bean generator example ontologies are included in the binary distribution in the examples subfolder. They can also be downloaded from here: beangenerator_examples.zip

    Anonymous SVN access to it: svn checkout https://bmir-gforge.stanford.edu/svn/biostorm/OntologyBeanGenerator

    The original version is linked from the JADE website at: http://jade.tilab.com/download/add-ons/

Installation

Download the zip file as described above and unzip it in the Protege plugins directory (PROTEGE_INSTALL_DIR/plugins).

How to use the plugin

Open a new or existing Protégé project

  • Include/import JADE Abstract Ontology.
    • For Frames ontologies, include the SimpleJADEAbstractOntology.pprj into your project.
    • For OWL ontologies, import the OWLSimpleJADEAbstractOntology.owl into your project.
    • Note: The JADE ontologies are located in the plugin directory (PROTEGE_INSTALL_DIR/plugins/nl.uva.psy.swi.beangenerator/projects).
  • Fill the ontology:
    • Create concepts by making subclasses of the class Concept , e.g. CD, Items.
    • Create agentactions by making subclasses of the class AgentAction , e.g. Sell, Buy.
    • Create agents by making subclasses of the class AID , e.g. Seller, Buyer.
    • Create predicates by making subclasses of the class Predicate , e.g. Owns, Contains.
  • Go to menu of Protégé: Project -> Configure... and select the OntologyBeanGeneratorTab checkbox
  • Export the Java files
    • Select the OntologyBeanGenerator tab
    • Specify (or select from the combobox) a package name, e.g. mypackage.onto
    • Specify (or select from the combobox or from the [...] button) a location where the java files are to be created (make sure the directory exists) e.g. .../projects/mypackage/src/mypackage/onto
    • Specify (or select from the combobox) a ontology name: e.g. Newspaper
    • Press the generate button (note: old generated files will be overwritten)
  • Use the exported Java files
    • Import the the ontology files into your agent project
    • Register the ontology in the agent
    • You (and the agents) are ready to go!

Limitations

  • The plugin has be initially developed for Frames ontologies and later adapted for OWL.

There are features that have not been tested with OWL ontologies. In case you find bugs, please report them on Protégé discussion lists. We will fix them as time permits.

  • For OWL ontologies, datatype properties should be declared as functional. (72E)

Screenshot from MusicShopOntology example

OntologyBeanGenerator screenshot Musicshop.png

Related links

  • [JADE]
  • Jade tutorial with examples on how to use the bean generator plugin: [[1]]
  • Old plugin wiki page: [[2]]

Author

This plugin was developed by Chris van Aart, and it was modified by Csongor Nyulas starting with version 4.0.

Level of support

This plug-in is no longer under active development. If you need assistance, you can try posting a message to the protege-discussion mailing list (protege-discussion at lists dot stanford dot edu) and someone from the Protégé community may be able to help you.
Retrieved from "https://protegewiki.stanford.edu/index.php?title=OntologyBeanGenerator&oldid=13535"