oracle.dss.dataSource
Class QueryManagerServer

java.lang.Object
  |
  +--oracle.jbo.common.NamedObjectImpl
        |
        +--oracle.jbo.server.NamedObjectImpl
              |
              +--oracle.jbo.server.ComponentObjectImpl
                    |
                    +--oracle.dss.dataSource.QueryManagerServer

All Implemented Interfaces:

oracle.jbo.ComponentObject, ErrorHandlerCallback, oracle.jbo.Properties, QueryManager, java.io.Serializable

public class QueryManagerServer

extends oracle.jbo.server.ComponentObjectImpl

implements java.io.Serializable, ErrorHandlerCallback, QueryManager

  QueryManagerServer
  This class is the main JBO-based middle tier QueryManager implementation.

See Also:

Serialized Form

Constructor Summary

QueryManagerServer()
Constructor.

Method Summary

void	addErrorHandler(ErrorHandler eh) Add a single error handler to the bean.
int	addQuery(Query query) Add the given Query into the list of Queries tracked by the QueryManager and therefore allow it to have state and evaluate.
boolean	cancel() Cancel current processes on this connection, if possible
java.lang.Object	clone() Clone this QueryManager
void	close() Closes any open Query references for proper clean up.
void	closeQueries(com.sun.java.util.collections.List queryList) Close a whole set of queries
void	closeQuery(int id) Close any open querymanager middle tier references for proper clean up
Query	createQuery() Creates an empty query
java.util.Locale	getLocale()
interface	getMetadataManager() Return reference to middle tier database API object.
java.util.Enumeration	getQueries() Get all of the queries in this QueryManager
void	initialize(java.util.Hashtable env)
boolean	isXMLValidated() Indicates whether the QueryManager validates XML against its DTD.
void	removeErrorHandler() Remove the error handler from the bean.
void	removeQuery(int id) Remove the given Query from the list of tracked Queries and clean up storage associated with it.
void	removeQuery(Query query) Clean up the given query and remove it from the list
java.lang.Object	sendQueue( opQueue) Method to load an entire list of operations into the middle tier queue.
void	setAsymmetricDrilling(int id, boolean asymmetric) Indicates whether asymmetric drilling should be used for a given query
void	setDebugMode(boolean mode) Indicates whether debug printouts should be produced.
void	setDebugModeQuery(int id, boolean mode) Set debug printout mode
void	setDefaultLayoutCounts(int numCol, int numRow, int id) Set the default layout dimension count properties.
void	setEvaluateCursor(int id, boolean evalCursor) Turn off actual cursor evaluation
void	setFetchPageEdge(int id, boolean fullfetch) Sets whether entire page edges are fetched.
void	setFetchSize(int id, int size) Sets the fetch buffer size for queries.
void	setHierarchicalDrilling(boolean mode) Specifies whether hierarchical drilling should be used exclusively.
void	setHierarchicalDrilling(int id, boolean hierDrill) Indicates whether hierarchical drilling should be used exclusively for a given query
void	setLocale(java.util.Locale loc)
java.lang.String	setMetadataManager( database) Reference to middle tier database API object.
void	setPageInformation(int id, boolean sharePage, int page, QDR qdrPage)
void	setPrintQueryState(boolean mode) Indicates whether query state printouts should be produced on every query operation.
void	setPrintQueryStateQuery(int id, boolean mode) Indicates whether query state printouts should be produced on every query operation.
void	setSeparatePage(int id, boolean separate) Indicates whether pages are fetched as separate cursors
void	setSuppressionState(int id, int[] suppress) Determine the suppression (NA/zero) when data is fetched.
void	setXMLValidated(boolean validate) Specifies whether the QueryManager validates XML against its DTD.

Methods inherited from class oracle.jbo.server.ComponentObjectImpl

addListener, createRef, getApplicationModule, getDefFullName, getDefName, getProxyClassName, getRootApplicationModule, isRegWithPiggyMan, remove

Methods inherited from class oracle.jbo.common.NamedObjectImpl

getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, refreshProperty, setFullName, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.dataSource.common.QueryManager

getName

Methods inherited from interface oracle.jbo.ComponentObject

getFullName, getName

Methods inherited from interface oracle.jbo.Properties

getProperties, getProperty, refreshProperty

Constructor Detail

QueryManagerServer

public QueryManagerServer()

Constructor.

Method Detail

addErrorHandler

public void addErrorHandler(ErrorHandler eh)

Add a single error handler to the 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()

Remove the error handler from the bean.

Specified by:

removeErrorHandler in interface ErrorHandlerCallback

setLocale

public void setLocale(java.util.Locale loc)

getLocale

public java.util.Locale getLocale()

getQueries

public java.util.Enumeration getQueries()

Get all of the queries in this QueryManager

Specified by:

getQueries in interface QueryManager

Returns:

enumeration of queries

closeQuery

public void closeQuery(int id)

Close any open querymanager middle tier references for proper clean up

Parameters:

id - query ID

close

public void close()

Closes any open Query references for proper clean up.

closeQueries

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

Close a whole set of queries

Specified by:

closeQueries in interface QueryManager

Parameters:

queryList - List of query objects to close in bulk

createQuery

public Query createQuery()

Creates an empty query

Specified by:

createQuery in interface QueryManager

Returns:

uninitialized Query object

addQuery

public int addQuery(Query query)

Add the given Query into the list of Queries tracked by the QueryManager and therefore allow it to have state and evaluate.

Specified by:

addQuery in interface QueryManager

Parameters:

query - Query to affiliate with middle tier state

Returns:

query ID assigned to this query

removeQuery

public void removeQuery(int id)

Remove the given Query from the list of tracked Queries and clean up storage associated with it.

Parameters:

id - id of query to remove

removeQuery

public void removeQuery(Query query)

Clean up the given query and remove it from the list

Specified by:

removeQuery in interface QueryManager

Parameters:

query - Query to remove

setDefaultLayoutCounts

public void setDefaultLayoutCounts(int numCol,
                                   int numRow,
                                   int id)

Set the default layout dimension count properties.

Parameters:

numCol - number of dimensions to put on the column

numRow - number of dimensions to put on the row

id - query ID to call

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.

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.

setPrintQueryState

public void setPrintQueryState(boolean mode)

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

Parameters:

id - query on which to set state print mode

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

setDebugModeQuery

public void setDebugModeQuery(int id,
                              boolean mode)

Set debug printout mode

Parameters:

id - query ID to call

mode - true to turn on debug printouts on both client and server

setPrintQueryStateQuery

public void setPrintQueryStateQuery(int id,
                                    boolean mode)

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

Parameters:

id - query on which to set state print mode

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

setSuppressionState

public void setSuppressionState(int id,
                                int[] suppress)

Determine the suppression (NA/zero) when data is fetched.

Parameters:

id - query ID to call

suppress - description of what to suppress

setEvaluateCursor

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

Turn off actual cursor evaluation

Parameters:

id - query ID to call

eval - should cursors be evaluated?

Throws:

InvalidStepArgException - thrown if a step in a selection is bad

SelectionException - thrown if a selection can't be created

QueryException - thrown if there is a problem fetching data after this operation

MetadataManagerException - thrown if an error occurred using the database bean

setHierarchicalDrilling

public void setHierarchicalDrilling(int id,
                                    boolean hierDrill)

Indicates whether hierarchical drilling should be used exclusively for a given query

Parameters:

id - query ID

hierDrill - true to always use hierarchical drilling

setAsymmetricDrilling

public void setAsymmetricDrilling(int id,
                                  boolean asymmetric)

Indicates whether asymmetric drilling should be used for a given query

Parameters:

id - query ID

asymmetric - true to use asymmetric drilling

setFetchSize

public void setFetchSize(int id,
                         int size)

Sets the fetch buffer size for queries.

Parameters:

id - query ID

size - size of fetch buffer to set (-1 to turn off partial fetching)

setFetchPageEdge

public void setFetchPageEdge(int id,
                             boolean fullfetch)

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

Parameters:

id - query ID

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

setSeparatePage

public void setSeparatePage(int id,
                            boolean separate)

Indicates whether pages are fetched as separate cursors

Parameters:

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

setPageInformation

public void setPageInformation(int id,
                               boolean sharePage,
                               int page,
QDR qdrPage)

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 to have XML validated, false to have QueryManager 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.

clone

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

Clone this QueryManager

Returns:

a newly-created copy of the QueryManager

Throws:

java.lang.CloneNotSupportedException - thrown if a QueryManager can not be cloned

cancel

public boolean cancel()

Cancel current processes on this connection, if possible

Specified by:

cancel in interface QueryManager

Returns:

true if the code was found to send an interrupt

setMetadataManager

public java.lang.String setMetadataManager( database)

Reference to middle tier database API object. Note: going forward, this will be a reference to the DSSDatabase's middle tier implementation that corresponds to the database set on the client side Note this method may throw a QueryRuntimeException.

Parameters:

db - database to use as reference

getMetadataManager

public getMetadataManager()

Return reference to middle tier database API object. Note: going forward, this will be a reference to the DSSDatabase's middle tier implementation

Returns:

middle tier database implementation

sendQueue

public java.lang.Object sendQueue( opQueue)
                           throws java.lang.Exception

Method to load an entire list of operations into the middle tier queue.

Parameters:

operations - list of operations to load

Throws:

any - middle tier exception