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

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

Deprecated. As of BIRT 2.0, replaced by org.eclipse.datatools.connectivity.oda.util.manifest.ManifestExplorer .
The BIRT ODA run-time framework has been migrated to the Eclipse Data Tools Platform (DTP) project.

public class ManifestExplorer

extends java.lang.Object

The Manifest Explorer is the entry point to explore and access the BIRT 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 ManifestExplorer singleton instance can be retrieved using the getInstance() method.

Method Summary

java.util.Properties	getDataSourceIdentifiers() Deprecated. Returns a collection of identifiers of all ODA data source extensions.
ExtensionManifest	getExtensionManifest(java.lang.String extensionId) Deprecated. Returns the extension configuration information found in the plugin manifest file of the specified data source extension.
ExtensionManifest[]	getExtensionManifests() Deprecated. Returns an array of ODA extension configuration information found in the plugin manifest file.
static ManifestExplorer	getInstance() Deprecated. Gets the ManifestExplorer instance to explore the manifest of the data source extensions.
static void	releaseInstance() Deprecated. Singleton instance release method.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ManifestExplorer getInstance()

Deprecated.

Gets the ManifestExplorer instance to explore the manifest of the data source extensions.

Returns:

the ManifestExplorer instance.

releaseInstance

public static void releaseInstance()

Deprecated.

Singleton instance release method.

getDataSourceIdentifiers

public java.util.Properties getDataSourceIdentifiers()

Deprecated.

Returns a collection of identifiers of all ODA data source extensions. 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 ExtensionManifest getExtensionManifest(java.lang.String extensionId)
                                       throws OdaException

Deprecated.

Returns the 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 extension manifest information.

Throws:

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

OdaException - if the extension manifest is invalid.

getExtensionManifests

public ExtensionManifest[] getExtensionManifests()

Deprecated.

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

Returns:

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