|
SAP BI Java SDK | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Serves as an entry point to interfaces that support access to
relational metadata and queries. This interface, retrieved
from IBIConnection
, is implemented by all relational connectors.
It provides relational data source functionality such as retrieval of
metadata, creation of the query, and retrieval of the result set.
Every relational connector needs to implement this interface in order to
support the functionality specified in it.
Inner Class Summary | |
static class |
IBIRelational.Supports
Returns true or false , depending on what kind
of features the relational provider supports. |
Field Summary | |
static com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType |
ALIAS
ALIAS is used in the find interface to restrict the tables by their type. |
static com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType |
GLOBAL_TEMPRARY
GLOBAL_TEMPORARY is used in the find interface to restrict the tables by their type. |
static com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType |
LOCAL_TEMPORARY
LOCAL_TEMPORARY is used in the find interface to restrict the tables by their type. |
static com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType |
SYNONYM
SYNONYM is used in the find interface to restrict the tables by their type. |
static com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType |
SYSTEM_TABLE
SYSTEM_TABLE is used in the find interface to restrict the tables by their type. |
static com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType |
TABLE
TABLE is used in the find interface to restrict the tables by their type. |
static com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType |
VIEW
VIEW is used in the find interface to restrict the tables by their type. |
Method Summary | |
IBIQuery |
createQuery()
Creates a new empty query object from the current connection. |
List |
getCatalog()
Returns the list of available catalogs in the connected system. |
List |
getColumn(Table table)
Returns the list of columns of the specified table. |
Catalog |
getCurrentCatalog()
Returns the current catalog for the current connection. |
Schema |
getCurrentSchema()
Returns the current schema for the current connection. |
Connection |
getNativeJDBCConnection()
Retrieves the native JDBC connection. |
Object |
getNativeRepresentation(IBIQuery query)
Retrieves the native representation the specified native query. |
IBIRelationalObjectFinder |
getObjectFinder()
Returns an instance of IBIObjectFinder which supports the
search for relational schema objects. |
ResultSet |
getResultSet(Object nativeQuery)
Returns the result of the query. |
List |
getSchema()
Returns the list of available schemas in the connected system. |
List |
getTable()
Returns the list of available tables in the connected system. |
List |
getTableTypes()
Returns the list of available table types in the connected system. |
void |
setCurrentCatalog(Catalog catalog)
Sets the current catalog for the current connection. |
void |
setCurrentSchema(Schema schema)
Sets the current schema for the current connection. |
Boolean |
supports(IBIRelational.Supports feature)
Returns true or false , depending on whether
the queried feature is supported or not. |
Field Detail |
public static final com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType SYSTEM_TABLE
DatabaseMetaData.getTables(String, String, String, String[])
public static final com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType TABLE
DatabaseMetaData.getTables(String, String, String, String[])
public static final com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType VIEW
DatabaseMetaData.getTables(String, String, String, String[])
public static final com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType GLOBAL_TEMPRARY
DatabaseMetaData.getTables(String, String, String, String[])
public static final com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType LOCAL_TEMPORARY
DatabaseMetaData.getTables(String, String, String, String[])
public static final com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType ALIAS
DatabaseMetaData.getTables(String, String, String, String[])
public static final com.sap.ip.bi.sdk.dac.connector.relational.schema.TableType SYNONYM
DatabaseMetaData.getTables(String, String, String, String[])
Method Detail |
public Boolean supports(IBIRelational.Supports feature) throws BIResourceException
true
or false
, depending on whether
the queried feature is supported or not.feature
- a feature that can be supported by a specific connectortrue
if the queried feature is supported;
false
if notBIResourceException
- if feature
is nullpublic List getCatalog() throws BIResourceException
Catalog
BIResourceException
- if the metadata retrieval failedpublic List getSchema() throws BIResourceException
Schema
BIResourceException
- if the metadata retrieval failedpublic Catalog getCurrentCatalog() throws BIResourceException
setCurrentCatalog(Catalog)
.BIResourceException
- if the metadata retrieval failedsetCurrentCatalog(Catalog)
public void setCurrentCatalog(Catalog catalog) throws BIResourceException
catalog
- the current catalog for the current connectionBIResourceException
- if catalog
is null or unknowngetCurrentCatalog()
public Schema getCurrentSchema() throws BIResourceException
setCurrentSchema(Schema)
.BIResourceException
- if the metadata retrieval failedsetCurrentSchema(Schema)
public void setCurrentSchema(Schema schema) throws BIResourceException
schema
- the current schema for the current connectionBIResourceException
- if schema
is null or unknowngetCurrentSchema()
public List getTable() throws BIResourceException
Table
BIResourceException
- if the metadata retrieval failedpublic List getTableTypes() throws BIResourceException
TableType
BIResourceException
- if the metadata retrieval failedpublic IBIRelationalObjectFinder getObjectFinder() throws BIResourceException
IBIObjectFinder
which supports the
search for relational schema objects.BIResourceException
- if the metadata retrieval failedpublic IBIQuery createQuery() throws BIResourceException
IBIQuery
, the empty query objectBIResourceException
- if the query creation failedpublic List getColumn(Table table) throws BIResourceException
table
- the table for which the list of columns is to be retrievedColumn
BIResourceException
- if the metadata retrieval failedpublic ResultSet getResultSet(Object nativeQuery) throws BIResourceException
nativeQuery
- the native specification of the queryBIResourceException
- if the concrete resource adapter (BI Java Connector) can't
return a valid ResultSet
implementation (null is valid)public Object getNativeRepresentation(IBIQuery query) throws BIResourceException
query
- the queryBIResourceException
- if an error occurs during the executionpublic Connection getNativeJDBCConnection() throws BIRuntimeException, BIResourceException
BIRuntimeException
- if an error occurs while finding the
native connectionBIResourceException
-
|
SAP BI Java SDK | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |