External Table Data Editors

org.eclipse.wst.rdb.data.ui.externalTableDataEditor

This extension point is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

The externalTableDataEditor allows to contribute an IExternalTableDataEditor object to be used with a particular vendor, version and datatype and length. The contributed object is then used to edit the currently selected cell of the table editor, allowing to implement support for database-specific data types.

<!ELEMENT extension (externalEditor)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT externalEditor EMPTY>

<!ATTLIST externalEditor

vendor CDATA #IMPLIED

version CDATA #IMPLIED

dataType CDATA #IMPLIED

length CDATA #IMPLIED

class CDATA #REQUIRED>

This element specifies an IExternalTableDataEditor to be used with a combination of vendor/version/data type/length. If several contributions match a given column, the best fitting contribution is used (i.e. the one that specifies the highest number of criteria).

vendor - Vendor: String as returned by org.eclipse.wst.rdb.internal.models.sql.schema.Database.getVendor(). Ommit to match all vendors.
version - Version: String as returned by org.eclipse.wst.rdb.internal.models.sql.schema.Database.getVersion(). Ommit to match all versions.
dataType - Data Type name: String as returned by org.eclipse.wst.rdb.internal.models.sql.datatypes.DataType.getName(). Ommit to match all data types.
length - Data Type length: int as returned by that org.eclipse.wst.rdb.internal.models.sql.datatypes.PredefinedDataType that provide a getLength() method (currently i.e. DataLinkDataType, BinaryStringDataType, CharacterStringDataType). The external Editor is invoked for columns whose length attribute is greater or equal to the specified length. Ommit to match all data type lengths.
class - Class name: Fully qualified name of the Class that is instantiated for the external table data editing. The class must implement the org.eclipse.wst.rdb.data.internal.ui.editor.IExternalTableDataEditor interface and provide a zero-argument Constructor to allow instantiation.

The default implementation in this plugin calls DefaultExternalTableDataWizard (implementing IExternalTableDataEditor) for any column of a datatype (that supports a length attribute) whose length >= 30

   <extension
         id=
"org.eclipse.wst.rdb.data.ui.defaultExternalTableDataEditor"

         name=
"Default External Table Data Editor"

         point=
"org.eclipse.wst.rdb.data.ui.externalTableDataEditor"
>
      <externalEditor 
            length=
"30"
  
            class=
"org.eclipse.wst.rdb.data.internal.ui.editor.DefaultExternalTableDataWizard"
/>
   </extension>

This example will invoke the CloudscapeV10ExternalTableDataEditor for columns of the datatype TIME on a Cloudscape database version 10.0.

   <extension
         id=
"org.eclipse.wst.rdb.data.ui.defaultExternalTableDataEditor"

         name=
"Default External Table Data Editor"

         point=
"org.eclipse.wst.rdb.data.ui.externalTableDataEditor"
>
      <externalEditor 
            vendor=
"IBM Cloudscape"
 
            version=
"10.0"
 
            datatype=
"TIME"

             class=
"org.eclipse.wst.rdb.data.internal.ui.editor.CloudscapeV10ExternalTableDataEditor"
/>
   </extension>

This example invokes the CloudscapeExternalTableDataEditor for columns of the datatype TIME on any Cloudscape database. If the example above is also defined, this one would be called for any Cloudscape version other than 10.0 as for that one the example above would be called.

   <extension
         id=
"org.eclipse.wst.rdb.data.ui.defaultExternalTableDataEditor"

         name=
"Default External Table Data Editor"

         point=
"org.eclipse.wst.rdb.data.ui.externalTableDataEditor"
>
      <externalEditor 
            vendor=
"IBM Cloudscape"
 
            datatype=
"TIME"
 
            class=
"org.eclipse.wst.rdb.data.internal.ui.editor.CloudscapeExternalTableDataEditor"
/>
   </extension>

Copyright (c) 2005 IBM Corporation and others.
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

External Table Data Editors

Identifier:

Since:

Description:

Configuration Markup:

Examples: