OBO-Edit: Creating a Data Adapter Plugin: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
It's actually quite simple to write an OBO-Edit data adapter plugin. There are really only five steps: | It's actually quite simple to write an OBO-Edit data adapter plugin. There are really only five steps: | ||
==Configure Your Development Environment== | ==Configure Your Development Environment== | ||
How you do this is highly dependent on how you want to develop code, and | 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... | ||
===Eclipse with | ===(quickest & easiest) Eclipse with No Access to the OBO-Edit Sources=== | ||
# *optional* If you haven't created an Eclipse project for your plugin, create it now | |||
# Download any OBO-Edit release | |||
# Install or unzip the release | |||
# Copy the libraries runtime/org.geneontology.jar and runtime/oboedit.jar from the OBO-Edit installation into your eclipse project | |||
# Put the libraries on your project build path: | |||
## Select your plugin project in the Package View or Navigation View | |||
## Select the "Project -> Properties" menu item | |||
## Choose "Build path" in the popup window | |||
## Select the "Libraries" tab | |||
## Click the "Add jars" button | |||
## Select the org.geneontology and oboedit.jar jar files that you just added to your plugin project | |||
## Select "OBO-Edit" and "org.geneontology" | |||
## Click "Ok" in all open windows | |||
===Eclipse with Access to the OBO-Edit Sources=== | |||
# 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]] | |||
# *optional* If you haven't created a project for your plugin, create one now. | |||
# Put the OBO-Edit and org.geneontology projects on your build path | |||
## Select your plugin project in the Package View or Navigation View | |||
## Select the "Project -> Properties" menu item | |||
## Choose "Build path" in the popup window | |||
## Select the "Projects" tab | |||
## Click the "Add" button | |||
## Select "OBO-Edit" and "org.geneontology" | |||
## Click "Ok" in all open windows | |||
===Command Line Building=== | |||
# Download any OBO-Edit release | |||
# Install or unzip the release | |||
# 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) | |||
# 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== |
Revision as of 16:30, 1 December 2006
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
- *optional* If you haven't created an Eclipse project for your plugin, create it now
- Download any OBO-Edit release
- Install or unzip the release
- Copy the libraries runtime/org.geneontology.jar and runtime/oboedit.jar from the OBO-Edit installation into your eclipse project
- Put the libraries on your project build path:
- Select your plugin project in the Package View or Navigation View
- Select the "Project -> Properties" menu item
- Choose "Build path" in the popup window
- Select the "Libraries" tab
- Click the "Add jars" button
- Select the org.geneontology and oboedit.jar jar files that you just added to your plugin project
- Select "OBO-Edit" and "org.geneontology"
- Click "Ok" in all open windows
Eclipse with Access to the OBO-Edit Sources
- 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
- *optional* If you haven't created a project for your plugin, create one now.
- Put the OBO-Edit and org.geneontology projects on your build path
- Select your plugin project in the Package View or Navigation View
- Select the "Project -> Properties" menu item
- Choose "Build path" in the popup window
- Select the "Projects" tab
- Click the "Add" button
- Select "OBO-Edit" and "org.geneontology"
- Click "Ok" in all open windows
Command Line Building
- Download any OBO-Edit release
- Install or unzip the release
- 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)
- 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