Oracle OLAP Java API Reference: Class CursorManagerSpecification

Overview

Package

Class

Tree

Deprecated

Index

Help

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

oracle.olapi.data.source
Class CursorManagerSpecification

java.lang.Object
  |
  +--oracle.olapi.data.source.CursorManagerSpecification

public final class CursorManagerSpecification
extends java.lang.Object
implements TransactionalObject

An object that organizes the CursorSpecification objects for a Source. To create a CursorManagerSpecification, call the createCursorManagerSpecification method on a DataProvider and pass that method a Source.

The organization of the CursorSpecification objects mirrors the structure of the Source. A CursorManagerSpecification has one CursorSpecification for the values of the elements of the Source and one for each output of the Source, if any, recursively; that is, if the output of the Source is a Source that itself has one or more outputs, then the CursorManagerSpecification has a CursorSpecification for the values of the output Source and one for each of the outputs of that Source.

Creating a CursorManagerSpecification is the first step in creating a Cursor to retrieve the data that the Source represents. For a description of the other steps, see the reference documentation for the Cursor interface.

See Also:: Cursor, CursorSpecification, DataProvider, Source

Method Summary
`CursorSpecification`	`getRootCursorSpecification()` Gets the root `CursorSpecification` of the `CursorManagerSpecification`.
`Transaction`	`getTransaction()` Gets the `Transaction` in which the `CursorManagerSpecification` was created.
`boolean`	`isExpired()` Indicates whether the `CursorManagerSpecification` is still valid for a `Source`.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRootCursorSpecification

public final CursorSpecification getRootCursorSpecification()

Gets the root CursorSpecification of the CursorManagerSpecification. If the Source used in creating the CursorManagerSpecification has no outputs, then the root is a ValueCursorSpecification, which is the only CursorSpecification of the CursorManagerSpecification. If the Source has one or more outputs, then the root is the CompoundCursorSpecification for the Source.

Returns:: The root CursorSpecification of the CursorManagerSpecification.
See Also:: CursorSpecification

getTransaction

public final Transaction getTransaction()

Gets the Transaction in which the CursorManagerSpecification was created. This method can be useful for debugging OLAP API applications. For information on transactions, see the reference documentation for the TransactionProvider interface.

Returns:: The Transaction in which the CursorManagerSpecification was created.
See Also:: TransactionProvider

isExpired

public final boolean isExpired()

Indicates whether the CursorManagerSpecification is still valid for a Source. When the structure of a Source changes, a CursorManagerSpecification created for that Source expires and is no longer valid. For an example of a Source that can change, see the reference documentation for CursorManager.

Returns:: true if the CursorManagerSpecification has expired and false otherwise.
See Also:: CursorManager