Lan@dote.ru: Created page with "{{Extension point|biohub|ru.biosoft.access|registry=ru.biosoft.access.biohub.BioHubRegistry}} === Description === This extension point allows you to register a BioHub. ==..."

2013-05-20T04:17:35Z

Created page with "{{Extension point|biohub|ru.biosoft.access|registry=ru.biosoft.access.biohub.BioHubRegistry}} === Description === This extension point allows you to register a BioHub. ==..."

New page

{{Extension point|biohub|ru.biosoft.access|registry=ru.biosoft.access.biohub.BioHubRegistry}}
=== Description ===
This extension point allows you to register a [[BioHub]].

=== Configuration Markup ===
<!ELEMENT hubItem (property)*>
<!ATTLIST hubItem
name CDATA #REQUIRED
class CDATA #REQUIRED
>

;name
:BioHub user-friendly name.
;class
:Fully-qualified name of class implementing {{Class|ru.biosoft.access.biohub.BioHub}} interface.

<!ELEMENT property>
<!ATTLIST property
name CDATA #REQUIRED
value CDATA #REQUIRED
>

;name
:name of the property
;value
:value of the property

These properties will be passed to constructor.

=== Example ===
<extension id="GOhub" point="ru.biosoft.access.biohub">
<hubItem name="GO" class="biouml.plugins.go.GOHub">
<property name="jdbcDriverClass" value="org.gjt.mm.mysql.Driver"/>
<property name="jdbcURL" value="jdbc:mysql://localhost:3306/go"/>
<property name="jdbcUser" value="go"/>
<property name="jdbcPassword" value="go"/>
</hubItem>
</extension>

This extension defines a hub "GO" implemented in {{Class|biouml.plugins.go.GOHub}} class and passes database configuration properties.

=== Module BioHub registration ===
When BioHub is associated with some [[module]] in the repository, it's strongly recommended to register it in the module instead. You should add the following line to the module configuration file:

<nowiki>bioHub.<hubId>=<BioHub_class>[;<name>=<value>[;<name>=<value>[;...]]]</nowiki>

Where <code><hubId></code> is the internal BioHub id; <code><BioHub_class></code> is the fully-qualified name of class implementing {{Class|ru.biosoft.access.biohub.BioHub}} interface and any custom properties are defined in <code><name>=<value></code> pairs. Example:

bioHub.functional=biouml.plugins.gtrd.TFClassificationFunctionalHub;name=TF classification

=== Notes ===
* Any BioHub implementation must have a constructor which accepts single parameter of type {{Class|java.util.Properties}}. Upon BioHub instantiation the {{Class|java.util.Properties}} object will be passed which include:
** All properties defined inside hubItem extension point or in BioHub definition line in the module configuration;
** For BioHubs defined as extensions: property <code>"name"</code> having value of BioHub name;
** For BioHubs defined in the modules: properties <code>"completeName"</code> and <code>"moduleName"</code> containing full path to the module. It's recommended to use <code>"completeName"</code> property; the <code>"moduleName"</code> property is passed for the legacy reasons.
* When you're implementing BioHub, in many cases it's convenient to extend abstract class {{Class|ru.biosoft.access.biohub.BioHubSupport}}.

Biohub (extension point) - Revision history

Lan@dote.ru: Created page with "{{Extension point|biohub|ru.biosoft.access|registry=ru.biosoft.access.biohub.BioHubRegistry}} === Description === This extension point allows you to register a BioHub. ==..."