| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <HTML> |
| 3 | <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| 4 | <title>Open Data Access Designer</title> |
| Linda Chan | 34cac96 | 2006-03-29 13:45:27 +0000 | [diff] [blame] | 5 | <style>@import url("file:/D:/Lang/eclipse_32M5a/plugins/org.eclipse.sdk_3.2.0.v20060214/book.css");</style> |
| Linda Chan | 088a101 | 2006-04-05 00:03:55 +0000 | [diff] [blame] | 6 | <style>@import url("file:/D:/Lang/eclipse_32M5a/configuration/org.eclipse.osgi/bundles/192/1/.cp/schema.css");</style> |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 7 | </HEAD> |
| 8 | <BODY> |
| 9 | <H1><CENTER>Open Data Access Designer</CENTER></H1> |
| 10 | <p></p> |
| 11 | <h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.datatools.connectivity.oda.design.ui.dataSource<p></p> |
| 12 | <h6 class=CaptionFigColumn id=header>Since: </h6>3.0 |
| 13 | <p></p> |
| 14 | |
| 15 | <p> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 16 | <h6 class=CaptionFigColumn id=header>Description: </h6>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. |
| Linda Chan | 9efb782 | 2006-03-13 01:52:49 +0000 | [diff] [blame] | 17 | <br>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.</p> |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 18 | <p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 19 | <p class=code id=dtd><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.dataSourceUI">dataSourceUI</a> , <a href="#e.dataSetUI">dataSetUI</a>+)></p> |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 20 | <p class=code id=dtd><!ATTLIST extension</p> |
| 21 | <p class=code id=dtdAttlist>point CDATA #REQUIRED<p class=code id=dtdAttlist>id CDATA #IMPLIED<p class=code id=dtdAttlist>name CDATA #IMPLIED></p> |
| 22 | <p></p> |
| 23 | <ul class=ConfigMarkup id=attlistDesc> |
| 24 | </ul> |
| 25 | <br><p class=code id=dtd><!ELEMENT <a name="e.dataSourceUI">dataSourceUI</a> (<a href="#e.newDataSourceWizard">newDataSourceWizard</a>)></p> |
| 26 | <p class=code id=dtd><!ATTLIST dataSourceUI</p> |
| 27 | <p class=code id=dtdAttlist>id CDATA #REQUIRED></p> |
| 28 | <p></p> |
| 29 | <p class=ConfigMarkup id=elementDesc> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 30 | Allows ODA data providers to define a customized dialog page for an user to create a new ODA data source design instance.</p> |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 31 | <br> |
| 32 | <ul class=ConfigMarkup id=attlistDesc> |
| 33 | <li><b>id</b> - 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 <i>dataSource.id</i> attribute defined in the <i>org.eclipse.datatools.connectivity.oda.dataSource</i> extension of the same ODA driver. |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 34 | When implementing the <i>org.eclipse.datatools.connectivity.connectionProfile</i> extension point, its <i>connectionProfile.id</i> attribute must also match this id value.</li> |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 35 | </ul> |
| 36 | <br><p class=code id=dtd><!ELEMENT <a name="e.newDataSourceWizard">newDataSourceWizard</a> EMPTY></p> |
| 37 | <p class=code id=dtd><!ATTLIST newDataSourceWizard</p> |
| 38 | <p class=code id=dtdAttlist>windowTitle CDATA #IMPLIED<p class=code id=dtdAttlist>includesProgressMonitor (true | false) "true"<p class=code id=dtdAttlist>pageTitle CDATA #IMPLIED<p class=code id=dtdAttlist>pageClass CDATA #REQUIRED></p> |
| 39 | <p></p> |
| 40 | <p class=ConfigMarkup id=elementDesc> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 41 | Defines the customizable behavior of a data source wizard that allows an user to create a new ODA data source design instance. |
| 42 | <br>The implementation class of the data source wizard is specified in the <i>newWizard.class</i> attribute defined in the <i>org.eclipse.datatools.connectivity.connectionProfile</i> extension point. |
| 43 | <br>The wizard class must either use or extend from the ODA framework's wizard base class, <i>org.eclipse.datatools.connectivity.oda.design.ui.wizards.NewDataSourceWizard</i>. |
| 44 | <br><br> |
| 45 | This element includes the attributes to specify the customized wizard starting page that an extension contributes to the data source wizard.</p> |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 46 | <br> |
| 47 | <ul class=ConfigMarkup id=attlistDesc> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 48 | <li><b>windowTitle</b> - The customized title of the data source wizard window.</li> |
| 49 | <li><b>includesProgressMonitor</b> - Indicates whether the data source wizard should include a progress monitor. Default value is "true".</li> |
| 50 | <li><b>pageTitle</b> - The page title of the data source wizard's customized starting page. This value, if specified, overrides any title that may have been set by the wizard page's constructor.</li> |
| 51 | <li><b>pageClass</b> - A fully qualified class name that implements the wizard starting page for creating a new ODA data source design instance. |
| Linda Chan | 34cac96 | 2006-03-29 13:45:27 +0000 | [diff] [blame] | 52 | <br>This class must extend from the ODA abstract base class, <i>org.eclipse.datatools.connectivity.oda.design.ui.wizards.DataSourceWizardPage</i>. |
| 53 | <br>A default concrete implementation class is provided in the ODA framework, <i>org.eclipse.datatools.connectivity.oda.design.ui.pages.impl.DefaultDataSourceWizardPage</i>. An ODA extension may choose to use or extend from this default implementation class.</li> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 54 | </ul> |
| Linda Chan | 34cac96 | 2006-03-29 13:45:27 +0000 | [diff] [blame] | 55 | <br><p class=code id=dtd><!ELEMENT <a name="e.dataSetUI">dataSetUI</a> (<a href="#e.dataSetWizard">dataSetWizard</a> , <a href="#e.dataSetPage">dataSetPage</a>+)></p> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 56 | <p class=code id=dtd><!ATTLIST dataSetUI</p> |
| Linda Chan | 088a101 | 2006-04-05 00:03:55 +0000 | [diff] [blame] | 57 | <p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>initialPageId CDATA #IMPLIED<p class=code id=dtdAttlist>supportsInParameters (true | false) "true"<p class=code id=dtdAttlist>supportsOutParameters (true | false) "false"></p> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 58 | <p></p> |
| 59 | <p class=ConfigMarkup id=elementDesc> |
| Linda Chan | 34cac96 | 2006-03-29 13:45:27 +0000 | [diff] [blame] | 60 | Allows ODA data providers to define customized dialog page(s) for an user to create or edit an ODA data set design instance. |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 61 | The element defines child elements for the data set wizard page(s) and editor page(s). |
| 62 | <br>An ODA host designer may use the custom wizard pages' control for editing a data set design instance.</p> |
| 63 | <br> |
| 64 | <ul class=ConfigMarkup id=attlistDesc> |
| 65 | <li><b>id</b> - A fully qualified ID that uniquely identifies the ODA data set type within an ODA data source extension. Its value must match that of the <i>dataSet.id</i> attribute defined in the <i>org.eclipse.datatools.connectivity.oda.dataSource</i> extension of the same ODA driver.</li> |
| 66 | <li><b>initialPageId</b> - Identifies a particular dataSetPage that should be selected in a data set dialog.</li> |
| Linda Chan | 088a101 | 2006-04-05 00:03:55 +0000 | [diff] [blame] | 67 | <li><b>supportsInParameters</b> - Indicates that this type of data set design supports input parameter definitions, and that an ODA host designer might need to collect further metadata on the parameter definitions provided by the customized page(s).</li> |
| 68 | <li><b>supportsOutParameters</b> - Indicates that this type of data set design supports output parameter definitions, and that an ODA host designer might need to collect further metadata on the parameter definitions provided by the customized page(s).</li> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 69 | </ul> |
| Linda Chan | 34cac96 | 2006-03-29 13:45:27 +0000 | [diff] [blame] | 70 | <br><p class=code id=dtd><!ELEMENT <a name="e.dataSetWizard">dataSetWizard</a> EMPTY></p> |
| 71 | <p class=code id=dtd><!ATTLIST dataSetWizard</p> |
| 72 | <p class=code id=dtdAttlist>class CDATA "org.eclipse.datatools.connectivity.oda.design.ui.wizards.DataSetWizard"<p class=code id=dtdAttlist>windowTitle CDATA #IMPLIED></p> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 73 | <p></p> |
| 74 | <p class=ConfigMarkup id=elementDesc> |
| Linda Chan | 34cac96 | 2006-03-29 13:45:27 +0000 | [diff] [blame] | 75 | Defines a data set wizard that allows an user to create or edit an ODA data set design instance.</p> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 76 | <br> |
| 77 | <ul class=ConfigMarkup id=attlistDesc> |
| 78 | <li><b>class</b> - The implementation class of the data set wizard. |
| Linda Chan | 34cac96 | 2006-03-29 13:45:27 +0000 | [diff] [blame] | 79 | <br>The wizard class must either use or extend from the ODA framework's wizard base class, <i>org.eclipse.datatools.connectivity.oda.design.ui.wizards.DataSetWizard</i>.</li> |
| Linda Chan | 5573655 | 2006-02-24 05:09:31 +0000 | [diff] [blame] | 80 | <li><b>windowTitle</b> - The customized title of the data set wizard window.</li> |
| 81 | </ul> |
| 82 | <br><p class=code id=dtd><!ELEMENT <a name="e.dataSetPage">dataSetPage</a> EMPTY></p> |
| 83 | <p class=code id=dtd><!ATTLIST dataSetPage</p> |
| 84 | <p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>wizardPageClass CDATA #REQUIRED<p class=code id=dtdAttlist>displayName CDATA #IMPLIED<p class=code id=dtdAttlist>path CDATA #IMPLIED<p class=code id=dtdAttlist>icon CDATA #IMPLIED></p> |
| 85 | <p></p> |
| 86 | <p class=ConfigMarkup id=elementDesc> |
| 87 | Defines a customized page that an extension contributes to an ODA host designer's data set dialog.</p> |
| 88 | <br> |
| 89 | <ul class=ConfigMarkup id=attlistDesc> |
| 90 | <li><b>id</b> - A unique name of this page within a data set dialog.</li> |
| 91 | <li><b>wizardPageClass</b> - A fully qualified class name that implements a data set wizard page to create or edit an ODA data set design instance. |
| 92 | <br>This class must extend from the ODA abstract base class, <i>org.eclipse.datatools.connectivity.oda.design.ui.wizards.DataSetWizardPage</i>.</li> |
| 93 | <li><b>displayName</b> - The page title or descriptive name of a customized page that will be displayed in the UI of this page. |
| 94 | This value, if specified, overrides any title or descriptive name that may have been set by the page's constructor.</li> |
| 95 | <li><b>path</b> - The path of the page in a data set preference dialog. |
| 96 | <br>To add the page to the root node, specify "/" in this value. Default value is "/". |
| 97 | <br>To add the page as a child of another page node, specify its full path starting with a "/"; and use the "/" as a separator in between each page node in the hierarchy. |
| 98 | <br>For example, a path value "/parent" would add this page as a child node to an existing page called "parent". |
| 99 | <br><br>Note: The page with the name "parent" should have been added before attempting to add the child page.</li> |
| 100 | <li><b>icon</b> - A relative path to an icon that will be used in the UI in addition to the page's display name.</li> |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 101 | </ul> |
| 102 | <br><h6 class=CaptionFigColumn id=header>Examples: </h6><p> |
| 103 | <pre> |
| 104 | <p class=code id=tag><extension |
| 105 | point=<p class=code id=cstring>"org.eclipse.datatools.connectivity.oda.design.ui.dataSource"</p><p class=code id=tag>></p> |
| 106 | <p class=code id=tag><dataSourceUI id=<p class=code id=cstring>"%oda.data.source.id"</p><p class=code id=tag>></p> |
| 107 | <p class=code id=tag><newDataSourceWizard |
| Linda Chan | 9efb782 | 2006-03-13 01:52:49 +0000 | [diff] [blame] | 108 | pageClass=<p class=code id=cstring>"org.eclipse.datatools.connectivity.oda.flatfile.ui.wizards.FolderSelectionWizardPage"</p><p class=code id=tag> |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 109 | pageTitle=<p class=code id=cstring>"Select Folder"</p><p class=code id=tag> |
| 110 | windowTitle=<p class=code id=cstring>"New Flat File Data Source Profile"</p><p class=code id=tag> |
| 111 | includesProgressMonitor=<p class=code id=cstring>"false"</p><p class=code id=tag>/></p> |
| 112 | <p class=code id=tag></dataSourceUI></p> |
| Linda Chan | 9efb782 | 2006-03-13 01:52:49 +0000 | [diff] [blame] | 113 | <p class=code id=tag><dataSetUI |
| 114 | id=<p class=code id=cstring>"org.eclipse.datatools.connectivity.oda.flatfile.dataSet"</p><p class=code id=tag> |
| 115 | initialPageId=<p class=code id=cstring>"oda.flatfile.ui.tablePage"</p><p class=code id=tag> |
| Linda Chan | 088a101 | 2006-04-05 00:03:55 +0000 | [diff] [blame] | 116 | supportsInParameters=<p class=code id=cstring>"false"</p><p class=code id=tag> |
| 117 | supportsOutParameters=<p class=code id=cstring>"false"</p><p class=code id=tag>></p> |
| Linda Chan | 34cac96 | 2006-03-29 13:45:27 +0000 | [diff] [blame] | 118 | <p class=code id=tag><dataSetWizard |
| 119 | class=<p class=code id=cstring>"org.eclipse.datatools.connectivity.oda.design.ui.wizards.DataSetWizard"</p><p class=code id=tag> |
| Linda Chan | 9efb782 | 2006-03-13 01:52:49 +0000 | [diff] [blame] | 120 | windowTitle=<p class=code id=cstring>"Select Table"</p><p class=code id=tag>/></p> |
| 121 | <p class=code id=tag><dataSetPage |
| 122 | displayName=<p class=code id=cstring>"Select Columns"</p><p class=code id=tag> |
| 123 | icon=<p class=code id=cstring>"icons/file.gif"</p><p class=code id=tag> |
| 124 | id=<p class=code id=cstring>"oda.flatfile.ui.tablePage"</p><p class=code id=tag> |
| 125 | path=<p class=code id=cstring>"/"</p><p class=code id=tag> |
| 126 | wizardPageClass=<p class=code id=cstring>"org.eclipse.datatools.connectivity.oda.flatfile.ui.wizards.FileSelectionWizardPage"</p><p class=code id=tag>/></p> |
| 127 | <p class=code id=tag></dataSetUI></p> |
| 128 | <p class=code id=tag></extension></p> |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 129 | </pre> |
| 130 | </p> |
| 131 | <p></p> |
| 132 | |
| Linda Chan | 9efb782 | 2006-03-13 01:52:49 +0000 | [diff] [blame] | 133 | <h6 class=CaptionFigColumn id=header>API Information: </h6>[<b>Provisional</b>] An extension must implement the related dialog pages defined in the extension point's schema. |
| 134 | See the abstract base classes' JavaDoc documentation in the <i>org.eclipse.datatools.connectivity.oda.design.ui</i> project for more information. |
| jgraham | 36a996f | 2006-02-13 21:18:46 +0000 | [diff] [blame] | 135 | <p></p> |
| 136 | |
| 137 | <h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>The plug-in <i>org.eclipse.datatools.connectivity.oda.flatfile.ui</i>, supplied with the Eclipse DTP Connectivity source, provides an example for implementing a simple ODA Design UI extension. |
| 138 | <p></p> |
| 139 | |
| 140 | <br> |
| 141 | <p class=note id=copyright> |
| 142 | Copyright (c) 2006 Actuate Corporation. |
| 143 | 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 |
| 144 | <p></p> |
| 145 | |
| 146 | </p> |
| 147 | </BODY> |
| 148 | </HTML> |