Beans (extension point) - Revision history

Lan@dote.ru at 09:14, 13 May 2013

2013-05-13T09:14:42Z

Lan@dote.ru: {{Class}}

2013-05-13T09:04:55Z

Lan@dote.ru: Created page with "{{Extension point|beans|ru.biosoft.access|since=0.9.4|registry=ru.biosoft.access.BeanRegistry}} === Description === This extension point allows you to resolve Java objects by ..."

2013-05-13T08:48:00Z

Created page with "{{Extension point|beans|ru.biosoft.access|since=0.9.4|registry=ru.biosoft.access.BeanRegistry}} === Description === This extension point allows you to resolve Java objects by ..."

New page

{{Extension point|beans|ru.biosoft.access|since=0.9.4|registry=ru.biosoft.access.BeanRegistry}}
=== Description ===
This extension point allows you to resolve Java objects by paths in [[BioUML]] runtime. Objects located in the tree can be resolved via BioUML [[repository]], but sometimes it's desired to have a static link to some other object (even not DataElement). For this purpose <code>ru.biosoft.access.BeanRegistry.getBean(String)</code> method can be used.

Using this extension point you may register your own prefix to resolve all objects which names start with given prefix. To achieve this you have to implement {{Class|ru.biosoft.access.BeanProvider}} interface and register the created class as an extension.

=== Configuration Markup ===
<!ELEMENT provider>
<!ATTLIST provider
class CDATA #REQUIRED
prefix CDATA #REQUIRED
>

;class
:Fully-qualified name of the class implementing <code>ru.biosoft.access.BeanProvider</code> interface.
;prefix
:Prefix, cannot end with <code>"/"</code>. Only latin letters and <code>"/"</code> are allowed to use in prefix. All paths starting with this prefix will be handled by your class unless more detailed handler is registered. For example, if class A is registered for <code>"properties/myplugin"</code> prefix and class B is registered for <code>"properties/myplugin/deep"</code> prefix, then all paths starting with <code>"properties/myplugin/deep"</code> will be handled by class B, while all other paths starting with <code>"properties/myplugin"</code> will be handled by class A. If two classes are registered for the same prefix, it's undefined which one will handle it.

=== Notes ===
* <code>getBean</code> method always looks first in the BioUML repository for the supplied path. Thus be careful to avoid names collisions. It's recommended to start prefix with <code>"properties/"</code>.

* When you implement {{Class|ru.biosoft.access.BeanProvider}} interface, please note that parameter passed to <code>getBean</code> method is not the full path, but the path except the prefix.

* Currently this extension point is mainly used by [[BioUML web edition]] code. See {{Class|ru.biosoft.server.servlets.webservices.providers.WebBeanProvider}} for details.

=== Example ===
<extension point="ru.biosoft.access.beans">
<provider class="ru.biosoft.table.TableCellBeanProvider" prefix="properties/tableCell"/>
</extension>

All paths starting with "properties/tableCell" will be handled by {{Class|ru.biosoft.table.TableCellBeanProvider}}.

@@ Line 1: / Line 1: @@
 {{Extension point|beans|ru.biosoft.access|since=0.9.4|registry=ru.biosoft.access.BeanRegistry}}
 === Description ===
-This extension point allows you to resolve Java objects by paths in [[BioUML]] runtime. Objects located in the tree can be resolved via BioUML [[repository]], but sometimes it's desired to have a static link to some other object (even not DataElement). For this purpose <code>ru.biosoft.access.BeanRegistry.getBean(String)</code> method can be used.
+This extension point allows you to resolve Java objects by paths in [[BioUML]] runtime. Objects located in the tree can be resolved via BioUML [[repository]], but sometimes it's desired to have a static link to some other object (even not DataElement). For this purpose {{Method|ru.biosoft.access.BeanRegistry.getBean(String)}} method can be used.
 Using this extension point you may register your own prefix to resolve all objects which names start with given prefix. To achieve this you have to implement {{Class|ru.biosoft.access.BeanProvider}} interface and register the created class as an extension.
@@ Line 18: / Line 18: @@
 === Notes ===
-* <code>getBean</code> method always looks first in the BioUML repository for the supplied path. Thus be careful to avoid names collisions. It's recommended to start prefix with <code>"properties/"</code>.
+* {{Method|ru.biosoft.access.BeanRegistry.getBean}} method always looks first in the BioUML repository for the supplied path. Thus be careful to avoid names collisions. It's recommended to start prefix with <code>"properties/"</code>.
-* When you implement {{Class|ru.biosoft.access.BeanProvider}} interface, please note that parameter passed to <code>getBean</code> method is not the full path, but the path except the prefix.
+* When you implement {{Class|ru.biosoft.access.BeanProvider}} interface, please note that parameter passed to {{Method|ru.biosoft.access.BeanProvider.getBean}} method is not the full path, but the path except the prefix.
 * Currently this extension point is mainly used by [[BioUML web edition]] code. See {{Class|ru.biosoft.server.servlets.webservices.providers.WebBeanProvider}} for details.

@@ Line 13: / Line 13: @@
 ;class
-:Fully-qualified name of the class implementing <code>ru.biosoft.access.BeanProvider</code> interface.
+:Fully-qualified name of the class implementing {{Class|ru.biosoft.access.BeanProvider}} interface.
 ;prefix
 :Prefix, cannot end with <code>"/"</code>. Only latin letters and <code>"/"</code> are allowed to use in prefix. All paths starting with this prefix will be handled by your class unless more detailed handler is registered. For example, if class A is registered for <code>"properties/myplugin"</code> prefix and class B is registered for <code>"properties/myplugin/deep"</code> prefix, then all paths starting with <code>"properties/myplugin/deep"</code> will be handled by class B, while all other paths starting with <code>"properties/myplugin"</code> will be handled by class A. If two classes are registered for the same prefix, it's undefined which one will handle it.