oracle.dss.dataSource.client
Class QueryManager

java.lang.Object
  |
  +--oracle.dss.dataSource.client.QueryManager

All Implemented Interfaces:

ErrorHandlerCallback, QueryManager, java.io.Serializable

public class QueryManager

extends java.lang.Object

implements java.io.Serializable, ErrorHandlerCallback, QueryManager

Main QueryManager bean. This bean performs services for all the Query beans that it tracks. These services include providing database support and providing methods to add, create, remove, or close Query objects.

See Also:

Serialized Form

Constructor Summary

QueryManager()
Constructor for the QueryManager.
Example: QueryManager queryManager = new QueryManager ();

QueryManager(oracle.jbo.ComponentObject dso)
Alternate constructor that creates a client-side QueryManager using an existing middle tier (server-side) proxy as a parameter.

Method Summary

void	addErrorHandler(ErrorHandler eh) Adds a single error handler to this QueryManager bean.
int	addQuery(Query query) Adds the specified Query object to the list of Queries that are tracked by this QueryManager.
boolean	cancel() Cancels current processes on this connection, if possible.
java.lang.Object	clone() Clones this QueryManager object.
void	close() Closes any open Query objects, releases the storage that is associated with those objects, and shuts down the QueryManager.
void	closeQueries(com.sun.java.util.collections.List queryList) Closes a specified list of Query objects.
Query	createQuery() Creates an empty Query object.
boolean	getFetchPageEdge() Returns whether entire page edges are fetched.
int	getFetchSize() Returns the currently-set fetch buffer size
java.util.Locale	getLocale()
MetadataManager	getMetadataManager() Retrieves the MetadataManager object that is currently associated with this QueryManager object.
java.lang.String	getName() Retrieves the name of this QueryManager object.
PersistableAttributes	getPersistableAttributes(PersistableAttributes oldAttrs)
java.util.Enumeration	getQueries() Retrieves a list of all of the Query objects that are being tracked by this QueryManager object.
BISession	getSession() Get the BISession object
java.lang.String	getTagName()
java.lang.Object	getXML( con)
void	initialize(java.util.Hashtable env)
boolean	isAsymmetricDrilling() Indicates whether asymmetric drilling is set.
boolean	isDebugMode() Indicates whether debug printouts will be produced.
boolean	isHierarchicalDrilling() Indicates whether hierarchical drilling is set exclusively.
boolean	isPrintQueryState() Indicates whether query state printouts should be produced on every query operation.
boolean	isSeparatePage() Indicates whether page cursors are fetched separately from data cursors
boolean	isXMLValidated() Indicates whether the QueryManager validates XML against its DTD.
void	removeErrorHandler() Removes the error handler from this QueryManager bean.
void	removeQuery(Query query) Removes the specified Query object from the list of Query objects that are tracked by this QueryManager.
void	setAsymmetricDrilling(boolean asymmetric) Indicates whether asymmetric drilling should be used
void	setDebugMode(boolean mode) Indicates whether debug printouts should be produced.
void	setFetchPageEdge(boolean fullfetch) Sets whether entire page edges are fetched.
void	setFetchSize(int size) Sets fetch buffer size
void	setHierarchicalDrilling(boolean mode) Specifies whether hierarchical drilling should be used exclusively.
void	setLocale(java.util.Locale loc)
void	setMetadataManager(MetadataManager manager) Specifies the MetadataManager object that is to be associated with this QueryManager.
void	setName(java.lang.String n) Specifies the name of this QueryManager object.
void	setPersistableAttributes(PersistableAttributes attrs)
void	setPrintQueryState(boolean mode) Indicates whether query state printouts should be produced on every query operation.
void	setSeparatePage(boolean separate) Indicates whether pages are fetched as separate cursors
void	setSession(BISession session) Set the BISession object
void	setXML( context, java.lang.Object node)
void	setXMLValidated(boolean validate) Specifies whether the QueryManager validates XML against its DTD.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryManager

public QueryManager()

      Constructor for the QueryManager.
  Example:
      QueryManager queryManager = new QueryManager ();

QueryManager

public QueryManager(oracle.jbo.ComponentObject dso)

Alternate constructor that creates a client-side QueryManager using an existing middle tier (server-side) proxy as a parameter. This constructor is used when cloning. For example, use this class when you have created a middle tier QueryManager clone first and you want to connect it to a clone on the client-side.

Parameters:

dso - An existing QueryManager proxy for cloning. For example, the proxy obtained through cloning a middle tier QueryManager. Subclasses of QueryManager must override this proxy and pass the argument to the QueryManager superclass.

Method Detail

setSession

public void setSession(BISession session)

Set the BISession object

Parameters:

session - User's BISession object

getSession

public BISession getSession()

Get the BISession object

Returns:

BISession object

setLocale

public void setLocale(java.util.Locale loc)

getLocale

public java.util.Locale getLocale()

addQuery

public int addQuery(Query query)

Adds the specified Query object to the list of Queries that are tracked by this QueryManager. This addition lets the newly added Query object have state and evaluate.

Specified by:

addQuery in interface QueryManager

Parameters:

query - The Query object to affiliate with the middle tier state.

Returns:

The query ID that is assigned to this Query object.

removeQuery

public void removeQuery(Query query)

Removes the specified Query object from the list of Query objects that are tracked by this QueryManager. Also releases the storage that was associated with the removed Query object.

Specified by:

removeQuery in interface QueryManager

Parameters:

query - The Query object to remove.

getQueries

public java.util.Enumeration getQueries()

Retrieves a list of all of the Query objects that are being tracked by this QueryManager object.

Specified by:

getQueries in interface QueryManager

Returns:

An enumeration of Query objects.

createQuery

public Query createQuery()

Creates an empty Query object.

Specified by:

createQuery in interface QueryManager

Returns:

The uninitialized Query object. Returns null if the call failed.

initialize

public void initialize(java.util.Hashtable env)

setXMLValidated

public void setXMLValidated(boolean validate)

Specifies whether the QueryManager validates XML against its DTD.

Parameters:

validate - true indicates that XML should be validated; false indicates that the QueryManager should apply the XML without testing for validity.

isXMLValidated

public boolean isXMLValidated()

Indicates whether the QueryManager validates XML against its DTD.

Returns:

true if the QueryManager validates XML; false if the QueryManager applies XML without validation.

getPersistableAttributes

public PersistableAttributes getPersistableAttributes(PersistableAttributes oldAttrs)

setPersistableAttributes

public void setPersistableAttributes(PersistableAttributes attrs)

getTagName

public java.lang.String getTagName()

getXML

public java.lang.Object getXML( con)

setXML

public void setXML( context,
                   java.lang.Object node)

getMetadataManager

public MetadataManager getMetadataManager()

Retrieves the MetadataManager object that is currently associated with this QueryManager object.

Returns:

A MetadataManager object or null.

setMetadataManager

public void setMetadataManager(MetadataManager manager)

Specifies the MetadataManager object that is to be associated with this QueryManager. In order to function properly, the QueryManager requires that this property be set. Note this method may throw a QueryRuntimeException.

Parameters:

manager - A reference to the MetadataManager that provides access to the logical database that the QueryManager will use when supplying data to its Query objects.

addErrorHandler

public void addErrorHandler(ErrorHandler eh)

Adds a single error handler to this QueryManager bean. The error handler will be called when the visual component traps an error from other parts of the system.

Specified by:

addErrorHandler in interface ErrorHandlerCallback

Parameters:

eh - Error handler object.

removeErrorHandler

public void removeErrorHandler()

Removes the error handler from this QueryManager bean.

Specified by:

removeErrorHandler in interface ErrorHandlerCallback

clone

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

Clones this QueryManager object.

Returns:

A newly-created copy of this QueryManager.

Throws:

java.lang.CloneNotSupportedException - If a QueryManager cannot be cloned.

setName

public void setName(java.lang.String n)

Specifies the name of this QueryManager object.

Parameters:

n - The name of this QueryManager object.

getName

public java.lang.String getName()

Retrieves the name of this QueryManager object.

Specified by:

getName in interface QueryManager

Returns:

The name of this QueryManager object.

setDebugMode

public void setDebugMode(boolean mode)

Indicates whether debug printouts should be produced.

Parameters:

mode - true produces debug printouts on both client and server; false does not produce debug printouts.

isDebugMode

public boolean isDebugMode()

Indicates whether debug printouts will be produced.

Returns:

true indicates that debug printouts will be produced; false indicates that debug printouts will not be produced.

setPrintQueryState

public void setPrintQueryState(boolean mode)

Indicates whether query state printouts should be produced on every query operation.

Parameters:

mode - true produces state printouts on server; false does not produce state printouts.

isPrintQueryState

public boolean isPrintQueryState()

Indicates whether query state printouts should be produced on every query operation.

Returns:

true indicates that state printouts will be produced; false indicates that state printouts will not be produced.

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.

setSeparatePage

public void setSeparatePage(boolean separate)

Indicates whether pages are fetched as separate cursors

Parameters:

separate - code>true to separate page cursors from the data cursor

isSeparatePage

public boolean isSeparatePage()

Indicates whether page cursors are fetched separately from data cursors

Returns:

true if page cursors are separate false if the entire query is one cursor

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.

setHierarchicalDrilling

public void setHierarchicalDrilling(boolean mode)

Specifies whether hierarchical drilling should be used exclusively.

Parameters:

hierDrill - true indicates always use hierarchical drilling; false indicates drilling is not restricted exclusively to hierarchical.

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.

cancel

public boolean cancel()

Cancels current processes on this connection, if possible.

Specified by:

cancel in interface QueryManager

Returns:

true if the code was found to send an interrupt; false if the code did not send an interrupt.

closeQueries

public void closeQueries(com.sun.java.util.collections.List queryList)

Closes a specified list of Query objects. Note this method may throw a QueryRuntimeException.

Specified by:

closeQueries in interface QueryManager

Parameters:

queryList - List of the query objects to close.

close

public void close()

Closes any open Query objects, releases the storage that is associated with those objects, and shuts down the QueryManager. Note this method may throw a QueryRuntimeException.