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.
An ODA driver that implements the ODA run-time extension point may optionally extend this ODA UI extension point to provide a customized ODA designer.

<!ELEMENT extension (dataSourceUI)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT dataSourceUI (newDataSourceWizard)>

<!ATTLIST dataSourceUI

id CDATA #REQUIRED>

Allows providers to provide customized dialog page(s) support for an user to create a new ODA data access design definition. The element defines children elements for the data source wizard page(s) and editor page(s).

id - A fully qualified ID that uniquely identifies the ODA data source extension within an ODA consumer application's environment. Its value must match that of the dataSource.id attribute defined in the org.eclipse.datatools.connectivity.oda.dataSource extension of the same ODA driver. If implementing the org.eclipse.datatools.connectivity.connectionProfile extension point, its value must also match that of its connectionProfile.id attribute.

<!ELEMENT newDataSourceWizard EMPTY>

<!ATTLIST newDataSourceWizard

windowTitle CDATA #IMPLIED

includesProgressMonitor (true | false) "true"

pageTitle CDATA #IMPLIED

pageClass CDATA #REQUIRED>

This element defines the customizable behavior of the new data source wizard dialog that allows an user to create a new ODA data source definition. It includes specifying the customized wizard page that an extension would add to the new data source wizard dialog (org.eclipse.datatools.connectivity.oda.design.ui.profile.wizards.NewDataSourceWizard).

windowTitle - The customized title of the new data source wizard window.
includesProgressMonitor - Indicates whether the new data source wizard should include a progress monitor. Default value is "true".
pageTitle - The page title of the new data source wizard's first customized page. Its value, if specified, overrides any title that may have been set by the wizard page's constructor.
pageClass - A fully quailfied class name that implements the first wizard page for creating a new customized ODA data source definition.
This class must extend from the ODA abstract base class, org.eclipse.datatools.connectivity.oda.design.ui.profile.wizards.DataSourceWizardPage.

   <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.profile.FolderSelectionWizardPage"

               pageTitle=
"Select Folder"

               windowTitle=
"New Flat File Data Source Profile"

               includesProgressMonitor=
"false"
/>
      </dataSourceUI>
   </extension>

[Experimental] This package API and extension point are going through iterative development cycles, and will likely change.
An extension must implement the related dialog pages defined in the extension'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.

Copyright (c) 2006 Actuate Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html

Open Data Access Designer

Identifier:

Since:

Description:

Configuration Markup:

Examples:

API Information:

Supplied Implementation: