Difference between revisions of "Export (extension point)"

Revision as of 16:03, 8 May 2013

Identifier

ru.biosoft.access.export

Plugin

ru.biosoft.access

Since

0.8.7

Description

Using this extension point plug-in can provide data elements exporters in different formats.

Format combo box in Data element export dialog shows all formats suitable for selected element.

List of suitable formats depends from data element type, for example semantic network diagram can not be exported in SBML format. DataElementExporterRegistry is used to select suitable formats for the specified data element.

Configuration Markup

<!ELEMENT export>
  <!ATTLIST export
     format             CDATA    #REQUIRED
     exporter           CDATA    #REQUIRED
     suffix             CDATA    #IMPLIED
     contentType        CDATA  
     description        CDATA
  >

format

display name of format, for example "PNG".

exporter

the fully-qualified name of a class which implements ru.biosoft.access.DataElementExporter interface.

suffix

file suffix (extension) for the specified format.

contentType

content type is used in Web edition requests.

description

format description. It can be plain or html text.

Examples

Following example demonstrates definition of export of all diagram types in PNG format:

<extension id="SvgExport" point="ru.biosoft.access.export"> 
   <export 
      format="Scalable Vector Graphics(*.svg)"
      suffix="svg"
      contentType="image/svg+xml"
      exporter="biouml.plugins.svg.SvgDiagramExporter"
      description="%DiagramExport-SVG"
   /> 
</extension>

API Information

The value of the exporter attribute must represent an implementer of ru.biosoft.access.DataElementExporter interface.

Pending: some formats support depends from JVM version, for example BMP and WBMP formats are supported only in Java 1.5. Additionally, the same exporter can support several formats. For this purpose DiagramExporter has special method, that returns true if the exporter was initialised successfully for the specified format and false otherwise:

boolean init(String format, String suffix)