Create IGB Plugin from Template

Step 1. Download and unzip: Download the attached template file SamplePlugin.zip.

Step 2. Add the template folder: Add the folder to the IGB source plugins folder, as seen in the following image.

Step 3. Change the plugin name: Change the name from SamplePlug to your name (e.g. MyPlugin)

Step 4. Change the package: Change the package from com.affymetrix.igb.sampleplugin to your package name (e.g. com.myorg.myplugin). If you IDE does not support 'create folder' directly you can do this from your Finder (MacOS) or Windows Explorer, the directory is IGB_HOME/plugins/MyPlug/src

Step 5. Update Activator.java: Expand the sample plugin /src until you see Activator.java (and SamplePlugin.java).

Open Activator.java and update the code with your package declaration as well as class name. The sample code implements an annotation operation, so the Activator.java registers service for Alignment, Annotation and ProbeSet. The new class name is "MyPlugin" in the following code.

@Override
protected ServiceRegistration<?>\[\] registerService(IGBService igbService) throws Exception {
	return new ServiceRegistration\[\] {
		bundleContext.registerService(Operator.class, new MyPlugin(FileTypeCategory.Alignment), null),
		bundleContext.registerService(Operator.class, new MyPlugin(FileTypeCategory.Annotation), null),
		bundleContext.registerService(Operator.class, new MyPlugin(FileTypeCategory.ProbeSet), null)
	};
}

For more options refer to the Extension Points section

Step 6. Update SamplePlugin.java: Open SamplePlugin.java in the same /src directory. Start by updating with your plugin name (e.g. MyPlugin), your package declarations, your class name and constructor(s). Overriding getDisplay() sets the display name in IGB (e.g. "My Operation"). This sample code inherits AbstractAnnotationOperator and implements Operator interface to work as a new annotation operation.

public class MyPlugin extends AbstractAnnotationOperator implements Operator {

	MyPlugin(FileTypeCategory category){
		super(category);
	}

	@Override
	public String getName() {
		return this.category.toString().toLowerCase() +"_my_plugin";
	}

	@Override
	public String getDisplay() {
		return "My Operation";
	}

	private boolean overlap(BioSeq aseq, SeqSymmetry s0, SeqSymmetry s1) {
	}

	@Override
	public SeqSymmetry operate(BioSeq aseq, List<SeqSymmetry> symList) {

	}
}

Step 7. Update MAINFEST.BASE: Directly under the template /src (close /com), update the following highlighted fields in MAINFEST.BASE.

• Bundle-Name - change to your plugin name
• Bundle-SymbolicName - change to your package path
• Bundle-Version - change to your plugin version
• Bundle-Activation - change to your Activator path (e.g. com.myorg.myplugin.Activator)
• Import-Package - include all the classes your are using in your source code

Step 8. Update ant.properties: Also found under the template /src, update the highlighted fields as follows.

Change name and project to your plugin name. Update classpath with the necessary path; refer to the project build.xml for the location annotations.

6. Update build.properties for the project (not the one in plugin folder)

On the line 'not.include.bundles=', delete all the existing values and add your plugin name:

Clean and Build IGB

Delete files in IGB_HOME/plugins/ext

In command line, go to IGB_HOME, run command

Enter your svn password as necessary

Move the generated files in IGB_HOME/plugins/ext (MyPlugin.jar and repository.xml) to the folder (local or remote HTTP server) where you want your plugin site on
Make sure you are cut from IGB_HOME/plugins/ext (or delete it after copying)

Run IGB -> "Plug-ins' tab

Click 'Repositories...' button to open the Plugin configuration panel

Enter the name you want to name, this can be any name you like since it will only show in the plugin site list

Enter the URL for your remote server such as http://www.mysite.com/my_plugin_folder

OR

Click '...' button to select the folder in local machine

Click 'Add Repository' button and now you should see your plugin site is added into the site list, also your plugin MyPlugin is showing in the Plug-ins tab in IGB after close the configuration panel

Install the plugin by checking 'Installed'

Now let's take a look what the sample plugin looks like.

Load 2 annotations then select them by clicking with Shift, right click and we can see 'My Operation' is there:

Click 'My Operation' will generate a new track based on what the sample plugin does on these 2 annotations: