org.eclipse.birt.data.oda
Interface IConnection

All Known Implementing Classes:

SimpleConnection

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

public interface IConnection

A data source connection interface used to establish a connection to the underlying data provider.

Method Summary

void	close() Deprecated. Attempts to close this connection.
void	commit() Deprecated. Commits all changes made since the previous commit/rollback.
int	getMaxQueries() Deprecated. Returns the maximum number of active queries for any data set types that the driver can support for this connection.
IDataSetMetaData	getMetaData(java.lang.String dataSetType) Deprecated. Returns an IDataSetMetaData object of the the given data set type.
boolean	isOpen() Deprecated. Checks whether this has an established connection
IQuery	newQuery(java.lang.String dataSetType) Deprecated. Returns an IQuery object of the given data set type.
void	open(java.util.Properties connProperties) Deprecated. Attempts to establish a connection based on the given connection properties.
void	rollback() Deprecated. Undoes all changes made since the previous commit/rollback.

Method Detail

open

public void open(java.util.Properties connProperties)
          throws OdaException

Deprecated.

Attempts to establish a connection based on the given connection properties. The connection property "OdaDriverDir" is always passed as a service to drivers; its property value is the directory where the ODA runtime driver is installed. It is up to the individual ODA driver to process this property.

Parameters:

connProperties - Properties necessary to establish a connection.

Throws:

OdaException - if data source error occurs.

close

public void close()
           throws OdaException

Deprecated.

Attempts to close this connection.

Throws:

OdaException - if data source error occurs.

isOpen

public boolean isOpen()
               throws OdaException

Deprecated.

Checks whether this has an established connection

Returns:

true if connection is established.

Throws:

OdaException - if data source error occurs.

getMetaData

public IDataSetMetaData getMetaData(java.lang.String dataSetType)
                             throws OdaException

Deprecated.

Returns an IDataSetMetaData object of the the given data set type. The data set type is implementation-dependent. This can be called before this IConnection is opened; however some IDataSetMetaData methods expects and requires an opened connection before being called, e.g. getDataSourceObjects().

Parameters:

dataSetType - String representation of a data set type.

Returns:

an IDataSetMetaData object.

Throws:

OdaException - if data source error occurs.

newQuery

public IQuery newQuery(java.lang.String dataSetType)
                throws OdaException

Deprecated.

Returns an IQuery object of the given data set type. The data set type is implementation-dependent.

Parameters:

dataSetType - String representation of a data set type.

Returns:

an IQuery object.

Throws:

OdaException - if data source error occurs.

getMaxQueries

public int getMaxQueries()
                  throws OdaException

Deprecated.

Returns the maximum number of active queries for any data set types that the driver can support for this connection.

Returns:

the maximum number of any type of queries that can be prepared and executed concurrently, or 0 if there is no limit or the limit is unknown.

Throws:

OdaException - if driver error occurs.

commit

public void commit()
            throws OdaException

Deprecated.

Commits all changes made since the previous commit/rollback.
An optional method.

Throws:

OdaException - if data source error occurs.

rollback

public void rollback()
              throws OdaException

Deprecated.

Undoes all changes made since the previous commit/rollback.
An optional method.

Throws:

OdaException - if data source error occurs.