Difference between revisions of "Annotation (extension point)"

Latest revision as of 10:57, 14 May 2013

Identifier

biouml.plugins.sbml.annotation

Plugin

biouml.plugins.sbml

Registry

SbmlAnnotationRegistry

[edit] Description

SBML file may contains different information using annotation block. This extension point allows to register new class implementing SbmlExtension interface which will be called when SBML file reading and writing. One SbmlExtension class should transform one structure to XML format. In our example, StateExtension allows to save diagram states to SBML.

[edit] Configuration Markup

<!ELEMENT annotation>
<!ATTLIST annotation
  namespace        CDATA #REQUIRED
  priority         CDATA
  extension_class  CDATA #REQUIRED
>

namespace

the name of XML element.

priority

priority level for this extension (by default, 100).

extension_class

the fully-qualified name of extension class.

[edit] Examples

This is example of state extension for SBML format

<extension id="StateAnnotationExtension" point="biouml.plugins.sbml.annotation"> 
  <annotation
     namespace="state" 
     priority="3"
     extension_class="biouml.plugins.sbml.extensions.StateExtension"
  /> 
</extension> 

[edit] API Information

The value of the extension_class attribute must represent an implementor of SbmlExtension interface. It might be more convenient to extend SbmlExtensionSupport class.