|
Oracle® OLAP Java API Reference 11g Release 2 (11.2) E10794-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.olapi.data.source.CursorSpecification
public abstract class CursorSpecification
The base class for an object that specifies characteristics of a Cursor
for a Source
. A CursorSpecification
implements the CursorInfoSpecification
interface. An application creates a CursorSpecification
with the createCursorInfoSpecification(Source rootSource)
method of a DataProvider
. That method returns a CompoundCursorSpecification
or a ValueCursorSpecification
.
After creating a CursorInfoSpecification
, an application can create a CursorManager
by passing the CursorInfoSpecification
to a createCursorManager
method of the DataProvider
. The application can then create a Cursor
by calling the createCursor
method of the CursorManager
.
With the methods of a CursorSpecification
, an application can specify that it wants information such as the extent of the Cursor
, which is the total number of elements the Cursor
contains, or the position in a parent Cursor
at which a child Cursor
starts or ends. Calculating the extent or the starting or ending positions can take a lot of time and computing resources, so an application should only set the CursorSpecification
to do so when it needs the information.
An application can also set the default fetch size for a Cursor
by calling the setDefaultFetchSize
method of the CursorSpecification
for that Cursor
. The fetch size is the number of elements that a Cursor
retrieves during a single fetch from the data store. If the application sets the default fetch size on a CursorSpecification
, then it can then change the fetch size for the Cursor
by calling the setFetchSize
method of the Cursor
itself.
With other methods of a CursorSpecification
, an application can accept a CursorSpecificationVisitor
or retrieve the Source
for the CursorSpecification
. The Source
for a CursorSpecification
is the Source
that defines the data that the Cursor
retrieves from the data store.
Method Summary | |
---|---|
abstract java.lang.Object |
acceptVisitor(CursorSpecificationVisitor visitor, java.lang.Object context) Calls the visitCursorSpecification method of the specified CursorSpecificationVisitor and passes that method the CursorSpecification and the specified context object. |
int |
getDefaultFetchSize() Gets the fetch size set as the default for this CursorSpecification . |
Source |
getSource() Gets the Source associated with the CursorSpecification . |
Transaction |
getTransaction() Gets the Transaction object for this CursorSpecification . |
boolean |
isExtentCalculationSpecified() Indicates whether the CursorSpecification is set to calculate the extent for the Cursor . |
boolean |
isParentEndCalculationSpecified() Indicates whether the CursorSpecification is set to calculate the ending position of the Cursor in the parent Cursor . |
boolean |
isParentStartCalculationSpecified() Indicates whether the CursorSpecification is set to calculate the starting position of the Cursor in the parent Cursor . |
void |
setDefaultFetchSize(int defaultFetchSize) Specifies a default fetch size for the Cursor . |
void |
setExtentCalculationSpecified(boolean b) Specifies whether to calculate the extent of the Cursor . |
void |
setParentEndCalculationSpecified(boolean b) Specifies whether to calculate the ending position of the Cursor in the parent Cursor . |
void |
setParentStartCalculationSpecified(boolean b) Specifies whether to calculate the starting position of the Cursor in the parent Cursor . |
void |
setTransaction(Transaction transaction) Specifies the Transaction object for this CursorSpecification . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public final Transaction getTransaction()
Transaction
object for this CursorSpecification
.Transaction
object for this CursorSpecification
.public final void setTransaction(Transaction transaction)
Transaction
object for this CursorSpecification
.transaction
- The Transaction
object for this CursorSpecification
.public abstract java.lang.Object acceptVisitor(CursorSpecificationVisitor visitor, java.lang.Object context)
visitCursorSpecification
method of the specified CursorSpecificationVisitor
and passes that method the CursorSpecification
and the specified context
object.visitor
- A CursorSpecificationVisitor
.context
- An Object
.Object
returned by the visitCursorSpecification
method.public final int getDefaultFetchSize()
CursorSpecification
.CursorSpecification
or Cursor.FETCH_SIZE_NOT_SPECIFIED
if setting the default fetch size is not specified for this CursorSpecification
.public final Source getSource()
Source
associated with the CursorSpecification
.getSource
in interface CursorInfoSpecification
Source
associated with the CursorSpecification
.public final boolean isExtentCalculationSpecified()
CursorSpecification
is set to calculate the extent for the Cursor
.true
if the CursorSpecification
is set to calculate the extent for the Cursor
and false otherwise.public final boolean isParentEndCalculationSpecified()
CursorSpecification
is set to calculate the ending position of the Cursor
in the parent Cursor
.isParentEndCalculationSpecified
in interface CursorInfoSpecification
true
if the CursorSpecification
is set to calculate the ending position of the Cursor
in the parent Cursor
and false otherwise.public final boolean isParentStartCalculationSpecified()
CursorSpecification
is set to calculate the starting position of the Cursor
in the parent Cursor
.isParentStartCalculationSpecified
in interface CursorInfoSpecification
true
if the CursorSpecification
is set to calculate the starting position of the Cursor
in the parent Cursor
and false otherwise.public final void setDefaultFetchSize(int defaultFetchSize) throws java.lang.IllegalArgumentException
Cursor
. The default fetch size must be greater than zero. The fetch size can only be set at one level in the hierarchy of a parent Cursor
and the children of that parent.defaultFetchSize
- The value to specify as the default fetch size.java.lang.IllegalArgumentException
- Indicates that the values specified for the fetch size is zero or less than zero.public final void setExtentCalculationSpecified(boolean b)
Cursor
. For a CompoundCursorSpecification
, calling this method causes Oracle OLAP to calculate the extents of all of the descendents of the CompoundCursorSpecification
.b
- true
to calculate the extent and false
otherwise.public final void setParentEndCalculationSpecified(boolean b)
Cursor
in the parent Cursor
.setParentEndCalculationSpecified
in interface CursorInfoSpecification
b
- true
to calculate the ending position of the Cursor
in the parent and false
otherwise.public final void setParentStartCalculationSpecified(boolean b)
Cursor
in the parent Cursor
.setParentStartCalculationSpecified
in interface CursorInfoSpecification
b
- true
to calculate the starting position of the Cursor
in the parent and false
otherwise.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |