|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.datatools.connectivity.oda.util.manifest.ManifestExplorer
public class ManifestExplorer
The Manifest Explorer is the entry point to explore and access
the manifest of all the ODA plug-ins extensions that implement the
org.eclipse.datatools.connectivity.oda.dataSource
extension point.
The ManifestExplorer
singleton instance is retrieved
using the getInstance()
method.
Nested Class Summary | |
---|---|
class |
ManifestExplorer.Filter
Filtering options for the manifest explorer to apply when retrieving a collection of ODA data source extension manifests. |
Method Summary | |
---|---|
static ManifestExplorer.Filter |
createFilter()
Instantiates a new Filter object for the manifest explorer to apply when retrieving a collection of ODA data source extension manifests. |
java.util.Properties |
getDataSourceIdentifiers()
Returns a collection of identifiers of all ODA data source extensions. |
java.util.Properties |
getDataSourceIdentifiers(ManifestExplorer.Filter dataSourceFilter)
Returns a collection of identifiers of all ODA data source extensions that meet the specified filter criteria. |
int |
getDefaultOdaDataTypeCode(int nativeTypeCode,
java.lang.String odaDataSourceId,
java.lang.String dataSetType)
Converts the specified native data type code to its default ODA data type code, based on the data type mapping defined by the specified ODA data source and data set types. |
ExtensionManifest |
getExtensionManifest(java.lang.String dataSourceId)
Returns the extension configuration information found in the plugin manifest file of the data source extension that contains the specified data source element and implements the DTP ODA run-time extension point - org.eclipse.datatools.connectivity.oda.dataSource. |
ExtensionManifest |
getExtensionManifest(java.lang.String dataSourceId,
java.lang.String extensionPoint)
Returns the extension configuration information found in the plugin manifest file of the data source extension that contains the specified data source element and implements the specified ODA extension point. |
ExtensionManifest[] |
getExtensionManifests()
Returns an array of DTP ODA dataSource extension configuration information found in corresponding plugin manifest file. |
ExtensionManifest[] |
getExtensionManifests(boolean includesAllExtensions)
Deprecated. As of DTP 1.0, replaced by getExtensionManifests(String, org.eclipse.datatools.connectivity.oda.util.manifest.ManifestExplorer.Filter) |
ExtensionManifest[] |
getExtensionManifests(ManifestExplorer.Filter collectionFilter)
Returns an array of DTP ODA dataSource extension configuration information of those extensions that implement the DTP ODA extension point and meet the filter criteria. |
ExtensionManifest[] |
getExtensionManifests(java.lang.String extensionPoint)
Returns an array of ODA dataSource extension configuration information of those extensions that implement the specified extension point. |
ExtensionManifest[] |
getExtensionManifests(java.lang.String extensionPoint,
boolean includesAllExtensions)
Deprecated. As of DTP 1.0, replaced by getExtensionManifests(String, org.eclipse.datatools.connectivity.oda.util.manifest.ManifestExplorer.Filter) |
ExtensionManifest[] |
getExtensionManifests(java.lang.String extensionPoint,
ManifestExplorer.Filter collectionFilter)
Returns an array of ODA dataSource extension configuration information of those extensions that implement the specified extension point and meet the filter criteria. |
static org.eclipse.core.runtime.IExtension[] |
getExtensions(java.lang.String extPoint)
|
static ManifestExplorer |
getInstance()
Gets the ManifestExplorer instance to
explore the manifest of the data source extensions. |
void |
refresh()
Refresh the manifest explorer, and allows it to get the latest ODA extension manifests. |
static void |
releaseInstance()
Singleton instance release method. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static ManifestExplorer getInstance()
ManifestExplorer
instance to
explore the manifest of the data source extensions.
ManifestExplorer
instance.public static void releaseInstance()
public void refresh()
public java.util.Properties getDataSourceIdentifiers()
Properties
containing the id and display name
of all ODA data source extensions.
May be an empty collection if no data source extensions are found.public java.util.Properties getDataSourceIdentifiers(ManifestExplorer.Filter dataSourceFilter)
collectionFilter
- specifies the types of extension to exclude in
the returned collection;
may be null if no filtering is needed
Properties
containing the id and display name
of all ODA data source extensions that meet the specified filter criteria.
May be an empty collection if no data source extensions are found.public ExtensionManifest getExtensionManifest(java.lang.String dataSourceId) throws OdaException
dataSourceId
- the unique id of the data source element
in a data source extension.
OdaException
- if the extension manifest is invalid.
java.lang.IllegalArgumentException
- if no extension is found.public ExtensionManifest getExtensionManifest(java.lang.String dataSourceId, java.lang.String extensionPoint) throws OdaException
dataSourceId
- the unique id of the data source element
in a data source extension.extensionPoint
- the id of the extension point to search
OdaException
- if the extension manifest is invalid.
java.lang.IllegalArgumentException
- if no argument(s) are specifiedpublic ExtensionManifest[] getExtensionManifests()
ExtensionManifest
array containing
the definition of all matching ODA data source extensions.public ExtensionManifest[] getExtensionManifests(ManifestExplorer.Filter collectionFilter)
collectionFilter
- specifies the types of extensions to exclude in
the returned collection;
may be null if no filtering is needed
ExtensionManifest
array containing
the definition of all matching ODA data source extensions.public ExtensionManifest[] getExtensionManifests(java.lang.String extensionPoint)
extensionPoint
- name of an ODA data source extension point
ExtensionManifest
array containing
the definition of all matching ODA data source extensions.public ExtensionManifest[] getExtensionManifests(boolean includesAllExtensions)
getExtensionManifests(String, org.eclipse.datatools.connectivity.oda.util.manifest.ManifestExplorer.Filter)
includesAllExtensions
- true to return all matching extensions,
including those with no valid dataSet element defined;
false to include only those matching extensions
with at least one valid dataSet element defined
ExtensionManifest
array containing
the definition of all matching ODA data source extensions.public ExtensionManifest[] getExtensionManifests(java.lang.String extensionPoint, boolean includesAllExtensions)
getExtensionManifests(String, org.eclipse.datatools.connectivity.oda.util.manifest.ManifestExplorer.Filter)
extensionPoint
- name of an ODA data source extension pointincludesAllExtensions
- true to return all matching extensions,
including those with no valid dataSet element defined;
false to include only those matching extensions
with at least one valid dataSet element defined
ExtensionManifest
array containing
the definition of all matching ODA data source extensions.public ExtensionManifest[] getExtensionManifests(java.lang.String extensionPoint, ManifestExplorer.Filter collectionFilter)
extensionPoint
- name of an ODA data source extension pointcollectionFilter
- specifies the types of extensions to exclude in
the returned collection;
may be null if no filtering is needed
ExtensionManifest
array containing
the definition of all matching ODA data source extensions.public static org.eclipse.core.runtime.IExtension[] getExtensions(java.lang.String extPoint)
public int getDefaultOdaDataTypeCode(int nativeTypeCode, java.lang.String odaDataSourceId, java.lang.String dataSetType)
nativeTypeCode
- native type code specific to the ODA data sourceodaDataSourceId
- the ODA data source element iddataSetType
- the type of data set
public static ManifestExplorer.Filter createFilter()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |