Open Data Access Designer

org.eclipse.datatools.connectivity.oda.design.ui.dataSource

3.0

This extension point provides extensibility to the Open Data Access (ODA) Designer UI framework, through which an user may define an ODA data source design and a data set design.
An ODA driver that implements the ODA run-time extension point may optionally extend this ODA UI extension point to contribute customized ODA design wizard and property pages.

<!ELEMENT extension (dataSourceUI , dataSetUI+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT dataSourceUI (newDataSourceWizard)>

<!ATTLIST dataSourceUI

id CDATA #REQUIRED>

Allows ODA data providers to define a customized dialog page for an user to create a new ODA data source design instance.



<!ELEMENT newDataSourceWizard EMPTY>

<!ATTLIST newDataSourceWizard

windowTitle             CDATA #IMPLIED

includesProgressMonitor (true | false) "true"

pageTitle               CDATA #IMPLIED

pageClass               CDATA #REQUIRED>

Defines the customizable behavior of a data source wizard that allows an user to create a new ODA data source design instance.
The implementation class of the data source wizard is specified in the newWizard.class attribute defined in the org.eclipse.datatools.connectivity.connectionProfile extension point.
The wizard class must either use or extend from the ODA framework's wizard base class, org.eclipse.datatools.connectivity.oda.design.ui.wizards.NewDataSourceWizard.

This element includes the attributes to specify the customized wizard starting page that an extension contributes to the data source wizard.



<!ELEMENT dataSetUI (dataSetWizard , dataSetPage+)>

<!ATTLIST dataSetUI

id                    CDATA #REQUIRED

initialPageId         CDATA #IMPLIED

supportsInParameters  (true | false) "true"

supportsOutParameters (true | false) "false">

Allows ODA data providers to define customized dialog page(s) for an user to create or edit an ODA data set design instance. The element defines child elements for the data set wizard page(s) and editor page(s).
An ODA host designer may use the custom wizard pages' control for editing a data set design instance.



<!ELEMENT dataSetWizard EMPTY>

<!ATTLIST dataSetWizard

class       CDATA "org.eclipse.datatools.connectivity.oda.design.ui.wizards.DataSetWizard"

windowTitle CDATA #IMPLIED>

Defines a data set wizard that allows an user to create or edit an ODA data set design instance.



<!ELEMENT dataSetPage EMPTY>

<!ATTLIST dataSetPage

id              CDATA #REQUIRED

wizardPageClass CDATA #REQUIRED

displayName     CDATA #IMPLIED

path            CDATA #IMPLIED

icon            CDATA #IMPLIED>

Defines a customized page that an extension contributes to an ODA host designer's data set dialog.



   

<extension point=

"org.eclipse.datatools.connectivity.oda.design.ui.dataSource"

>

<dataSourceUI id=

"%oda.data.source.id"

>

<newDataSourceWizard pageClass=

"org.eclipse.datatools.connectivity.oda.flatfile.ui.wizards.FolderSelectionWizardPage"

pageTitle=

"Select Folder"

windowTitle=

"New Flat File Data Source Profile"

includesProgressMonitor=

"false"

/>

</dataSourceUI>

<dataSetUI id=

"org.eclipse.datatools.connectivity.oda.flatfile.dataSet"

initialPageId=

"oda.flatfile.ui.tablePage"

supportsInParameters=

"false"

supportsOutParameters=

"false"

>

<dataSetWizard class=

"org.eclipse.datatools.connectivity.oda.design.ui.wizards.DataSetWizard"

windowTitle=

"Select Table"

/>

<dataSetPage displayName=

"Select Columns"

icon=

"icons/file.gif"

id=

"oda.flatfile.ui.tablePage"

path=

"/"

wizardPageClass=

"org.eclipse.datatools.connectivity.oda.flatfile.ui.wizards.FileSelectionWizardPage"

/>

</dataSetUI>

</extension>

[Provisional] An extension must implement the related dialog pages defined in the extension point's schema. See the abstract base classes' JavaDoc documentation in the org.eclipse.datatools.connectivity.oda.design.ui project for more information.

The plug-in org.eclipse.datatools.connectivity.oda.flatfile.ui, supplied with the Eclipse DTP Connectivity source, provides an example for implementing a simple ODA Design UI extension.