Difference between revisions of "Method (extension point)"

From BioUML platform
Jump to: navigation, search
(JavaScript implementation)
 
(4 intermediate revisions by one user not shown)
Line 1: Line 1:
__NOTOC__
+
{{Extension point|method|ru.biosoft.analysis|registry=ru.biosoft.analysis.AnalysisMethodRegistry}}
;Identifier
+
:ru.biosoft.analysis.method
+
;Registry
+
:ru.biosoft.analysis.AnalysisMethodRegistry
+
 
+
 
=== Description ===
 
=== Description ===
 
This extension point allows you to define new analyses method. Analysis methods appear under <code>analyses/Methods</code> path in the repository.
 
This extension point allows you to define new analyses method. Analysis methods appear under <code>analyses/Methods</code> path in the repository.
Line 19: Line 14:
  
 
;class
 
;class
:fully-qualified name of method class. This class must implement ru.biosoft.analysis.AnalysisMethod interface.
+
:fully-qualified name of method class. This class must implement {{Class|ru.biosoft.analysis.AnalysisMethod}} interface.  
;exporter
+
:the fully-qualified name of a class which implements <code>ru.biosoft.access.DataElementExporter</code> interface. In most of the cases it's easier to subclass AnalysisMethodSupport.
+
 
;group
 
;group
 
:analysis group (subfolder under <code>analyses/Methods</code>) to place the analysis to.
 
:analysis group (subfolder under <code>analyses/Methods</code>) to place the analysis to.
Line 48: Line 41:
 
JavaScript analysis implementation will be automatically generated if you perform the following steps:
 
JavaScript analysis implementation will be automatically generated if you perform the following steps:
  
* Create JavaScript host object class which extends <code>ru.biosoft.analysis.javascript.JavaScriptAnalysisHost</code>.
+
* Create JavaScript host object class which extends {{Class|ru.biosoft.analysis.javascript.JavaScriptAnalysisHost}}.
* Register it via [[Host Object (extension point)#Host_objects_for_analyses|hostObject]] extension point.
+
* Register it via [[Host object (extension point)#Host_objects_for_analyses|hostObject]] extension point.
 
* Add "js" attribute with registered host object name and desired method name separated by point as <code>"siteAnalysis.trackStats"</code> in the example above.
 
* Add "js" attribute with registered host object name and desired method name separated by point as <code>"siteAnalysis.trackStats"</code> in the example above.
  
[[Category:Extension points]]
+
=== See also ===
 +
* [[Analysis method development]]

Latest revision as of 12:19, 13 September 2013

Identifier
ru.biosoft.analysis.method
Plugin
ru.biosoft.analysis
Registry
AnalysisMethodRegistry

[edit] Description

This extension point allows you to define new analyses method. Analysis methods appear under analyses/Methods path in the repository.

[edit] Configuration Markup

<!ELEMENT analysisClass>
<!ATTLIST analysisClass
     class        CDATA #REQUIRED
     group        CDATA #REQUIRED
     name         CDATA #REQUIRED
     description  CDATA #REQUIRED
     js           CDATA #IMPLIED
>
class
fully-qualified name of method class. This class must implement AnalysisMethod interface.
group
analysis group (subfolder under analyses/Methods) to place the analysis to.
name
analysis name
description
either textual description or path to method description HTML file.
js
name of autogenerated JavaScript function which represents this analysis in the hostObject.function format.

[edit] Examples

The following example defines "Track statistics" analysis method:

<extension id="Track statistics" point="ru.biosoft.analysis.method"> 
  <analysisClass
    class="ru.biosoft.bsa.analysis.stats.SequenceStatistics"
    group="BSA"
    name="Track statistics"
    description="Gather various statistics about track or FASTQ file"
    js="siteAnalysis.trackStats"/> 
</extension>

[edit] JavaScript implementation

JavaScript analysis implementation will be automatically generated if you perform the following steps:

  • Create JavaScript host object class which extends JavaScriptAnalysisHost.
  • Register it via hostObject extension point.
  • Add "js" attribute with registered host object name and desired method name separated by point as "siteAnalysis.trackStats" in the example above.

[edit] See also

Personal tools
Namespaces

Variants
Actions
BioUML platform
Community
Modelling
Analysis & Workflows
Collaborative research
Development
Virtual biology
Wiki
Toolbox