|
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
multidimensional metadata and queries. This interface, retrieved
from IBIConnection
, is implemented by all OLAP connectors.
It provides OLAP data source functionality including retrieval of metadata,
creation of the cubeView
, and retrieval of data.
Every OLAP connector needs to implement this interface in order to
support the functionality specified in it.
Inner Class Summary | |
static class |
IBIOlap.Supports
Returns Boolean.TRUE or Boolean.FALSE ,
depending on what kind of features the OLAP provider supports. |
Method Summary | |
IBIQuery |
createQuery(Cube cube)
Creates and returns a new IBIQuery object for the specified
Cube .
|
IBIDataSet |
execute(Object nativeQuery)
Returns the result of the query. |
List |
getCube()
Returns the list of available cubes in the system. |
IBIOlapObjectFinder |
getObjectFinder()
Returns an instance of IBIOlapObjectFinder which supports
the search for OLAP schema objects. |
IBIQueryFactory |
getQueryFactory()
Returns the class that provides the factory methods for all objects needed in the context of a query. |
List |
getSchema()
Returns the list of available schemas in the system. |
Collection |
getTaggedValue(ModelElement element)
Returns the collection of taggedValues for a given
ModelElement , such as Cube or
Dimension . |
javax.jmi.reflect.RefPackage |
getTopLevelPackage()
Returns the metadata package of the current connection. |
Boolean |
supports(IBIOlap.Supports feature)
Returns true or false , depending on whether
the queried feature is supported or not. |
Method Detail |
public Boolean supports(IBIOlap.Supports feature)
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 notpublic List getCube() throws BIResourceException
Cube
BIResourceException
- if the concrete resource adapter (BI Java Connector) can't
return a valid list of cubes (null is valid)public List getSchema() throws BIResourceException
Schema
BIResourceException
- if the concrete resource adapter (BI Java Connector) can't
return a valid list of schemas (null is valid)public javax.jmi.reflect.RefPackage getTopLevelPackage() throws BIResourceException
BIResourceException
- if the concrete resource adapter (BI Java Connector) can't
return a valid RefPackage (null is valid)public IBIDataSet execute(Object nativeQuery) throws BIResourceException
nativeQuery
- the native specification of the queryBIResourceException
- if the concrete resource adapter (BI Java Connector) can't
return a valid IBIDataSet
implementation (null is valid)public IBIQuery createQuery(Cube cube) throws BIOlapQueryException
IBIQuery
object for the specified
Cube
.
This method will create an initial query which can be executed and
will return for all available measures a single cell on the columns axis.cube
- the cube upon which the query is basedBIOlapQueryException
- if the underlying metadata objects are
inconsistentpublic IBIQueryFactory getQueryFactory()
IBIQueryFactory
, the factory classpublic Collection getTaggedValue(ModelElement element) throws BIResourceException
taggedValues
for a given
ModelElement
, such as Cube
or
Dimension
.element
- ModelElement
for taggedValue
taggedValue
collectionBIResourceException
- if the concrete resource adapter (BI Java Connector) can't
return a valid Collection of TaggedValues (null is valid)public IBIOlapObjectFinder getObjectFinder() throws BIResourceException
IBIOlapObjectFinder
which supports
the search for OLAP schema objects.BIResourceException
- if the concrete resource adapter
(BI Java Connector) can't return a valid implementation of
IBIOlapObjectFinder
(null is valid)
|
SAP BI Java SDK | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |