org.eclipse.datatools.connectivity.oda.design.ui.designsession
Class DesignSessionUtil

java.lang.Object
  org.eclipse.datatools.connectivity.oda.design.ui.designsession.DesignSessionUtil

public class DesignSessionUtil

extends java.lang.Object

An utility class to help an ODA host designer or an ODA driver's customized designer to manipulate ODA Design API objects during an ODA design session.

Method Summary

static Properties	createDataSourceNonPublicProperties(java.lang.String odaDataSourceId, java.util.Properties utilProps) Creates an ODA design property collection for those given properties that are not defined in an ODA runtime extension manifest.
static Properties	createDataSourcePublicProperties(java.lang.String odaDataSourceId, java.util.Properties utilProps) Creates an ODA design property collection for the public properties defined in an ODA runtime extension manifest.
static IConnectionProfile	getLinkedProfile(DataSourceDesign dataSourceDesign) Returns the connection profile instance externally referenced, i.e.

Methods inherited from class java.lang.Object

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

Method Detail

createDataSourcePublicProperties

public static Properties createDataSourcePublicProperties(java.lang.String odaDataSourceId,
                                                          java.util.Properties utilProps)
                                                   throws OdaException

Creates an ODA design property collection for the public properties defined in an ODA runtime extension manifest. Their corresponding values are collected from the given profile property collection.

Parameters:

odaDataSourceId - the ODA extension data source element ID

utilProps - java.util.properties, such as those collected from a connection profile

Returns:

ODA design public property collection for inclusion in an OdaDesignSession's Data Source Design

Throws:

OdaException

createDataSourceNonPublicProperties

public static Properties createDataSourceNonPublicProperties(java.lang.String odaDataSourceId,
                                                             java.util.Properties utilProps)
                                                      throws OdaException

Creates an ODA design property collection for those given properties that are not defined in an ODA runtime extension manifest. These are properties that are not publicly defined. Their corresponding values are collected from the given profile property collection.

Parameters:

odaDataSourceId - the ODA extension data source element ID

utilProps - a java.util.Properties collection, such as those collected from a connection profile

Returns:

ODA design non-public property collection for inclusion in an OdaDesignSession's Data Source Design

Throws:

OdaException

getLinkedProfile

public static IConnectionProfile getLinkedProfile(DataSourceDesign dataSourceDesign)
                                           throws OdaException

Returns the connection profile instance externally referenced, i.e. linked, by the given data source design.

Parameters:

dataSourceDesign -

Returns:

linked connection profile instance, or null if no external profile is referenced

Throws:

OdaException - if referenced connection profile is not found