SAP BI Java SDK

com.sap.ip.bi.sdk.dac.connector
Interface IBIRelational


public interface IBIRelational

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.

Since:
3.50

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

SYSTEM_TABLE

public static final 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.
See Also:
DatabaseMetaData.getTables(String, String, String, String[])

TABLE

public static final 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.
See Also:
DatabaseMetaData.getTables(String, String, String, String[])

VIEW

public static final 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.
See Also:
DatabaseMetaData.getTables(String, String, String, String[])

GLOBAL_TEMPRARY

public static final 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.
See Also:
DatabaseMetaData.getTables(String, String, String, String[])

LOCAL_TEMPORARY

public static final 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.
See Also:
DatabaseMetaData.getTables(String, String, String, String[])

ALIAS

public static final 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.
See Also:
DatabaseMetaData.getTables(String, String, String, String[])

SYNONYM

public static final 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.
See Also:
DatabaseMetaData.getTables(String, String, String, String[])
Method Detail

supports

public Boolean supports(IBIRelational.Supports feature)
                 throws BIResourceException
Returns true or false, depending on whether the queried feature is supported or not.
Parameters:
feature - a feature that can be supported by a specific connector
Returns:
true if the queried feature is supported; false if not
Throws:
BIResourceException - if feature is null

getCatalog

public List getCatalog()
                throws BIResourceException
Returns the list of available catalogs in the connected system.
Returns:
available catalogs in the connected system; each list entry is of type Catalog
Throws:
BIResourceException - if the metadata retrieval failed

getSchema

public List getSchema()
               throws BIResourceException
Returns the list of available schemas in the connected system.
Returns:
available schemas in the connected system; each list entry is of type Schema
Throws:
BIResourceException - if the metadata retrieval failed

getCurrentCatalog

public Catalog getCurrentCatalog()
                          throws BIResourceException
Returns the current catalog for the current connection. Can be set by setCurrentCatalog(Catalog).
Returns:
the current catalog
Throws:
BIResourceException - if the metadata retrieval failed
See Also:
setCurrentCatalog(Catalog)

setCurrentCatalog

public void setCurrentCatalog(Catalog catalog)
                       throws BIResourceException
Sets the current catalog for the current connection.
Parameters:
catalog - the current catalog for the current connection
Throws:
BIResourceException - if catalog is null or unknown
See Also:
getCurrentCatalog()

getCurrentSchema

public Schema getCurrentSchema()
                        throws BIResourceException
Returns the current schema for the current connection. Can be set by setCurrentSchema(Schema).
Returns:
the current schema for the current connection
Throws:
BIResourceException - if the metadata retrieval failed
See Also:
setCurrentSchema(Schema)

setCurrentSchema

public void setCurrentSchema(Schema schema)
                      throws BIResourceException
Sets the current schema for the current connection.
Parameters:
schema - the current schema for the current connection
Throws:
BIResourceException - if schema is null or unknown
See Also:
getCurrentSchema()

getTable

public List getTable()
              throws BIResourceException
Returns the list of available tables in the connected system.
Returns:
available tables in the connected system; each list entry is of type Table
Throws:
BIResourceException - if the metadata retrieval failed

getTableTypes

public List getTableTypes()
                   throws BIResourceException
Returns the list of available table types in the connected system.
Returns:
available table types in the connected system; each list entry is of type TableType
Throws:
BIResourceException - if the metadata retrieval failed

getObjectFinder

public IBIRelationalObjectFinder getObjectFinder()
                                          throws BIResourceException
Returns an instance of IBIObjectFinder which supports the search for relational schema objects.
Returns:
the object finder
Throws:
BIResourceException - if the metadata retrieval failed

createQuery

public IBIQuery createQuery()
                     throws BIResourceException
Creates a new empty query object from the current connection.
Returns:
IBIQuery, the empty query object
Throws:
BIResourceException - if the query creation failed

getColumn

public List getColumn(Table table)
               throws BIResourceException
Returns the list of columns of the specified table.
Parameters:
table - the table for which the list of columns is to be retrieved
Returns:
the columns of the specified table; each entry is of type Column
Throws:
BIResourceException - if the metadata retrieval failed

getResultSet

public ResultSet getResultSet(Object nativeQuery)
                       throws BIResourceException
Returns the result of the query. The query is specified in a source system-dependent way, for example in an SQL string in the case of JDBC.
Parameters:
nativeQuery - the native specification of the query
Returns:
the returned result set
Throws:
BIResourceException - if the concrete resource adapter (BI Java Connector) can't return a valid ResultSet implementation (null is valid)

getNativeRepresentation

public Object getNativeRepresentation(IBIQuery query)
                               throws BIResourceException
Retrieves the native representation the specified native query. The native representation of a relational query would be an SQL statement in the case of a JDBC resource adapter.
Parameters:
query - the query
Returns:
the native representation of the specified query
Throws:
BIResourceException - if an error occurs during the execution

getNativeJDBCConnection

public Connection getNativeJDBCConnection()
                                   throws BIRuntimeException,
                                          BIResourceException
Retrieves the native JDBC connection. The native JDBC connection is the connection to the relational data source via the native driver. This method can be used to test the functionality of the native driver.
Returns:
the native JDBC connection
Throws:
BIRuntimeException - if an error occurs while finding the native connection
BIResourceException -  
Since:
3.50 SP16

SAP BI Java SDK

Copyright © 2004-2006 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.