|
||||||||||
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.ExtensionManifest
public class ExtensionManifest
Encapsulates access to the content of an ODA data source plug-in extension manifest.
Field Summary | |
---|---|
static java.lang.String |
CLASS_ATTRIBUTE_NAME
|
Method Summary | |
---|---|
DataSetType |
getDataSetType(java.lang.String dataSetElementID)
Returns the DataSetType instance that represents the dataSet element with the given ID defined in this data source extension. |
int |
getDataSetTypeCount()
Returns the number of data set types defined in this ODA data source extension. |
java.lang.String[] |
getDataSetTypeIDs()
Returns an array of ids of the dataSet elements defined in this data source extension. |
DataSetType[] |
getDataSetTypes()
Returns an array of DataSetType instances that represent the dataSet elements defined in this data source extension. |
java.lang.String |
getDataSourceDisplayName()
Returns the display name of the data source element defined in the ODA data source extension. |
org.eclipse.core.runtime.IConfigurationElement |
getDataSourceElement()
Returns the configuration element of this extension's data source element. |
java.lang.String |
getDataSourceElementID()
Returns the ID that uniquely identifies the dataSource element defined in the ODA data source extension. |
java.net.URL |
getDriverLocation()
Returns the driver installation location. |
java.lang.String |
getExtensionID()
Returns the ID that uniquely identifies this ODA data source extension in an ODA consumer application's environment. |
Property[] |
getHiddenProperties()
A convenience method to return an array of Property definition instances that represent the properties defined as hidden by this data source extension. |
java.lang.String |
getNamespace()
Returns the namespace of the plugin that contributes this ODA runtime extension. |
java.lang.String |
getOdaVersion()
Returns the version of the org.eclipse.datatools.connectivity.oda interfaces for which this driver is developed. |
Property[] |
getProperties()
Returns an array of Property definition instances that represent all the properties defined and inherited by this data source extension. |
Property[] |
getProperties(boolean includeInheritedProps)
Returns an array of Property definition instances that represent all the properties defined by this data source extension, plus optionally include inherited ones. |
java.util.Properties |
getPropertiesVisibility()
Returns a Properties collecton of property visibilty settings. |
Property |
getProperty(java.lang.String propertyName)
Returns the Property definition instance that matches the specified name in the list of properties defined by this data source extension. |
java.lang.String |
getRelatedDataSourceId()
Deprecated. As of 3.1.2, replaced by getRelationships(int) |
java.util.List<org.eclipse.datatools.connectivity.oda.util.manifest.Relationship> |
getRelationships(int relationshipType)
Returns a list of data source relationships defined with the specified type. |
RuntimeInterface |
getRuntimeInterface()
Returns the runtime interface configuration. |
TraceLogging |
getTraceLogging()
Returns the optional trace logging configuration for the driver. |
Property[] |
getVisibleProperties()
A convenience method to return an array of Property definition instances that represent the properties defined as visible by this data source extension. |
boolean |
isDeprecated()
Indicates whether this extension is defined to be deprecated. |
boolean |
isWrapper()
Indicates whether this extension is defined to be a wrapper. |
boolean |
overrideFiltering()
Indicates whether the visibility of this extension should override that of the filtering by the ODA extension explorer. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_ATTRIBUTE_NAME
Method Detail |
---|
public java.lang.String getNamespace()
public java.lang.String getExtensionID()
public java.lang.String getDataSourceElementID()
public org.eclipse.core.runtime.IConfigurationElement getDataSourceElement()
public java.net.URL getDriverLocation() throws java.io.IOException
java.io.IOException
- if an IO error occurs.public java.lang.String getOdaVersion()
public java.lang.String getDataSourceDisplayName()
public DataSetType[] getDataSetTypes()
public java.lang.String[] getDataSetTypeIDs()
public int getDataSetTypeCount()
public DataSetType getDataSetType(java.lang.String dataSetElementID) throws OdaException
dataSetElementID
- the id of the data set element.
OdaException
- if there is no data set definition associated
with the specified data set element ID, or
if there are more than one data set elements
that match the ID.public TraceLogging getTraceLogging()
public RuntimeInterface getRuntimeInterface()
public Property[] getProperties()
public Property[] getProperties(boolean includeInheritedProps)
includeInheritedProps
- indicates whether to include
property definitions inherited from the ODA framework
public Property[] getVisibleProperties()
public Property[] getHiddenProperties()
public Property getProperty(java.lang.String propertyName)
propertyName
- the name of a property
public java.util.Properties getPropertiesVisibility()
public boolean isDeprecated()
public boolean isWrapper()
public java.lang.String getRelatedDataSourceId()
getRelationships(int)
public java.util.List<org.eclipse.datatools.connectivity.oda.util.manifest.Relationship> getRelationships(int relationshipType)
relationshipType
- constant for the type of relationship
Relationship.TYPE_* constants}
public boolean overrideFiltering()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |