Difference between revisions of "Common class (extension point)"
From BioUML platform
Tagir Valeev (Talk | contribs) (Added info about Template:Element types generation.) |
Tagir Valeev (Talk | contribs) ("name" -> "class") |
||
(2 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
{{Extension point|commonClass|ru.biosoft.access|since=0.9.3}} | {{Extension point|commonClass|ru.biosoft.access|since=0.9.3}} | ||
=== Description === | === Description === | ||
− | Common classes are Java classes which implement | + | Common classes are Java classes which implement {{Class|ru.biosoft.access.DataElement}} interface and commonly appear in the [[repository]] tree. If you create new type of elements which appear in the repository, then it's desired to register it via this extension point. |
Currently common classes are used in two places: | Currently common classes are used in two places: | ||
Line 10: | Line 10: | ||
<!ELEMENT class> | <!ELEMENT class> | ||
<!ATTLIST class | <!ATTLIST class | ||
− | + | class CDATA #REQUIRED | |
> | > | ||
− | ; | + | ;class |
:Fully-qualified name of the common class | :Fully-qualified name of the common class | ||
=== Example === | === Example === | ||
<extension point="ru.biosoft.access.commonClass"> | <extension point="ru.biosoft.access.commonClass"> | ||
− | <class | + | <class class="ru.biosoft.bsa.SqlTrack"/> |
− | <class | + | <class class="ru.biosoft.bsa.AnnotatedSequence"/> |
</extension> | </extension> | ||
− | Two common classes are specified here: SqlTrack and AnnotatedSequence. | + | Two common classes are specified here: {{Class|ru.biosoft.bsa.SqlTrack}} and {{Class|ru.biosoft.bsa.AnnotatedSequence}}. |
Latest revision as of 10:17, 28 August 2013
- Identifier
- ru.biosoft.access.commonClass
- Plugin
- ru.biosoft.access
- Since
- 0.9.3
[edit] Description
Common classes are Java classes which implement DataElement
interface and commonly appear in the repository tree. If you create new type of elements which appear in the repository, then it's desired to register it via this extension point.
Currently common classes are used in two places:
- To preload classes hierarchies in JavaScript code of BioUML web edition which makes web client more responsive.
- To automatically generate Template:Element types via BioUML wiki Bot.
[edit] Configuration Markup
<!ELEMENT class> <!ATTLIST class class CDATA #REQUIRED >
- class
- Fully-qualified name of the common class
[edit] Example
<extension point="ru.biosoft.access.commonClass"> <class class="ru.biosoft.bsa.SqlTrack"/> <class class="ru.biosoft.bsa.AnnotatedSequence"/> </extension>
Two common classes are specified here: SqlTrack
and AnnotatedSequence
.