Difference between revisions of "Common class (extension point)"

From BioUML platform
Jump to: navigation, search
m (Cosmetic)
("name" -> "class")
 
(3 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}}
−
=== Motivation ===
+
=== Description ===
−
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.
+
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:
 +
* To preload classes hierarchies in JavaScript code of [[BioUML web edition]] which makes web client more responsive.
 +
* To automatically generate [[Template:Element types]] via [[User:WikiBot]].
  
 
=== Configuration Markup ===
 
=== Configuration Markup ===
 
  <!ELEMENT class>
 
  <!ELEMENT class>
 
  <!ATTLIST class
 
  <!ATTLIST class
−
       name       CDATA #REQUIRED
+
       class       CDATA #REQUIRED
 
  >
 
  >
  
−
;name
+
;class
 
:Fully-qualified name of the common class
 
: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 ===
 
=== Example ===
 
  <extension point="ru.biosoft.access.commonClass">
 
  <extension point="ru.biosoft.access.commonClass">
−
     <class name="ru.biosoft.bsa.SqlTrack"/>
+
     <class class="ru.biosoft.bsa.SqlTrack"/>
−
     <class name="ru.biosoft.bsa.AnnotatedSequence"/>
+
     <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:

[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.

Retrieved from "https://wiki.biouml.org/index.php?title=Common_class_(extension_point)&oldid=5149"
Personal tools
Namespaces

Variants
Actions
BioUML platform
Community
Modelling
Analysis & Workflows
Collaborative research
Development
Virtual biology
Wiki
Toolbox