org.eclipse.birt.data.oda.util.manifest
Class DtpManifestExplorer

java.lang.Object
  org.eclipse.birt.data.oda.util.manifest.DtpManifestExplorer

public class DtpManifestExplorer

extends java.lang.Object

The DTP Manifest Explorer is the entry point to explore and access the DTP ODA manifest of all the ODA plug-ins extensions that implement the org.eclipse.birt.data.oda.dataSource or org.eclipse.datatools.connectivity.oda.dataSource extension point. The DtpManifestExplorer singleton instance can be retrieved using the getInstance() method.
This provides a migration path to BIRT components to adopt the DTP ODA manifest package, and covers backward compatibilty to support both BIRT and DTP ODA extensions.

Method Summary

java.util.Properties	getDataSourceIdentifiers() Returns a collection of identifiers of all ODA data source extensions (both BIRT and DTP).
org.eclipse.datatools.connectivity.oda.util.manifest.ExtensionManifest	getExtensionManifest(java.lang.String extensionId) Returns the DTP ODA extension configuration information found in the plugin manifest file of the specified data source extension.
org.eclipse.datatools.connectivity.oda.util.manifest.ExtensionManifest[]	getExtensionManifests() Returns an array of ODA extension configuration information found in the plugin manifest file.
static DtpManifestExplorer	getInstance() Singleton getter method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static DtpManifestExplorer getInstance()

Singleton getter method.

Returns:

singleton instance of the class.

getDataSourceIdentifiers

public java.util.Properties getDataSourceIdentifiers()

Returns a collection of identifiers of all ODA data source extensions (both BIRT and DTP). The extension's data source element ID and display name are stored as the key and value in the returned Properties instance. Returns an empty Properties if there are no data source extensions found.

Returns:

a Properties containing the id and display name of all data source extensions.

getExtensionManifest

public org.eclipse.datatools.connectivity.oda.util.manifest.ExtensionManifest getExtensionManifest(java.lang.String extensionId)
                                                                                            throws org.eclipse.datatools.connectivity.oda.OdaException

Returns the DTP ODA extension configuration information found in the plugin manifest file of the specified data source extension. Includes extension that implements either the org.eclipse.birt.data.oda.dataSource or org.eclipse.datatools.connectivity.oda.dataSource extension points.

Parameters:

extensionId - the unique id of the data source element in a data source extension.

Returns:

the DTP ODA extension manifest information.

Throws:

java.lang.IllegalArgumentException - if no ODA driver plugin supports the data source extension ID.

org.eclipse.datatools.connectivity.oda.OdaException - if the extension manifest is invalid.

getExtensionManifests

public org.eclipse.datatools.connectivity.oda.util.manifest.ExtensionManifest[] getExtensionManifests()

Returns an array of ODA extension configuration information found in the plugin manifest file. Includes extensions that implement either the org.eclipse.birt.data.oda.dataSource, or the org.eclipse.datatools.connectivity.oda.dataSource extension points with at least one valid dataSet element defined. Returns an empty array if there are no data source extensions found. Invalid data source extension definitions are ignored.

Returns:

a DTP ODA ExtensionManifest array containing the definition of all valid ODA data source extensions.