Changeset 3592 for trunk/doc/src/docbook/developerdoc/plugin_developer.xml

Timestamp:

Jul 23, 2007, 2:57:39 PM (16 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #687: Make it possible for other plug-ins than the FormulaFilter? to be launched by the 'Filter bioassayset' button

File:

• trunk/doc/src/docbook/developerdoc/plugin_developer.xml (modified) (1 diff)

trunk/doc/src/docbook/developerdoc/plugin_developer.xml

@@ -2981 +2981 @@
       
     </sect2>
+    
+    <sect2 id="plugin_developer.analyse.filterplugin">
+      <title>The AnalysisFilterPlugin interface</title>
+      
+      <para>
+        The <interfacename>net.sf.basedb.core.plugin.AnalysisFilterPlugin</interfacename> 
+        is a tagging interface with no methods that all analysis plug-ins that only filters
+        data should implement. The benefit is that they will be linked from the
+        <guibutton>Filter bioassay set</guibutton> button and not just
+        the <guibutton>Run analysis</guibutton> button. They will also get
+        a different icon in the experiment outline to make filtering 
+        transformations appear different from other transformations.
+      </para>
+      
+      <para>
+        The interface exists purely for making the user interaction better. There is
+        no harm in not implementing it since the plug-in will always appear in
+        from the <guibutton>Run analysis</guibutton> button. On the other hand,
+        it doesn't cost anything to implement the interface since it doesn't
+        have any methods.
+      </para>
+    
+    </sect2>
 
   </sect1>