|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDataSetMetaData
Provides comprehensive information on the driver's capabilities for a type of data set query.
An ODA runtime driver can implement a connection
to work with one or more types of data sets.
Different types of data sets often support different features, and/or implement
features in different ways. In addition, a driver may implement
a feature on top of what the underlying data provider offers.
Information returned by methods in this interface applies to the capabilities
of a particular driver and a particular type of data set working together.
Note that as used in this documentation, the term "data set" is used
generically to refer to both the ODA runtime driver and underlying data provider.
A method that gets information about a feature not supported by the driver will throw an OdaException. This includes methods that return an IResultSet object.
Some methods may be called before the associated connection is opened, while other may require the associated connection to be opened. For example:
// connection is not opened
IDataSetMetaData metadata = connection.getMetaData( ... );
metadata.supportsInParameters();
connection.open();
metadata.getDataSourceObjects( ... ); // requires an opened connection
Field Summary | |
---|---|
static int |
sortModeColumnOrder
The constant indicating that each sorted column can have a different sort order. |
static int |
sortModeNone
The constant indicating that dynamic sorting is not supported. |
static int |
sortModeSingleColumn
The constant indicating that only one single column can be sorted. |
static int |
sortModeSingleOrder
The constant indicating that all sorted columns must be in the same sort order. |
static int |
sqlStateSQL99
The constant indicating that OdaException.getSQLState will
return a SQL99 SQLSTATE value. |
static int |
sqlStateXOpen
The constant indicating that OdaException.getSQLState will
return a X/Open SQL CLI SQLSTATE value. |
Method Summary | |
---|---|
IConnection |
getConnection()
Returns the connection that produced this metadata object. |
int |
getDataSourceMajorVersion()
Returns the major version number of the underlying data provider. |
int |
getDataSourceMinorVersion()
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)
Returns the collection of objects found in a data provider's catalog. |
java.lang.String |
getDataSourceProductName()
Returns the name of this data provider product. |
java.lang.String |
getDataSourceProductVersion()
Returns the version of this data provider product as a String . |
int |
getSortMode()
Returns the dynamic sorting mode supported by this data set type. |
int |
getSQLStateType()
Indicates whether the SQLSTATE returned by OdaException.getSQLState()
is X/Open SQL CLI or SQL99. |
boolean |
supportsInParameters()
Indicates whether this data set type supports input parameters in IQuery . |
boolean |
supportsMultipleOpenResults()
Indicates whether this data set type supports getting multiple IResultSet objects simultaneously,
in its IAdvancedQuery implementation. |
boolean |
supportsMultipleResultSets()
Indicates whether this data set type supports getting multiple IResultSet objects (sequentially or simultaneously),
in its IAdvancedQuery implementation. |
boolean |
supportsNamedParameters()
Indicates whether this data set type supports named parameters in IQuery . |
boolean |
supportsNamedResultSets()
Indicates whether this data set type supports getting one or more IResultSet objects by name,
in its IAdvancedQuery implementation. |
boolean |
supportsOutParameters()
Indicates whether this data set type supports output parameters in its IAdvancedQuery implementation. |
Field Detail |
---|
static final int sqlStateXOpen
OdaException.getSQLState
will
return a X/Open SQL CLI SQLSTATE value.
static final int sqlStateSQL99
OdaException.getSQLState
will
return a SQL99 SQLSTATE value.
static final int sortModeNone
static final int sortModeSingleOrder
static final int sortModeColumnOrder
static final int sortModeSingleColumn
Method Detail |
---|
IConnection getConnection() throws OdaException
OdaException
- if data source error occurs.IResultSet getDataSourceObjects(java.lang.String catalog, java.lang.String schema, java.lang.String object, java.lang.String version) throws OdaException
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.
OdaException
- if data source error occurs.int getDataSourceMajorVersion() throws OdaException
OdaException
- if data source error occurs.int getDataSourceMinorVersion() throws OdaException
OdaException
- if data source error occurs.java.lang.String getDataSourceProductName() throws OdaException
OdaException
- if data source error occurs.java.lang.String getDataSourceProductVersion() throws OdaException
String
.
OdaException
- if data source error occurs.int getSQLStateType() throws OdaException
OdaException.getSQLState()
is X/Open SQL CLI or SQL99.
OdaException
- if data source error occurs.boolean supportsMultipleResultSets() throws OdaException
IResultSet
objects (sequentially or simultaneously),
in its IAdvancedQuery
implementation.
IResultSet
objects; false otherwise.
OdaException
- if data source error occurs.boolean supportsMultipleOpenResults() throws OdaException
IResultSet
objects simultaneously,
in its IAdvancedQuery
implementation.
IResultSet
objects simultaneously; false otherwise.
OdaException
- if data source error occurs.boolean supportsNamedResultSets() throws OdaException
IResultSet
objects by name,
in its IAdvancedQuery
implementation.
IResultSet
objects by name; false otherwise.
OdaException
- if data source error occurs.boolean supportsNamedParameters() throws OdaException
IQuery
.
OdaException
- if data source error occurs.boolean supportsInParameters() throws OdaException
IQuery
.
OdaException
- if data source error occurs.boolean supportsOutParameters() throws OdaException
IAdvancedQuery
implementation.
OdaException
- if data source error occurs.int getSortMode()
sortModeNone
, sortModeSingleOrder
,
sortModeColumnOrder
, sortModeSingleColumn
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |