DriverPropertyEditorDescriptor.InvalidID = Driver Property Editor descriptor is missing a valid ID

DriverPropertyEditorDescriptor.InvalidTargetTemplateID = Driver Property Editor descriptor is missing a valid target template ID

DriverPropertyEditorDescriptor.InvalidTargetPropertyId = Driver Property Editor descriptor is missing a valid target property ID

DriverPropertyEditorDescriptor.InvalidCustomPropertyEditorClass = Driver Property Editor descriptor is missing a valid custom property editor

import org.eclipse.datatools.connectivity.internal.ui.drivers.DriverPropertyEditorDescriptor;

					DriverPropertyEditorDescriptor[] dpeds =

						DriverPropertyEditorDescriptor.getByDriverTemplateAndProperty(descriptor.getId(), id);

					if (dpeds != null && dpeds.length > 0) {

						ctceClass = dpeds[0].getCustomPropertyEditor();

						ice = dpeds[0].getElement();

					}

   <extension-point id="driverPropertyEditor" name="Driver Property Editor" schema="schema/driverPropertyEditor.exsd"/>

/*******************************************************************************

 * Copyright (c) 2004-2007 Sybase, Inc.

 * 

 * 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

 * 

 * Contributors: brianf - initial API and implementation

 ******************************************************************************/

package org.eclipse.datatools.connectivity.internal.ui.drivers;

import org.eclipse.core.runtime.IConfigurationElement;

import org.eclipse.core.runtime.ISafeRunnable;

import org.eclipse.datatools.connectivity.internal.ConnectivityPlugin;

/**

 * Safe runnable to handle creating the descriptor

 * @author brianf

 */

public class MySafeRunnable implements ISafeRunnable {

	private DriverPropertyEditorDescriptor[] mInstances = null;

	private IConfigurationElement mElement = null;

	/*

	 * Constructor

	 * @param instances

	 * @param element

	 */

	public MySafeRunnable ( DriverPropertyEditorDescriptor[] instances, IConfigurationElement element ) {

		this.mInstances = instances;

		this.mElement = element;

	}

	/* (non-Javadoc)

	 * @see org.eclipse.core.runtime.ISafeRunnable#handleException(java.lang.Throwable)

	 */

	public void handleException(Throwable exception) {

		ConnectivityPlugin.getDefault().log(exception);

	}

	/* (non-Javadoc)

	 * @see org.eclipse.core.runtime.ISafeRunnable#run()

	 */

	public void run() throws Exception {

		if (this.mInstances != null)

			this.mInstances[0] = new DriverPropertyEditorDescriptor(this.mElement);

	}

}

/*******************************************************************************

 * Copyright (c) 2004-2007 Sybase, Inc.

 * 

 * 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

 * 

 * Contributors: brianf - initial API and implementation

 ******************************************************************************/

package org.eclipse.datatools.connectivity.internal.ui.drivers;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import org.eclipse.core.runtime.Assert;

import org.eclipse.core.runtime.IConfigurationElement;

import org.eclipse.core.runtime.IExtensionRegistry;

import org.eclipse.core.runtime.Platform;

import org.eclipse.core.runtime.SafeRunner;

import org.eclipse.datatools.connectivity.internal.ui.ConnectivityUIPlugin;

import com.ibm.icu.text.Collator;

/**

 * Represents a way to specify a driver property descriptor which is provided by the

 * "org.eclipse.datatools.connectivity.ui.driverPropertyEditor" extension point.

 * 

 * @author brianf

 */

public class DriverPropertyEditorDescriptor implements Comparable {

	// extension details

	public static final String PROPERTY_EDITOR_TAG = "propertyEditor";//$NON-NLS-1$

	private static final String EXTENSION_POINT_NAME = "driverPropertyEditor"; //$NON-NLS-1$

	// attributes

	public static final String ATTR_ID = "driverTemplateID"; //$NON-NLS-1$

	public static final String ATTR_TEMPLATE_ID = "driverTemplateID"; //$NON-NLS-1$

	public static final String ATTR_PROP_ID = "driverPropertyID"; //$NON-NLS-1$

	public static final String ATTR_PROPERTY_EDITOR = "customPropertyDescriptor"; //$NON-NLS-1$

	private static final DriverPropertyEditorDescriptor[] EMPTY = {};

	// local list of driver templates

	private static Map fgDriverPropertyEditorDescriptors;

	// local copy of configuration element

	private IConfigurationElement fElement;

	/**

	 * Creates a new driver property editor template descriptor for the given configuration

	 * element.

	 */

	protected DriverPropertyEditorDescriptor(IConfigurationElement element) {

		this.fElement = element;

		/*

		 * "An extension for extension-point

		 * org.eclipse.datatools.connectivity.driverExtension does not provide a

		 * valid ID");

		 */

		Assert.isNotNull(getId(), 

				ConnectivityUIPlugin.getDefault().getResourceString("DriverPropertyEditorDescriptor.InvalidID")); //$NON-NLS-1$

		Assert.isNotNull(getTargetTemplateId(), 

				ConnectivityUIPlugin.getDefault().getResourceString("DriverPropertyEditorDescriptor.InvalidTargetTemplateID")); //$NON-NLS-1$

		Assert.isNotNull(getTargetPropertyId(), 

				ConnectivityUIPlugin.getDefault().getResourceString("DriverPropertyEditorDescriptor.InvalidTargetPropertyId")); //$NON-NLS-1$

		Assert.isNotNull(getCustomPropertyEditor(), 

				ConnectivityUIPlugin.getDefault().getResourceString("DriverPropertyEditorDescriptor.InvalidCustomPropertyEditorClass")); //$NON-NLS-1$

	}

	/**

	 * Returns any driver property editor descriptors for the template/

	 * property ID combo.

	 * 

	 * @param driverTemplateId

	 * @param driverPropertyId

	 * @return

	 */

	public static DriverPropertyEditorDescriptor[] getByDriverTemplateAndProperty(String driverTemplateId, String driverPropertyId) {

		if (fgDriverPropertyEditorDescriptors == null) {

			IExtensionRegistry registry = Platform.getExtensionRegistry();

			IConfigurationElement[] elements = registry

					.getConfigurationElementsFor(ConnectivityUIPlugin

							.getDefault().getBundle().getSymbolicName(),

							EXTENSION_POINT_NAME);

			createDriverTemplateDescriptors(elements);

		}

		ArrayList descriptors = (ArrayList) fgDriverPropertyEditorDescriptors.get(driverTemplateId);

		ArrayList result = new ArrayList();

		if (descriptors != null) {

			Iterator iter = descriptors.iterator();

			while (iter.hasNext()) {

				DriverPropertyEditorDescriptor dped = (DriverPropertyEditorDescriptor) iter.next();

				if (dped.getTargetPropertyId().equals(driverPropertyId)) {

					result.add(dped);

				}

			}

		}

		return result != null ?

				(DriverPropertyEditorDescriptor[]) result.toArray(new DriverPropertyEditorDescriptor[result.size()]) : EMPTY;

	}

	/**

	 * Returns all contributed driver property editor descriptors.

	 */

	public static DriverPropertyEditorDescriptor[] getDriverPropertyEditorDescriptors() {

		if (fgDriverPropertyEditorDescriptors == null) {

			IExtensionRegistry registry = Platform.getExtensionRegistry();

			IConfigurationElement[] elements = registry

					.getConfigurationElementsFor(ConnectivityUIPlugin

							.getDefault().getBundle().getSymbolicName(),

							EXTENSION_POINT_NAME);

			createDriverTemplateDescriptors(elements);

		}

		return (DriverPropertyEditorDescriptor[]) fgDriverPropertyEditorDescriptors.values().toArray(new DriverPropertyEditorDescriptor[fgDriverPropertyEditorDescriptors.size()]);

	}

	/**

	 * Returns the property editor id.

	 */

	public String getId() {

		return this.fElement.getAttribute(ATTR_ID);

	}

	/**

	 * Returns the target property id

	 */

	public String getTargetPropertyId() {

		return this.fElement.getAttribute(ATTR_PROP_ID);

	}

	/**

	 * Returns the target template id

	 */

	public String getTargetTemplateId() {

		return this.fElement.getAttribute(ATTR_TEMPLATE_ID);

	}

	/**

	 * Returns the custom property editor class name

	 */

	public String getCustomPropertyEditor() {

		return this.fElement.getAttribute(ATTR_PROPERTY_EDITOR);

	}

	/**

	 * Returns the configuration element.

	 */

	public IConfigurationElement getElement() {

		return this.fElement;

	}

	/*

	 * Implements a method from IComparable

	 */

	public int compareTo(Object o) {

		if (o instanceof DriverPropertyEditorDescriptor)

			return Collator.getInstance().compare(getId(),

					((DriverPropertyEditorDescriptor) o).getId());

		return Integer.MIN_VALUE;

	}

	/**

	 * Creates the property editor descriptors.

	 */

	private static void createDriverTemplateDescriptors(

			IConfigurationElement[] elements) {

		fgDriverPropertyEditorDescriptors = new HashMap();

		for (int i = 0; i < elements.length; ++i) {

			final IConfigurationElement element = elements[i];

			if (PROPERTY_EDITOR_TAG.equals(element.getName())) {

				final DriverPropertyEditorDescriptor[] desc = new DriverPropertyEditorDescriptor[1];

				SafeRunner

						.run(new MySafeRunnable ( desc, element));

				if (desc[0] != null) {

					List descriptors = (List)fgDriverPropertyEditorDescriptors.get(desc[0].getTargetTemplateId());

					if (descriptors == null) {

						descriptors = new ArrayList(1);

						fgDriverPropertyEditorDescriptors.put(desc[0].getTargetTemplateId(), descriptors);

					}

					descriptors.add(desc[0]);

				}

			}

		}

	}

	/* (non-Javadoc)

	 * @see java.lang.Object#equals(java.lang.Object)

	 */

	public boolean equals(Object obj) {

		if (obj instanceof DriverPropertyEditorDescriptor) {

			DriverPropertyEditorDescriptor compare = (DriverPropertyEditorDescriptor) obj;

			return this.getId().equals(compare.getId());

		}

		return super.equals(obj);

	}

	/* (non-Javadoc)

	 * @see java.lang.Object#hashCode()

	 */

	public int hashCode() {

		if (this.getId() != null)

			return this.getId().hashCode();

		return super.hashCode();

	}

}

<?xml version='1.0' encoding='UTF-8'?>

<!-- Schema file written by PDE -->

<schema targetNamespace="org.eclipse.datatools.connectivity.ui">

<annotation>

      <appInfo>

         <meta.schema plugin="org.eclipse.datatools.connectivity.ui" id="driverPropertyEditor" name="Driver Property Editor"/>

      </appInfo>

      <documentation>

         [Enter description of this extension point.]

      </documentation>

   </annotation>

   <element name="extension">

      <complexType>

         <sequence>

            <element ref="propertyEditor" minOccurs="1" maxOccurs="unbounded"/>

         </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="propertyEditor">

      <complexType>

         <attribute name="id" type="string" use="required">

            <annotation>

               <documentation>

               </documentation>

            </annotation>

         </attribute>

         <attribute name="driverTemplateID" type="string" use="required">

            <annotation>

               <documentation>

                  Required. Provides the ID of the driver template the property descriptor editor should be used for.

               </documentation>

            </annotation>

         </attribute>

         <attribute name="driverPropertyID" type="string" use="required">

            <annotation>

               <documentation>

                  Required. Provides the ID of the driver property the editor should be used for.

               </documentation>

            </annotation>

         </attribute>

         <attribute name="customPropertyDescriptor" type="string">

            <annotation>

               <documentation>

                  Required. Provides a custom property descriptor that extends the class org.eclipse.ui.views.properties.PropertyDescriptor. An example of this is the class org.eclipse.datatools.connectivity.ui.PasswordTextPropertyDescriptor, which provides a property editor that masks the characters for a password property. Anything you can implement as a property descriptor for the Properties Viewer, you can use here. Or if you want to make the property values read-only, you can use org.eclipse.ui.views.properties.PropertyDescriptor directly.

Note that your property descriptor must implement a zero-argument constructor in order to be created correctly. This zero-argument constructor should provide the id and display name of the property you are editing. For example:

 private static String DRIVER_CLASS_PROP_ID = "org.eclipse.datatools.connectivity.db.driverClass"; //$NON-NLS-1$

 public DriverClassBrowsePropertyDescriptor() {

  super(DRIVER_CLASS_PROP_ID, 

    ConnectivityUIPlugin.getDefault().getResourceString("DriverClassBrowsePropertyDescriptor.property.label")); //$NON-NLS-1$

 }

Also note that there is a new interface that your Property Descriptor can extend called org.eclipse.datatools.connectivity.drivers.IDriverInstancePropertyDescriptor. This interface allows you to pass the Driver Instance to your descriptor when it is instantiated in the Edit Driver Definition dialog.

               </documentation>

               <appInfo>

                  <meta.attribute kind="java" basedOn="org.eclipse.ui.views.properties.PropertyDescriptor"/>

               </appInfo>

            </annotation>

         </attribute>

      </complexType>

   </element>

   <annotation>

      <appInfo>

         <meta.section type="since"/>

      </appInfo>

      <documentation>

         [Enter the first release in which this extension point appears.]

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="examples"/>

      </appInfo>

      <documentation>

         [Enter extension point usage example here.]

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="apiInfo"/>

      </appInfo>

      <documentation>

         [Enter API information here.]

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="implementation"/>

      </appInfo>

      <documentation>

         [Enter information about supplied implementation of this extension point.]

      </documentation>

   </annotation>

   <annotation>

      <appInfo>

         <meta.section type="copyright"/>

      </appInfo>

      <documentation>

      </documentation>

   </annotation>

</schema>