org.eclipse.datatools.connectivity.oda.design.ui.manifest
Class DataSetUIElement

java.lang.Object
  org.eclipse.datatools.connectivity.oda.design.ui.manifest.DataSetUIElement

public class DataSetUIElement

extends java.lang.Object

Represents the definition of customized data set designer that an ODA data provider extends to allow an user to create or edit an ODA data set design instance. This encapsulates the child elements for the data set wizard page(s) and editor page(s).

Method Summary

java.lang.String	getId() Returns the fully qualified ID that uniquely identifies the ODA data set type within an ODA data source extension.
java.lang.String	getInitialPageId() Returns the id of a dataSetPage that should be selected and have initial focus in a preference dialog.
DataSetPageInfo	getPageDefinition(java.lang.String pageId) Returns the DataSetPageInfo instance that represents the dataSetPage element with the given id defined in this data set ui element.
DataSetPageInfo[]	getPageDefinitions() Returns an array of definitions of customized data set pages that an extension contributes to an ODA host designer's data set dialog.
java.lang.String[]	getPageIds() Returns an array of ids of the dataSetPage elements defined in this data set ui element.
DataSetWizardInfo	getWizardInfo() Returns the definition of a data set wizard that allows an user to create a new ODA data set design instance.
boolean	hasParameterDefinition() Indicates whether this type of data set design tends to have data set parameters defined, and an ODA host designer might need to collect further metadata on the parameter definitions provided by the customized page(s).

Methods inherited from class java.lang.Object

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

Method Detail

getId

public java.lang.String getId()

Returns the fully qualified ID that uniquely identifies the ODA data set type within an ODA data source extension. Its value must match that of the dataSet.id attribute defined in the org.eclipse.datatools.connectivity.oda.dataSource extension of the same ODA driver.

Returns:

the attribute value in dataSetUI.id

getInitialPageId

public java.lang.String getInitialPageId()

Returns the id of a dataSetPage that should be selected and have initial focus in a preference dialog.

Returns:

the attribute value in dataSetUI.initialPageId; may be null if none is specified

hasParameterDefinition

public boolean hasParameterDefinition()

Indicates whether this type of data set design tends to have data set parameters defined, and an ODA host designer might need to collect further metadata on the parameter definitions provided by the customized page(s).

Returns:

the attribute value in dataSetUI.hasParameterDefinition

getWizardInfo

public DataSetWizardInfo getWizardInfo()

Returns the definition of a data set wizard that allows an user to create a new ODA data set design instance.

Returns:

the wizard definition that represents the dataSetUI.newDataSetWizard element

getPageDefinitions

public DataSetPageInfo[] getPageDefinitions()

Returns an array of definitions of customized data set pages that an extension contributes to an ODA host designer's data set dialog.

Returns:

an array of data set page definitions that represent the dataSetUI.dataSetPage elements

getPageIds

public java.lang.String[] getPageIds()

Returns an array of ids of the dataSetPage elements defined in this data set ui element.

Returns:

an array of data set page ids.

getPageDefinition

public DataSetPageInfo getPageDefinition(java.lang.String pageId)
                                  throws OdaException

Returns the DataSetPageInfo instance that represents the dataSetPage element with the given id defined in this data set ui element. If the given page id is null and the data set UI extension has only one data set page element, that data set page will be returned by default.

Returns:

the data set page definition

Throws:

OdaException - if there is no data set page definition associated with the specified data set page id, or if there are more than one data set pages that match the id.