|
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
Provides access to a data store. Each DataProvider
is associated with an oracle.jdbc.OracleConnection
and a TransactionProvider
. ExpressDataProvider
, the concrete subclass of DataProvider
, provides access to the actual data of an Oracle data store. After you create a new ExpressDataProvider
, you must call its initialize
method before you can use it.
The DataProvider
class includes methods that do the following.
Source
objects that have no, or one or more elements, which you can use in defining a Source
that specifies a query on the data store.CursorManagerSpecification
objects, which you use in creating Cursor
objects with which you retrieve the data specified by a query.FundamentalDataProvider
, which provides objects that represent the OLAP API data types.TransactionProvider
, which provides Transaction
objects. Every Source
is associated with a specific Transaction
.For the createListSource
methods, the values of the elements
array must be unique. The array cannot contain duplicate values.
You can specify any number of values in the elements
array. However, since the efficiency of a Source
returned by a createListSource
method decreases as the size of the elements
array increases, Oracle recommends that you create large lists in the underlying data store.
The Source
objects returned by the createConstantSource
and createListSource
methods each has an associated ConstantListDefinition
that contains its definition. The Source
objects returned by the createRangeSource
methods each has an associated RangeDefinition
that contains its definition.
Source
Method Summary | |
abstract void |
close() Closes the DataProvider and releases resources associated with it. |
BooleanSource |
createConstantSource(boolean element) Creates a BooleanSource that has only one element, which has the specified boolean value. |
DateSource |
createConstantSource(java.util.Date element) Creates a DateSource that has only one element, which has the specified Date value. |
NumberSource |
createConstantSource(double element) Creates a NumberSource that has only one element, which has the specified double value. |
NumberSource |
createConstantSource(float element) Creates a NumberSource that has only one element, which has the specified float value. |
NumberSource |
createConstantSource(int element) Creates a NumberSource that has only one element, which has the specified int value. |
NumberSource |
createConstantSource(short element) Creates a NumberSource that has only one element, which has the specified short value. |
Source |
createConstantSource(Source element) Creates a Source that has only one element, which has the specified Source value. |
StringSource |
createConstantSource(java.lang.String element) Creates a StringSource that has only one element, which has the specified String value. |
CursorInfoSpecification |
createCursorInfoSpecification(Source rootSource) Creates a CursorInfoSpecification for the specified Source . |
SpecifiedCursorManager |
createCursorManager(CursorManagerSpecification cursorManagerSpecification) Creates a CursorManager based on a CursorManagerSpecification . |
abstract SpecifiedCursorManager |
createCursorManager(CursorManagerSpecification cursorManagerSpecification, Source[] inputSources) Creates a CursorManager based on a CursorManagerSpecification and an array of Source objects. |
CursorManager |
createCursorManager(Source rootSource) Creates a CursorManager for the specified Source . |
CursorManager |
createCursorManager(Source rootSource, int fetchSize, CursorInfoSpecification cursorInfoSpec) Creates a CursorManager object for the specified Source with the specified CursorInfoSpecification that has the specified fetch size. |
CursorManager[] |
createCursorManagers(Source[] rootSources) Creates an array of CursorManager objects, one for each of the corresponding Source in the rootSources array. |
abstract CursorManager[] |
createCursorManagers(Source[] rootSource, int[] fetchSize, CursorInfoSpecification[] cursorInfoSpec) Creates an array of CursorManager objects for the specified Source objects with the specified CursorInfoSpecification objects that have the specified fetch sizes. |
CursorManagerSpecification |
createCursorManagerSpecification(Source rootSource) Creates a CursorManagerSpecification based on a Source object. |
BooleanSource |
createListSource(boolean[] elements) Creates a BooleanSource with elements that have the specified boolean values. |
DateSource |
createListSource(java.util.Date[] elements) Creates a DateSource with elements that have the specified Date values. |
NumberSource |
createListSource(double[] elements) Creates a NumberSource with elements that have the specified double values. |
NumberSource |
createListSource(float[] elements) Creates a NumberSource with elements that have the specified float values. |
NumberSource |
createListSource(int[] elements) Creates a NumberSource with elements that have the specified int values. |
NumberSource |
createListSource(short[] elements) Creates a NumberSource with elements that have the specified short values. |
Source |
createListSource(Source[] elements) Creates a Source with elements that have the specified Source objects as values. |
StringSource |
createListSource(java.lang.String[] elements) Creates a StringSource with elements that have the specified String values. |
BooleanSource |
createParameterizedSource(BooleanParameter param) Creates a parameterized BooleanSource that has the value of the specified BooleanParameter as the value of its element. |
DateSource |
createParameterizedSource(DateParameter param) Creates a parameterized DateSource that has the value of the specified DateParameter as the value of its element. |
NumberSource |
createParameterizedSource(NumberParameter param) Creates a parameterized NumberSource that has the value of the specified NumberParameter as the value of its element. |
StringSource |
createParameterizedSource(StringParameter param) Creates a parameterized StringSource that has the value of the specified StringParameter as the value of its element. |
NumberSource |
createRangeSource(int bottom, int top) Creates a NumberSource with elements that have consecutive int values that range from the specified lowest value to the specified highest value. |
NumberSource |
createRangeSource(int bottom, NumberSource top) Creates a NumberSource with elements that have consecutive int values that range from the specified lowest value to the specified highest value. |
NumberSource |
createRangeSource(NumberSource bottom, int top) Creates a NumberSource with elements that have consecutive int values that range from the specified lowest value to the specified highest value. |
NumberSource |
createRangeSource(NumberSource bottom, NumberSource top) Creates a NumberSource with elements that have consecutive int values that range from the specified lowest value to the specified highest value. |
SQLCursorManager |
createSQLCursorManager(Source source) Creates a SQLCursorManager for the specified Source . |
abstract SQLCursorManager[] |
createSQLCursorManagers(Source[] sources) Creates an array of SQLCursorManager objects that has one SQLCursorManager for each of the specified Source objects. |
Source |
getEmptySource() Gets the empty Source , which does not have any elements. |
FundamentalMetadataProvider |
getFundamentalMetadataProvider() Gets the FundamentalMetadataProvider for this DataProvider . |
TransactionProvider |
getTransactionProvider() Gets the TransactionProvider for this DataProvider . |
Source |
getVoidSource() Gets the void Source object, which has a single element that has null as its value. |
abstract void |
initialize() Initializes this DataProvider . |
abstract boolean |
isOpen() Indicates whether the connection to the data store is currently open. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public abstract void close()
DataProvider
and releases resources associated with it.public final NumberSource createConstantSource(double element)
NumberSource
that has only one element, which has the specified double
value.element
- The double
value that you want the returned NumberSource
to have.NumberSource
that has the specified double
value.public final NumberSource createConstantSource(float element)
NumberSource
that has only one element, which has the specified float
value.element
- The float
value that you want the returned NumberSource
to have.NumberSource
that has the specified float
value.public final NumberSource createConstantSource(int element)
NumberSource
that has only one element, which has the specified int
value.element
- The int
value that you want the returned NumberSource
to have.NumberSource
that has the specified int
value.public final StringSource createConstantSource(java.lang.String element)
StringSource
that has only one element, which has the specified String
value.element
- The String
value that you want the returned StringSource
to have.StringSource
that has the specified String
value.public final DateSource createConstantSource(java.util.Date element)
DateSource
that has only one element, which has the specified Date
value.element
- The Date
value that you want the returned DateSource
to have.DateSource
that has the specified Date
value.public final Source createConstantSource(Source element)
Source
that has only one element, which has the specified Source
value.element
- The Source
that you want as the value of the element of the returned Source
to have.Source
that has an element that has the specified Source
as its value.public final NumberSource createConstantSource(short element)
NumberSource
that has only one element, which has the specified short
value.element
- The short
value that you want the returned NumberSource
to have.NumberSource
that has the specified short
value.public final BooleanSource createConstantSource(boolean element)
BooleanSource
that has only one element, which has the specified boolean
value.element
- The boolean
value that you want the returned BooleanSource
to have.BooleanSource
that has the specified boolean
value.public final SpecifiedCursorManager createCursorManager(CursorManagerSpecification cursorManagerSpecification) throws CursorManagerSpecificationExpiredException
CursorManager
based on a CursorManagerSpecification
. You use a CursorManager
to create Cursor
objects, which provide access to the results of a query.
Use this method if the Source
that you used to create the CursorManagerSpecification
has no inputs. If the Source
has inputs, then use the createCursorManager(CursorManagerSpecification cursorManagerSpecification, Source[] inputSources)
method.
cursorManagerSpecification
- The CursorManagerSpecification
for the Source
for which you want to create a Cursor
.SpecifiedCursorManager
for the Source
for which you want to create a Cursor
.public abstract SpecifiedCursorManager createCursorManager(CursorManagerSpecification cursorManagerSpecification, Source[] inputSources) throws CursorManagerSpecificationExpiredException
CursorManager
based on a CursorManagerSpecification
and an array of Source
objects. You use a CursorManager
to create Cursor
objects, which provide access to the results of a query.
Use this method if the Source
that you used to create the CursorManagerSpecification
has inputs. With the inputSources
argument, you specify Source
objects for the inputs of the Source
used to create the CursorManagerSpecification
. If the Source
does not have inputs, then use the createCursorManager(CursorManagerSpecification cursorManagerSpecification)
method.
A Source
that you include in inputSources
must not have any inputs itself and it must not have any outputs. It must specify a single set of values. When you create a Cursor
from the CursorManager
, 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
- The CursorManagerSpecification
for the Source
for which you want to create a Cursor
.inputSources
- An array of Source
objects, one for each input of the Source
for the CursorManagerSpecification
.SpecifiedCursorManager
for the Source
for which you want to create a Cursor
.public final CursorManager createCursorManager(Source rootSource)
CursorManager
for the specified Source
.rootSource
- The Source
for which you want a CursorManager
.CursorManager
for the specified Source
.public final CursorManager[] createCursorManagers(Source[] rootSources)
CursorManager
objects, one for each of the corresponding Source
in the rootSources
array.rootSources
- The Source
objects for which you want CursorManager
objects.CursorManager
objects for the specified Source
objects.public final CursorManager createCursorManager(Source rootSource, int fetchSize, CursorInfoSpecification cursorInfoSpec)
CursorManager
object for the specified Source
with the specified CursorInfoSpecification
that has the specified fetch size. A fetch size of -1 specifies fetching the entire result set.rootSource
- A Source
for which you want a CursorManager
.fetchSize
- An integer that specifies the fetch size for the Cursor
objects created by the CursorManager
.cursorInfoSpec
- A CursorInfoSpecification
for the CursorManager
.CursorManager
for the Source
.public abstract CursorManager[] createCursorManagers(Source[] rootSource, int[] fetchSize, CursorInfoSpecification[] cursorInfoSpec)
CursorManager
objects for the specified Source
objects with the specified CursorInfoSpecification
objects that have the specified fetch sizes. The array contains one CursorManager
for each Source
in the rootSource
array. The fetchSize
and cursorInfoSpec
arrays supply a fetch size and a CursorInfoSpecification
for the CursorManager
for the corresponding Source
in the rootSource
array. A fetch size of -1 specifies fetching the entire result set.rootSource
- An array of Source
objects for which you want CursorManager
objects.fetchSize
- An array of integers that specify the fetch sizes for the Cursor
objects created by the corresponding CursorManager
objects.cursorInfoSpec
- An array of CursorInfoSpecification
objects for the corresponding CursorManager
objects.CursorManager
objects for the corresponding Source
objects.public final CursorInfoSpecification createCursorInfoSpecification(Source rootSource) throws TransactionalObjectInvalidException
CursorInfoSpecification
for the specified Source
.rootSource
- The Source
for which you want a CursorInfoSpecification
.CursorInfoSpecification
for the specified Source
.public final CursorManagerSpecification createCursorManagerSpecification(Source rootSource) throws TransactionalObjectInvalidException
CursorManagerSpecification
based on a Source
object. You can use the CursorManagerSpecification
to create CursorManager
objects. The CursorManagerSpecification
specifies the behavior of Cursor
objects that you create from a CursorManager
.rootSource
- A Source
that defines a query to make on the data source.CursorManagerSpecification
for the Source
for which you want to create a Cursor
.public final NumberSource createListSource(double[] elements)
NumberSource
with elements that have the specified double
values.elements
- An array of double
values.NumberSource
with elements that have the specified double
values.public final NumberSource createListSource(float[] elements)
NumberSource
with elements that have the specified float
values.elements
- An array of float
values.NumberSource
with elements that have the specified float
values.public final NumberSource createListSource(int[] elements)
NumberSource
with elements that have the specified int
values.elements
- An array of int
values.NumberSource
with elements that have the specified int
values.public final StringSource createListSource(java.lang.String[] elements)
StringSource
with elements that have the specified String
values.elements
- An array of String
values.StringSource
with elements that have the specified String
values.public final DateSource createListSource(java.util.Date[] elements)
DateSource
with elements that have the specified Date
values.elements
- An array of Date
values.DateSource
with elements that have the specified Date
values.public final Source createListSource(Source[] elements)
Source
with elements that have the specified Source
objects as values.elements
- An array of Source
objects.Source
with elements that have the specified Date
values.public final NumberSource createListSource(short[] elements)
NumberSource
with elements that have the specified short
values.elements
- An array of short
values.NumberSource
with elements that have the specified short
values.public final BooleanSource createListSource(boolean[] elements)
BooleanSource
with elements that have the specified boolean
values.elements
- An array of boolean
values.BooleanSource
with elements that have the specified boolean
values.public final StringSource createParameterizedSource(StringParameter param)
StringSource
that has the value of the specified StringParameter
as the value of its element.param
- A StringParameter
that supplies the value of the element of the StringSource
returned by this method.StringSource
whose element has the current value of the specified StringParameter
.public final DateSource createParameterizedSource(DateParameter param)
DateSource
that has the value of the specified DateParameter
as the value of its element.param
- A DateParameter
that supplies the value of the element of the DateSource
returned by this method.DateSource
whose element has the current value of the specified DateParameter
.public final BooleanSource createParameterizedSource(BooleanParameter param)
BooleanSource
that has the value of the specified BooleanParameter
as the value of its element.param
- A BooleanParameter
that supplies the value of the element of the BooleanSource
returned by this method.BooleanSource
whose element has the current value of the specified BooleanParameter
.public final NumberSource createParameterizedSource(NumberParameter param)
NumberSource
that has the value of the specified NumberParameter
as the value of its element.param
- A NumberParameter
that supplies the value of the element of the NumberSource
returned by this method.NumberSource
whose element has the current value of the specified NumberParameter
.public final NumberSource createRangeSource(int bottom, int top)
NumberSource
with elements that have consecutive int
values that range from the specified lowest value to the specified highest value.bottom
- The lowest value that you want the returned NumberSource
to have.top
- The highest value that you want the returned NumberSource
to have.NumberSource
that has the specified range of values.public final NumberSource createRangeSource(int bottom, NumberSource top)
NumberSource
with elements that have consecutive int
values that range from the specified lowest value to the specified highest value.bottom
- The lowest value that you want the returned NumberSource
to have.top
- A NumberSource
with a single element, which has the int
value that you want as the highest value of the returned NumberSource
.NumberSource
that has the specified range of values.public final NumberSource createRangeSource(NumberSource bottom, int top)
NumberSource
with elements that have consecutive int
values that range from the specified lowest value to the specified highest value.bottom
- A NumberSource
with a single element, which has the int
value that you want as the lowest value of the returned NumberSource
.top
- The highest value that you want the returned NumberSource
to have.NumberSource
that has the specified range of values.public final NumberSource createRangeSource(NumberSource bottom, NumberSource top)
NumberSource
with elements that have consecutive int
values that range from the specified lowest value to the specified highest value.bottom
- A NumberSource
with a single element, which has the int
value that you want as the lowest value of the returned NumberSource
.top
- A NumberSource
with a single element, which has the int
value that you want as the highest value of the returned NumberSource
.NumberSource
that has the specified range of values.public final Source getEmptySource()
Source
, which does not have any elements. The empty Source
represents an empty result set.Source
.public final FundamentalMetadataProvider getFundamentalMetadataProvider()
FundamentalMetadataProvider
for this DataProvider
. The FundamentalMetadataProvider
provides FundamentalMetadataObject
objects that represent Oracle OLAP data types. You can use FundamentalMetadataObject
objects to create derived Source
objects or instances of custom MtmObject
objects.FundamentalMetadataProvider
for this DataProvider
.public final TransactionProvider getTransactionProvider()
TransactionProvider
for this DataProvider
.TransactionProvider
for this DataProvider
.public final Source getVoidSource()
Source
object, which has a single element that has null
as its value.Source
.public abstract void initialize() throws java.sql.SQLException
DataProvider
. Always call this method after creating a new DataProvider
.
This method throws a java.sql.SQLException
if an error occurs when Oracle OLAP is preparing for its interactions with the database.
public abstract boolean isOpen()
true
when the connection to the data store is open or false
when it is not.public final SQLCursorManager createSQLCursorManager(Source source) throws TransactionalObjectInvalidException
SQLCursorManager
for the specified Source
. From the SQLCursorManager
you can obtain the SQL statement that Oracle OLAP generates for the Source
.source
- A Source
that specifies a query.SQLCursorManager
that has the SQL statement generated for the specified Source
.public abstract SQLCursorManager[] createSQLCursorManagers(Source[] sources)
SQLCursorManager
objects that has one SQLCursorManager
for each of the specified Source
objects. From each SQLCursorManager
you can obtain the SQL statement that Oracle OLAP generates for its Source
. All of the Source
objects in the sources
array must be active in the same Transaction
.sources
- An array of Source
objects from the same Transaction
.SQLCursorManager
objects that have the SQL statements generated for the specified Source
objects. .
|
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 |