OBO-Edit: Creating a Data Adapter Plugin

From GO Wiki
Revision as of 16:30, 1 December 2006 by Jrichter (talk | contribs)
Jump to navigation Jump to search

It's actually quite simple to write an OBO-Edit data adapter plugin. There are really only five steps:

Configure Your Development Environment

How you do this is highly dependent on how you want to develop code, and whether you want access to the OBO-Edit source code while developing. Here are a few common options...

(quickest & easiest) Eclipse with No Access to the OBO-Edit Sources

  1. *optional* If you haven't created an Eclipse project for your plugin, create it now
  2. Download any OBO-Edit release
  3. Install or unzip the release
  4. Copy the libraries runtime/org.geneontology.jar and runtime/oboedit.jar from the OBO-Edit installation into your eclipse project
  5. Put the libraries on your project build path:
    1. Select your plugin project in the Package View or Navigation View
    2. Select the "Project -> Properties" menu item
    3. Choose "Build path" in the popup window
    4. Select the "Libraries" tab
    5. Click the "Add jars" button
    6. Select the org.geneontology and oboedit.jar jar files that you just added to your plugin project
    7. Select "OBO-Edit" and "org.geneontology"
    8. Click "Ok" in all open windows

Eclipse with Access to the OBO-Edit Sources

  1. Use Eclipse to check out *both* the OBO-Edit source code *and* the org.geneontology toolkit from CVS using the instructions described in OBO-Edit: Getting the Source Code#Getting the Source Code with Eclipse
  2. *optional* If you haven't created a project for your plugin, create one now.
  3. Put the OBO-Edit and org.geneontology projects on your build path
    1. Select your plugin project in the Package View or Navigation View
    2. Select the "Project -> Properties" menu item
    3. Choose "Build path" in the popup window
    4. Select the "Projects" tab
    5. Click the "Add" button
    6. Select "OBO-Edit" and "org.geneontology"
    7. Click "Ok" in all open windows

Command Line Building

  1. Download any OBO-Edit release
  2. Install or unzip the release
  3. Copy the libraries runtime/org.geneontology.jar and runtime/oboedit.jar to your main project directory (or wherever you like to keep jar libraries when building a project)
  4. When compiling, include the org.geneontology.jar and oboedit.jar in your classpath

Write Your Code

A Data Adapter is created by implementing the org.geneontology.oboedit.dataadapter.OBOEditAdapter

Create a Manifest

Package Your Code

Install the Plugin

Retrieved from "https://wiki.geneontology.org/index.php?title=OBO-Edit:_Creating_a_Data_Adapter_Plugin&oldid=1715"