Method (extension point) - Revision history

Lan@dote.ru: +Analysis method development

2013-09-13T05:19:46Z

+Analysis method development

Lan@dote.ru: {{Class}}

2013-05-13T08:54:17Z

Lan@dote.ru at 09:07, 8 May 2013

2013-05-08T09:07:56Z

Lan@dote.ru: +plugin

2013-05-07T06:20:15Z

+plugin

Lan@dote.ru: /* JavaScript implementation */

2013-05-07T05:58:38Z

‎JavaScript implementation

Lan@dote.ru: /* JavaScript implementation */

2013-05-07T05:57:32Z

‎JavaScript implementation

Lan@dote.ru: Method description HTML file as separate page

2013-04-23T04:19:58Z

Method description HTML file as separate page

Lan@dote.ru at 07:59, 16 April 2013

2013-04-16T07:59:36Z

Lan@dote.ru: Created page with "NOTOC ;Identifier :ru.biosoft.analysis.method ;Registry :ru.biosoft.analysis.AnalysisMethodRegistry === Description === This extension point allows you to define new anal..."

2013-04-16T07:44:45Z

Created page with "__NOTOC__ ;Identifier :ru.biosoft.analysis.method ;Registry :ru.biosoft.analysis.AnalysisMethodRegistry === Description === This extension point allows you to define new anal..."

New page

__NOTOC__
;Identifier
:ru.biosoft.analysis.method
;Registry
:ru.biosoft.analysis.AnalysisMethodRegistry

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

=== 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 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
:analysis group (subfolder under <code>analyses/Methods</code>) to place the analysis to.
;name
:analysis name
;description
:either textual description or path to method description HTML file. This file must be located in the same plugin as the analysis itself. You can use %parameters% string inside that file to insert automatically generated parameters description there.
;js
:name of autogenerated JavaScript function which represents this analysis in the hostObject.function format.

=== 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>

=== JavaScript implementation ===

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>.
* Register it via [[HostObject (extension point)|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.

[[Category:Extension points]]

← Older revision		Revision as of 05:19, 13 September 2013
Line 44:		Line 44:
	* 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.
		+
		+	=== See also ===
		+	* [[Analysis method development]]

@@ Line 14: / Line 14: @@
 ;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
 :analysis group (subfolder under <code>analyses/Methods</code>) to place the analysis to.
@@ Line 43: / Line 41: @@
 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.
 * Add "js" attribute with registered host object name and desired method name separated by point as <code>"siteAnalysis.trackStats"</code> in the example above.

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{Extension point|method|ru.biosoft.analysis|registry=ru.biosoft.analysis.AnalysisMethodRegistry}}
-;Identifier
-:ru.biosoft.analysis.method
-;Plugin
-:[[ru.biosoft.analysis (plugin)|ru.biosoft.analysis]]
-;Registry
-:ru.biosoft.analysis.AnalysisMethodRegistry
-−
 === Description ===
 This extension point allows you to define new analyses method. Analysis methods appear under <code>analyses/Methods</code> path in the repository.
@@ Line 53: / Line 46: @@
 * 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.

@@ Line 49: / Line 49: @@
 * Create JavaScript host object class which extends <code>ru.biosoft.analysis.javascript.JavaScriptAnalysisHost</code>.
-* Register it via [[HostObject (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.
 [[Category:Extension points]]

@@ Line 27: / Line 27: @@
 :analysis name
 ;description
-:either textual description or path to method description HTML file. This file must be located in the same plugin as the analysis itself. You can use %parameters% string inside that file to insert automatically generated parameters description there.
+: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.

Method (extension point) - Revision history

Lan@dote.ru: +Analysis method development

Lan@dote.ru: {{Class}}

Lan@dote.ru at 09:07, 8 May 2013

Lan@dote.ru: +plugin

Lan@dote.ru: /* JavaScript implementation */

Lan@dote.ru: /* JavaScript implementation */

Lan@dote.ru: Method description HTML file as separate page

Lan@dote.ru at 07:59, 16 April 2013

Lan@dote.ru: Created page with "__NOTOC__ ;Identifier :ru.biosoft.analysis.method ;Registry :ru.biosoft.analysis.AnalysisMethodRegistry === Description === This extension point allows you to define new anal..."

Lan@dote.ru: Created page with "NOTOC ;Identifier :ru.biosoft.analysis.method ;Registry :ru.biosoft.analysis.AnalysisMethodRegistry === Description === This extension point allows you to define new anal..."