blob: 1174bc505cd7fe8c3c4953d552be1500f09d37e5 [file] [log] [blame]
<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.ogee.export" xmlns="http://www.w3.org/2001/XMLSchema">
<annotation>
<appinfo>
<meta.schema plugin="org.eclipse.ogee.export" id="modelExport" name="Model Export"/>
</appinfo>
<documentation>
This extension-point is used to define an export format.
The extension specifies the input fields for the destination file with its validations. The input fields can be located in the first page of the export wizard, under the destination format combo, or/and in additional pages. The extension also implements the converter that does the actual export.
</documentation>
</annotation>
<element name="extension">
<annotation>
<appinfo>
<meta.element />
</appinfo>
</annotation>
<complexType>
<sequence>
<element ref="model_export"/>
</sequence>
<attribute name="point" type="string" use="required">
<annotation>
<documentation>
</documentation>
</annotation>
</attribute>
<attribute name="id" type="string">
<annotation>
<documentation>
</documentation>
</annotation>
</attribute>
<attribute name="name" type="string">
<annotation>
<documentation>
</documentation>
<appinfo>
<meta.attribute translatable="true"/>
</appinfo>
</annotation>
</attribute>
</complexType>
</element>
<element name="model_export">
<complexType>
<attribute name="id" type="string" use="required">
<annotation>
<documentation>
The id of the model export extension.
</documentation>
</annotation>
</attribute>
<attribute name="displayName" type="string" use="required">
<annotation>
<documentation>
The display name of the model export extension.
This will appear in the model export wizard main page in the Export Format combo text.
</documentation>
<appinfo>
<meta.attribute translatable="true"/>
</appinfo>
</annotation>
</attribute>
<attribute name="description" type="string" use="required">
<annotation>
<documentation>
The description of the model export extension.
This will appear in the model export wizard main page under the Export Format combo, if the export format of this extension will be selected.
</documentation>
<appinfo>
<meta.attribute translatable="true"/>
</appinfo>
</annotation>
</attribute>
<attribute name="icon" type="string">
<annotation>
<documentation>
The icon of the model export extension. Not used.
</documentation>
<appinfo>
<meta.attribute kind="resource"/>
</appinfo>
</annotation>
</attribute>
<attribute name="ModelExportProvider" type="string" use="required">
<annotation>
<documentation>
The ModelExportProvider class.
</documentation>
<appinfo>
<meta.attribute kind="java" basedOn=":org.eclipse.ogee.export.util.extensionpoint.IModelExportProvider"/>
</appinfo>
</annotation>
</attribute>
</complexType>
</element>
<annotation>
<appinfo>
<meta.section type="since"/>
</appinfo>
<documentation>
0.4.0
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="examples"/>
</appinfo>
<documentation>
&lt;p&gt;
&lt;pre&gt;
&lt;!-- Example of a Blank OData model extension --&gt;
&lt;extension
id=&quot;Test&quot;
name=&quot;Test extension&quot;
point=&quot;org.eclipse.ogee.export.modelExport&quot;&gt;
&lt;model_export
ModelExportProvider=&quot;org.eclipse.ogee.export.odatav2.converter.TestModelExportProvider&quot;
description=&quot;Provider description&quot;
displayName=&quot;Provider name&quot;
id=&quot;org.eclipse.ogee.export.test&quot;&gt;
&lt;/model_export&gt;
&lt;/extension&gt;
&lt;/pre&gt;
&lt;/p&gt;
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="apiinfo"/>
</appinfo>
<documentation>
&lt;br&gt;
Plug-ins that wants to extend this extension point must implement the &lt;samp&gt;org.eclipse.ogee.export.provider.IModelExportProvider&lt;/samp&gt; interface.
&lt;br&gt;
The following methods must be implemented:
&lt;p&gt;
&lt;pre&gt;
/**
* Export the model to specific extension. This method is called when the
* user presses the finish button of the wizard.
*
* @param edmxSet
* setMessage and setPageComplete domain model root
*/
public void performFinish(EDMXSet edmxSet) throws ModelExportException;
&lt;/pre&gt;
&lt;/p&gt;
&lt;p&gt;
&lt;pre&gt;
/**
* Create the UI elements and validations for the first page of the export
* wizard.
*
* @param parent
* composite of the UI elements
* @param wizardPage
* supplies access to attributes of the wizard page as defined
* in interface org.eclipse.ogee.provider.
* For example to get the shell or update the page status.
*/
public void createFirstPageUI(Composite parent, IModelExportFirstPage wizardPage);
&lt;/pre&gt;
&lt;/p&gt;
&lt;p&gt;
&lt;pre&gt;
/**
* Get additional pages to be displayed in the wizard after the main page
*
* @return list of additional pages
*/
public List&lt;IWizardPage&gt; getPages();&lt;/pre&gt;
&lt;/p&gt;
&lt;p&gt;
&lt;pre&gt;
/**
* Get extension description to be displayed in the first page under the
* page title. In case the description in null a default description will be
* displayed.
*
* @return page description
*/
public String getPageDescription();
&lt;/pre&gt;
&lt;/p&gt;
</documentation>
</annotation>
<annotation>
<appinfo>
<meta.section type="implementation"/>
</appinfo>
<documentation>
None.
</documentation>
</annotation>
</schema>