<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle™ Business Intelligence Beans Java API Reference
Release 10g (9.0.4)
Part number B12159_01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.dss.dataSource.common
Interface BaseManager

All Known Subinterfaces:: BaseClientManager, DrillManager, LayoutManager, MainManager, SelectionManager

All Known Implementing Classes:: Query

public interface BaseManager

Defines common functionality that is useful in the other Manager interfaces (such as BaseClientManager, and DrillManager) of the Query object.

Method Summary
`void`	`addQueryListener(QueryListener l)` Adds a listener to the listener list for this `Query` object.
`void`	`cancel()` Cancels a current operation on the stack.
`java.lang.Object`	`clone()` Clones this `QueryManager`.
`boolean`	`getFetchPageEdge()` Returns whether entire page edges are fetched.
`int`	`getFetchSize()` Returns the currently-set fetch buffer size
`QueryState`	`getQueryState()` Retrieves a state marker (also known as a token or cookie) that represents the current `Query` object state.
`int`	`getSuppressionState(int index)` Retrieves the suppression state (NONE, NA, zero, or both NA and zero) that is used when data is fetched.
`boolean`	`isAsymmetricDrilling()` Indicates whether asymmetric drilling is set.
`boolean`	`isAutoUpdate()` Indicates whether all operations should be sent immediately to the middle tier for execution.
`boolean`	`isEvaluateCursor()` Indicates whether cursor evaluation will be performed.
`boolean`	`isHierarchicalDrilling()` Indicates whether hierarchical drilling is set exclusively.
`boolean`	`isUpdatePending()` Indicates whether any operations are pending.
`void`	`removeQueryListener(QueryListener l)` Removes a listener from the listener list for this `Query` object.
`void`	`setAsymmetricDrilling(boolean asymmetric)` Indicates whether asymmetric drilling should be used
`void`	`setAutoUpdate(boolean b)` Specifies whether all operations on the underlying query should be sent to the middle tier for immediate processing.
`void`	`setEvaluateCursor(boolean evalCursor)` Specifies whether cursor evaluation will be performed.
`void`	`setFetchPageEdge(boolean fullfetch)` Sets whether entire page edges are fetched.
`void`	`setFetchSize(int size)` Sets fetch buffer size
`void`	`setHierarchicalDrilling(boolean hierDrill)` Indicates whether hierarchical drilling should be used exclusively f
`void`	`setQueryState(QueryState state)` Restores the `Query` object to a previous state in this session.
`void`	`setSuppressionState(int index, int suppress)` Specifies the suppression (NONE, NA, zero, or both NA and zero) to use when data is fetched.
`void`	`update()` Signals this Query to execute pending operations in order.

Method Detail

addQueryListener

public void addQueryListener(QueryListener l)

Adds a listener to the listener list for this Query object.

Parameters:: l - The QueryListener to be added.

removeQueryListener

public void removeQueryListener(QueryListener l)

Removes a listener from the listener list for this Query object.

Parameters:: l - The QueryListener to be removed.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones this QueryManager.

Returns:: A newly-created copy of the QueryManager.
Throws:: java.lang.CloneNotSupportedException - If a middle tier QueryManager cannot be instantiated.

update

public void update()
            throws java.lang.Exception

Signals this Query to execute pending operations in order.

Throws:: java.lang.Exception - Any middle tier exception.

setAutoUpdate

public void setAutoUpdate(boolean b)
                   throws java.lang.Exception

Specifies whether all operations on the underlying query should be sent to the middle tier for immediate processing. The corresponding <italic>get</italic> method is isAutoUpdate.

(Note: Another way to force the immediate execution of pending operations is to invoke the update method.)

Parameters:: b - true sends all pending operations to the middle tier for immediate processing, false adds an operation to the pending queue.
Throws:: java.lang.Exception - Any of the exceptions that are contained in the operations that are currently in the pending queue.

isAutoUpdate

public boolean isAutoUpdate()

Indicates whether all operations should be sent immediately to the middle tier for execution.

Returns:: true if all operations are sent immediately to the middle tier for execution, false if operations are to be added to the pending operations queue.

isUpdatePending

public boolean isUpdatePending()

Indicates whether any operations are pending.

Returns:: true if operations are pending; false if no operations are pending.

setSuppressionState

public void setSuppressionState(int index,
                                int suppress)

Specifies the suppression (NONE, NA, zero, or both NA and zero) to use when data is fetched.

Parameters:: index - A constant that specifies the edge of interest. Valid values are in oracle.dss.util.DataDirector.; suppress - A constant that specifies the kind of suppression. Valid values are in oracle.dss.util.DataDirector.
See Also:: DataDirector.NO_SUPPRESSION, DataDirector.ZERO_SUPPRESSION, DataDirector.NA_SUPPRESSION, DataDirector.NA_ZERO_SUPPRESSION, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getSuppressionState

public int getSuppressionState(int index)

Retrieves the suppression state (NONE, NA, zero, or both NA and zero) that is used when data is fetched.

Parameters:: index - A constant that specifies the edge of interest. Valid values are in oracle.dss.util.DataDirector.
Returns:: A constant that specifies the kind of suppression. Valid values are in oracle.dss.util.DataDirector.
See Also:: DataDirector.NO_SUPPRESSION, DataDirector.ZERO_SUPPRESSION, DataDirector.NA_SUPPRESSION, DataDirector.NA_ZERO_SUPPRESSION, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

setQueryState

public void setQueryState(QueryState state)
                   throws QueryException,
InvalidStepArgException,
SelectionException,
MetadataManagerException

Restores the Query object to a previous state in this session. Generates a StateChangedEvent marked by the StateChangeEvent.STATE constant.

Parameters:: state - State marker that was retrieved previously from an UndoAvailableEvent.
Throws:: QueryException - If there is a problem fetching data after this operation.; InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection cannot be created.; MetadataManagerException - If an error occurred using the MetadataManager bean.
See Also:: StateChangeEvent.STATE

getQueryState

public QueryState getQueryState()
                         throws CloneException

Retrieves a state marker (also known as a token or cookie) that represents the current Query object state. Later, in the same session, this state marker can be used as the parameter for setQueryState to restore the state of this Query object.

Returns:: The state marker (token or cookie) that represents the current state of this Query object.
Throws:: CloneException - If the state cannot be duplicated.

cancel

public void cancel()

Cancels a current operation on the stack.

setEvaluateCursor

public void setEvaluateCursor(boolean evalCursor)
                       throws QueryException,
InvalidStepArgException,
SelectionException,
MetadataManagerException

Specifies whether cursor evaluation will be performed. By default, cursor evaluation is performed.

Parameters:: evalCursor - true indicates that cursors should be evaluated; false indicates that cursors should not be evaluated.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection cannot be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

isEvaluateCursor

public boolean isEvaluateCursor()

Indicates whether cursor evaluation will be performed.

Returns:: true if cursor evaluation will be performed; false if cursor evaluation will not be performed.

setHierarchicalDrilling

public void setHierarchicalDrilling(boolean hierDrill)

Indicates whether hierarchical drilling should be used exclusively f

Parameters:: hierDrill - true to always use hierarchical drilling

isHierarchicalDrilling

public boolean isHierarchicalDrilling()

Indicates whether hierarchical drilling is set exclusively.

Returns:: true if hierarchical drilling is used exclusively; false if hierarchical drilling is not set exclusively.

setAsymmetricDrilling

public void setAsymmetricDrilling(boolean asymmetric)

Indicates whether asymmetric drilling should be used

Parameters:: asymmetric - true to use asymmetric drilling

isAsymmetricDrilling

public boolean isAsymmetricDrilling()

Indicates whether asymmetric drilling is set.

Returns:: true if asymmetric drilling is set; false if asymmetric drilling is not set.

setFetchSize

public void setFetchSize(int size)

Sets fetch buffer size

Parameters:: size - integer indicating number of values to fetch per buffer read for cursors. -1 turns partial fetching off and fetches the entire cursor

getFetchSize

public int getFetchSize()

Returns the currently-set fetch buffer size

Returns:: currently set fetch buffer size. -1 if fetch all is set

setFetchPageEdge

public void setFetchPageEdge(boolean fullfetch)

Sets whether entire page edges are fetched. Default is true.

Parameters:: fullfetch - if true, the page edge is fully fetched. If not, partial fetching applies.

getFetchPageEdge

public boolean getFetchPageEdge()

Returns whether entire page edges are fetched.

Returns:: true if entire page edges are fetched.