org.eclipse.birt.data.oda.impl
Class SimpleDataSetMetaData

java.lang.Object
  org.eclipse.birt.data.oda.impl.SimpleDataSetMetaData

All Implemented Interfaces:

IDataSetMetaData

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

public class SimpleDataSetMetaData

extends java.lang.Object

implements IDataSetMetaData

Default implementation of IDataSetMetaData for a simple ODA runtime driver.

Field Summary

Fields inherited from interface org.eclipse.birt.data.oda.IDataSetMetaData

sortModeColumnOrder, sortModeNone, sortModeSingleColumn, sortModeSingleOrder, sqlStateSQL99, sqlStateXOpen

Constructor Summary

protected

SimpleDataSetMetaData(IConnection connection) Deprecated.

Method Summary

IConnection	getConnection() Deprecated. Returns the connection that produced this metadata object.
int	getDataSourceMajorVersion() Deprecated. Returns the major version number of the underlying data provider.
int	getDataSourceMinorVersion() Deprecated. Returns the minor version number of the underlying data provider.
IResultSet	getDataSourceObjects(java.lang.String catalog, java.lang.String schema, java.lang.String object, java.lang.String version) Deprecated. Returns the collection of objects found in a data provider's catalog.
java.lang.String	getDataSourceProductName() Deprecated. Returns the name of this data provider product.
java.lang.String	getDataSourceProductVersion() Deprecated. Returns the version of this data provider product as a String.
int	getSortMode() Deprecated. Returns the dynamic sorting mode supported by this data set type.
int	getSQLStateType() Deprecated. Indicates whether the SQLSTATE returned by OdaException.getSQLState() is X/Open SQL CLI or SQL99.
boolean	supportsInParameters() Deprecated. Indicates whether this data set type supports input parameters in IQuery.
boolean	supportsMultipleOpenResults() Deprecated. Indicates whether this data set type supports getting multiple IResultSet objects simultaneously, in its IAdvancedQuery implementation.
boolean	supportsMultipleResultSets() Deprecated. Indicates whether this data set type supports getting multiple IResultSet objects (sequentially or simultaneously), in its IAdvancedQuery implementation.
boolean	supportsNamedParameters() Deprecated. Indicates whether this data set type supports named parameters in IQuery.
boolean	supportsNamedResultSets() Deprecated. Indicates whether this data set type supports getting one or more IResultSet objects by name, in its IAdvancedQuery implementation.
boolean	supportsOutParameters() Deprecated. Indicates whether this data set type supports output parameters in its IAdvancedQuery implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDataSetMetaData

protected SimpleDataSetMetaData(IConnection connection)

Deprecated.

Method Detail

getConnection

public IConnection getConnection()
                          throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Returns the connection that produced this metadata object.

Specified by:

getConnection in interface IDataSetMetaData

Returns:

the connection that produced this metadata object.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.getConnection()

getDataSourceObjects

public IResultSet getDataSourceObjects(java.lang.String catalog,
                                       java.lang.String schema,
                                       java.lang.String object,
                                       java.lang.String version)
                                throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Returns the collection of objects found in a data provider's catalog. Valid arguments to this method are implementation-dependent.
An optional method.

Specified by:

getDataSourceObjects in interface IDataSetMetaData

Parameters:

catalog - data provider's catalog.

schema - search pattern for the data provider's schema or owner name; could be left empty if not applicable to the connected data provider.

object - search pattern for the data provider's object name.

version - data provider's objects version.

Returns:

an IResultSet object describing the data provider's objects.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.getDataSourceObjects(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getDataSourceMajorVersion

public int getDataSourceMajorVersion()
                              throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Returns the major version number of the underlying data provider.

Specified by:

getDataSourceMajorVersion in interface IDataSetMetaData

Returns:

the major version number.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.getDataSourceMajorVersion()

getDataSourceMinorVersion

public int getDataSourceMinorVersion()
                              throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Returns the minor version number of the underlying data provider.

Specified by:

getDataSourceMinorVersion in interface IDataSetMetaData

Returns:

the minor version number.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.getDataSourceMinorVersion()

getDataSourceProductName

public java.lang.String getDataSourceProductName()
                                          throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Returns the name of this data provider product.

Specified by:

getDataSourceProductName in interface IDataSetMetaData

Returns:

data provider product name.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.getDataSourceProductName()

getDataSourceProductVersion

public java.lang.String getDataSourceProductVersion()
                                             throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Returns the version of this data provider product as a String.

Specified by:

getDataSourceProductVersion in interface IDataSetMetaData

Returns:

data provider product version.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.getDataSourceProductVersion()

getSQLStateType

public int getSQLStateType()
                    throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Indicates whether the SQLSTATE returned by OdaException.getSQLState() is X/Open SQL CLI or SQL99.
An optional method.

Specified by:

getSQLStateType in interface IDataSetMetaData

Returns:

the type of SQLSTATE;
one of sqlStateXOpen,
sqlStateSQL99.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.getSQLStateType()

supportsMultipleResultSets

public boolean supportsMultipleResultSets()
                                   throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Indicates whether this data set type supports getting multiple IResultSet objects (sequentially or simultaneously), in its IAdvancedQuery implementation.

Specified by:

supportsMultipleResultSets in interface IDataSetMetaData

Returns:

true if this data set supports getting multiple IResultSet objects; false otherwise.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.supportsMultipleResultSets()

supportsMultipleOpenResults

public boolean supportsMultipleOpenResults()
                                    throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Indicates whether this data set type supports getting multiple IResultSet objects simultaneously, in its IAdvancedQuery implementation.

Specified by:

supportsMultipleOpenResults in interface IDataSetMetaData

Returns:

true if this data set supports getting multiple IResultSet objects simultaneously; false otherwise.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.supportsMultipleOpenResults()

supportsNamedResultSets

public boolean supportsNamedResultSets()
                                throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Indicates whether this data set type supports getting one or more IResultSet objects by name, in its IAdvancedQuery implementation.

Specified by:

supportsNamedResultSets in interface IDataSetMetaData

Returns:

true if this data set supports getting one or more IResultSet objects by name; false otherwise.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.supportsNamedResultSets()

supportsNamedParameters

public boolean supportsNamedParameters()
                                throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Indicates whether this data set type supports named parameters in IQuery.

Specified by:

supportsNamedParameters in interface IDataSetMetaData

Returns:

true if named parameters are supported; false otherwise.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.supportsNamedParameters()

supportsInParameters

public boolean supportsInParameters()
                             throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Indicates whether this data set type supports input parameters in IQuery.

Specified by:

supportsInParameters in interface IDataSetMetaData

Returns:

true if input parameters are supported; false otherwise.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.supportsInParameters()

supportsOutParameters

public boolean supportsOutParameters()
                              throws OdaException

Deprecated.

Description copied from interface: IDataSetMetaData

Indicates whether this data set type supports output parameters in its IAdvancedQuery implementation.

Specified by:

supportsOutParameters in interface IDataSetMetaData

Returns:

true if output parameters are supported; false otherwise.

Throws:

OdaException - if data source error occurs.

See Also:

IDataSetMetaData.supportsOutParameters()

getSortMode

public int getSortMode()

Deprecated.

Description copied from interface: IDataSetMetaData

Returns the dynamic sorting mode supported by this data set type.

Specified by:

getSortMode in interface IDataSetMetaData

Returns:

the dynamic sorting mode supported by the data soruce; one of sortModeNone, sortModeSingleOrder, sortModeColumnOrder, sortModeSingleColumn

See Also:

IDataSetMetaData.getSortMode()