|
Oracle OLAP Java API Reference 10g Release 1 (10.1) B10994-01 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.olapi.data.source.DataProvider | +--oracle.express.olapi.data.full.ExpressDataProvider
Provides the actual data of an Oracle Database instance to Oracle OLAP. This concrete class extends the abstract DataProvider
class. Each ExpressDataProvider
is associated with an oracle.jdbc.OracleConnection
and an ExpressTransactionProvider
.
Constructor Summary | |
ExpressDataProvider(oracle.jdbc.OracleConnection connection, TransactionProvider transactionProvider) Creates a new ExpressDataProvider object. |
Method Summary | |
void |
close() Closes the ExpressDataProvider , releasing resources. |
SpecifiedCursorManager |
createCursorManager(CursorManagerSpecification cursorManagerSpecification, Source[] inputSources) Creates a new ExpressSpecifiedCursorManager , which is an implementation of the SpecifiedCursorManager interface for Oracle OLAP. |
SpecifiedCursorManager[] |
createCursorManagers(CursorManagerSpecification[] cursorManagerSpecifications, Source[][] inputLists) Creates an array of SpecifiedCursorManager objects. |
CursorManager[] |
createCursorManagers(Source[] rootSources, int[] fetchSizes, CursorInfoSpecification[] cursorInfoSpecs) Creates an array of ExpressDataCursorManager objects. |
SQLCursorManager[] |
createSQLCursorManagers(Source[] sources) Creates SQLCursorManager objects for the specified Source objects. |
SQLCursorManager[] |
createSQLCursorManagers(Source[] sources, boolean createCountColumn, java.lang.String[] generatedSQLStatements) Creates SQLCursorManager objects for the corresponding Source objects in the sources array. |
SQLCursorManager[] |
createSQLCursorManagers(Source[] sources, java.lang.String[] generatedSQLStatements) Creates SQLCursorManager objects for the corresponding Source objects in the sources array. |
oracle.jdbc.OracleConnection |
getConnection() Retrieves the oracle.jdbc.OracleConnection object that represents the connection between a client application and Oracle OLAP. |
MetadataProvider |
getDefaultMetadataProvider() Retrieves the MetadataProvider associated with the connection. |
void |
initialize() Initializes the ExpressDataProvider . |
boolean |
isOpen() Indicates whether the connection to Oracle OLAP is currently open. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ExpressDataProvider(oracle.jdbc.OracleConnection connection, TransactionProvider transactionProvider)
ExpressDataProvider
object. After creating a new ExpressDataProvider
object, call its initialize
method.connection
- An oracle.jdbc.OracleConnection
object.transactionProvider
- An ExpressTransactionProvider
.Method Detail |
public void initialize() throws java.sql.SQLException
ExpressDataProvider
. Always call this method after creating a new ExpressDataProvider
.
This method throws a java.sql.SQLException
if an error occurs when Oracle OLAP is preparing for its interactions with the database.
public oracle.jdbc.OracleConnection getConnection()
oracle.jdbc.OracleConnection
object that represents the connection between a client application and Oracle OLAP.oracle.jdbc.OracleConnection
object that represents the connection between a client application and Oracle OLAP.public final CursorManager[] createCursorManagers(Source[] rootSources, int[] fetchSizes, CursorInfoSpecification[] cursorInfoSpecs)
ExpressDataCursorManager
objects. The array contains one ExpressDataCursorManager
for each Source
in the rootSources
array. The fetchSizes
and cursorInfoSpecs
arrays supply a fetch size and a CursorInfoSpecification
for the ExpressDataCursorManager
for the corresponding Source
in the rootSources
array. A fetch size of -1 specifies fetching the entire result set.rootSources
- An array of Source
objects for which you want CursorManager
objects.fetchSizes
- An array of integers that specify the fetch sizes for the Cursor
objects created by the corresponding CursorManager
objects.cursorInfoSpecs
- An array of CursorInfoSpecification
objects for the corresponding CursorManager
objects.CursorManager
objects for the corresponding Source
objects.public final SpecifiedCursorManager createCursorManager(CursorManagerSpecification cursorManagerSpecification, Source[] inputSources) throws CursorManagerSpecificationExpiredException, DataProviderMismatchException, ExpressServerException, ObjectClosedException, TransactionalObjectInvalidException
ExpressSpecifiedCursorManager
, which is an implementation of the SpecifiedCursorManager
interface for Oracle OLAP. You use an ExpressSpecifiedCursorManager
to create Cursor
objects, which provide access to the results of a query. If the Source
that you used to create the CursorManagerSpecification
has inputs, you must specify Source
objects for those inputs with the inputSources
parameter.
A Source
that you include in the inputSources
array must not have any inputs itself and it must not have any visible outputs. It must specify a single set of values. When you create a Cursor
from the ExpressSpecifiedCursorManager
, you use CursorInput
objects to specify values for the input Source
objects.
You can discover the inputs of the Source
used to create the CursorManagerSpecification
by doing the following:
CursorManagerSpecification
, call the getRootCursorSpecification
method.CursorSpecification
returned, call the getSource
method.Source
returned, call the getInputs
method.cursorManagerSpecification
- A CursorManagerSpecification
you created by calling the createCursorManagerSpecification
method on this ExpressDataProvider
.inputSources
- An array of Source
objects, one for each input of the Source
used to create the CursorManagerSpecification
.SpecifiedCursorManager
.public final boolean isOpen()
true
when the connection is open; false
when it is not.public MetadataProvider getDefaultMetadataProvider()
MetadataProvider
associated with the connection.MetadataProvider
associated with the connection.public void close()
ExpressDataProvider
, releasing resources.public final SQLCursorManager[] createSQLCursorManagers(Source[] sources)
SQLCursorManager
objects for the specified Source
objects. With a SQLCursorManager
, you can obtain the SQL statements that Oracle OLAP generates for its Source
. The array returned by this method has a SQLCursorManager
for each Source
in the sources
array.
All of the Source
objects in the sources
array must belong to the same Transaction
.
sources
- An array of Source
objects for which you want to create SQLCursorManager
objects.SQLCursorManager
for the specified Source
objects.public final SQLCursorManager[] createSQLCursorManagers(Source[] sources, java.lang.String[] generatedSQLStatements)
SQLCursorManager
objects for the corresponding Source
objects in the sources
array. This method replaces the String
objects in the generatedSQLStatements
array with String
objects that contain the SQL statements that the Oracle OLAP SQL generator produces for the corresponding Source
objects in the sources
array. The generatedSQLStatements
array must be the same size as the sources
array.
All of the Source
objects in the sources
array must belong to the same Transaction
.
sources
- An array of Source
objects for which you want SQLCursorManager
objects.generatedSQLStatments
- An array of String
objects that correspond to the Source
objects in the sources
array.SQLCursorManager
objects.public final SQLCursorManager[] createSQLCursorManagers(Source[] sources, boolean createCountColumn, java.lang.String[] generatedSQLStatements)
SQLCursorManager
objects for the corresponding Source
objects in the sources
array. This method replaces the String
objects in the generatedSQLStatements
array with String
objects that contain the SQL statements that the Oracle OLAP SQL generator produces for the corresponding Source
objects in the sources
array. The generatedSQLStatements
array must be the same size as the sources
array.
All of the Source
objects in the sources
array must belong to the same Transaction
.
sources
- An array of Source
objects for which you want SQLCursorManager
objects.createCountColumn
- A boolean that specifies whether to include a count column in the generated SQL.generatedSQLStatments
- An array of String
objects that correspond to the Source
objects in the sources
array.SQLCursorManager
objects.public final SpecifiedCursorManager[] createCursorManagers(CursorManagerSpecification[] cursorManagerSpecifications, Source[][] inputLists) throws DataProviderMismatchException, ExpressServerException, ObjectClosedException, TransactionalObjectInvalidException
SpecifiedCursorManager
objects. The array contains one SpecifiedCursorManager
for each CursorManagerSpecification
in the cursorManagerSpecifications
array. The inputLists
array has any arrays of input Source
objects required by the corresponding CursorManagerSpecification
.cursorManagerSpecifications
- An array of CursorManagerSpecification
objects for which you want CursorManager
objects.inputLists
- An array of arrays of Source
objects that are the input Source
objects required by any of the specified CursorManagerSpecification
objects.SpecifiedCursorManager
objects for the CursorManagerSpecification
objects.createCursorManager(CursorManagerSpecification cursorManagerSpecification, Source[] inputSources)
|
Oracle OLAP Java API Reference 10g Release 1 (10.1) B10994-01 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |