Difference between revisions of "Common class (extension point)"
From BioUML platform
Tagir Valeev (Talk | contribs) (Template used) |
Tagir Valeev (Talk | contribs) m (Cosmetic) |
||
| Line 1: | Line 1: | ||
{{Extension point|commonClass|ru.biosoft.access|since=0.9.3}} | {{Extension point|commonClass|ru.biosoft.access|since=0.9.3}} | ||
| − | |||
=== Motivation === | === Motivation === | ||
Client-side JavaScript code of [[BioUML web edition]] sometimes need to know the hierarchy of some Java classes, especially classes of data elements which often appear in the tree. JavaScript can always send an AJAX query to the server requesting such information, but sending such queries too often will harm the responsiveness of the client. Thus it was desired to select some classes and send their hierarchies during client initialization (immediately after login). These classes are named as "common classes" and can be registered via this extension point. | Client-side JavaScript code of [[BioUML web edition]] sometimes need to know the hierarchy of some Java classes, especially classes of data elements which often appear in the tree. JavaScript can always send an AJAX query to the server requesting such information, but sending such queries too often will harm the responsiveness of the client. Thus it was desired to select some classes and send their hierarchies during client initialization (immediately after login). These classes are named as "common classes" and can be registered via this extension point. | ||
Revision as of 16:18, 8 May 2013
- Identifier
- ru.biosoft.access.commonClass
- Plugin
- ru.biosoft.access
- Since
- 0.9.3
Motivation
Client-side JavaScript code of BioUML web edition sometimes need to know the hierarchy of some Java classes, especially classes of data elements which often appear in the tree. JavaScript can always send an AJAX query to the server requesting such information, but sending such queries too often will harm the responsiveness of the client. Thus it was desired to select some classes and send their hierarchies during client initialization (immediately after login). These classes are named as "common classes" and can be registered via this extension point.
Configuration Markup
<!ELEMENT class>
<!ATTLIST class
name CDATA #REQUIRED
>
- name
- Fully-qualified name of the common class
Notes
- This extension point is useful for BioUML web edition only.
- There's no case when using this extension point is required. Though in some cases using it will make web client more responsive.
Example
<extension point="ru.biosoft.access.commonClass"> <class name="ru.biosoft.bsa.SqlTrack"/> <class name="ru.biosoft.bsa.AnnotatedSequence"/> </extension>
Two common classes are specified here: SqlTrack and AnnotatedSequence.
