<!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.client
Class QueryClient

java.lang.Object
  |
  +--oracle.dss.dataSource.common.Query
        |
        +--oracle.dss.dataSource.client.QueryClient

All Implemented Interfaces:: BaseManager, CheckpointState, DataSource, DrillManager, java.util.EventListener, javax.infobus.InfoBusDataProducer, javax.infobus.InfoBusEventListener, javax.infobus.InfoBusMember, LayoutContext, LayoutManager, MainManager, Persistable, java.beans.PropertyChangeListener, QueryContext, SelectionManager, java.io.Serializable, StringXMLizable, ThinBean

public class QueryClient
extends Query

Implements the DataSource API from the client perspective. This object is the Query Java Bean. To create a QueryClient object, take one of the following actions:

Use the createQuery factory method of a QueryManager object that resides on the client tier. This action implicitly sets the QueryManager property of the QueryClient object.

Use a constructor of this QueryClient class. If the constructor does not specify the QueryManager that should track the QueryClient, then you must explicitly set the QueryManager property of the QueryClient. <eul>

See Also:: Serialized Form

Fields inherited from class oracle.dss.dataSource.common.Query

NO_EVALUATE_ON_LOAD, QUERY_MANAGER

Constructor Summary
`QueryClient()` Constructs a `QueryClient` object without specifying the `QueryManager` object that will track it.
`QueryClient(QueryManager qm)` Constructs a `QueryClient` object and specifies the `QueryManager` object that will track the `QueryClient`.

Method Summary
`void`	`addCubeMeasures(java.lang.String[] measures)` Adds one or more measures to an existing query.
`void`	`addUndoableEditListener(javax.swing.event.UndoableEditListener l)` Adds a Swing-compatible undo listener to the Query.
`void`	`applyDataMap(DataMap map)` Requests that the types in the specified `DataMap` be added to the types iin the DataMap of the `Query`.
`void`	`applyMetadataMap(int edge, MetadataMap map)` Requests that the specified `MetadataMap` types be added to the types in the MetadataMap of the `Query`.
`void`	`applyMetadataMap(java.lang.String dimension, MetadataMap map)` Requests that the specified `MetadataMap` types for the specified dimension be added to the types in the MetadataMap of the `Query`.
`void`	`applySelection(Selection selection)` Applies the information from the specified `Selection` object to the corresponding `Selection` object in this `Query`.
`void`	`applySelections(Selection[] selections)` Applies the information from the given `Selection` objects to the corresponding `Selection` objects in this `Query`.
`void`	`checkpointState()` Tells the ThinBean to start tracking state changes.
`java.lang.Object`	`clone(boolean evaluateCursor)` Clones this `Query` and provides the performance option of bypassing cursor evaluation.
`void`	`close()` Closes any open `Query` middle tier references for proper clean up.
`boolean`	`commit()` Updates the actual database with changes that have been posted to the database server by the `submit` method.
`void`	`drill(java.lang.String dimension, java.lang.String value, java.lang.String hierarchy, int delta, java.lang.String valueParent, java.lang.String queryParent)` Drills to a relative level of the specified hierarchy accepting a value's parent for optimization of drill steps later.
`void`	`drill(java.lang.String dimension, java.lang.String value, java.lang.String hierarchy, int delta, java.lang.String valueParent, java.lang.String queryParent, int levelDepth, OlapQDR parentQDR)` Drills to a relative level of the specified hierarchy accepting a value's parent for optimization of drill steps later.
`void`	`drill(java.lang.String dimension, java.lang.String value, java.lang.String hierarchy, int delta, java.lang.String valueParent, java.lang.String queryParent, OlapQDR parentQDR)` Drills to a relative level of the specified hierarchy accepting a value's parent for optimization of drill steps later.
`void`	`drill(java.lang.String dimension, java.lang.String value, java.lang.String hierarchy, java.lang.String level, int action, java.util.BitSet flags)` Drills to specified level of the specified hierarchy.
`com.sun.java.util.collections.List`	`findAllSelections()` Retrieves a reference to the complete collection of `Selection` objects for this `Query`.
`Selection`	`findSelection(com.sun.java.util.collections.List dimensions)` Retrieves a `Selection` object that corresponds to the specified dimensions.
`Selection`	`findSelection(java.lang.String dimension)` Retrieves a `Selection` object that corresponds to the specified dimension.
`java.lang.String`	`getCheckpointState()` Used to retrieve the state differences from the last time that state was checkpointed.
`int`	`getCurrentPage()` Returns the current page number if shared among listeners Note this method may throw a QueryRuntimeException.
`java.lang.String`	`getDatabaseName()` Retrieves the name of the current MetadataManager that is in use by the `QueryManager` object that tracks this `Query`.
`java.lang.String[][]`	`getLayout()` Retrieves the current layout of dimensions in the query as a two-dimensional `String`.
`java.lang.String[]`	`getMeasures()` Retrieves the list of measures that were used to produce the current query.
`interface`	`getMetadataManager()` Returns the current MetadataManager that is set on the QueryManager for this Query.
`QueryManager`	`getQueryManager()` Retrieves a reference to the `QueryManager` object that tracks this `QueryClient` object.
`QueryState`	`getQueryState()` Retrieves a state marker (also known as a token or cookie) that represents the current `Query` state.
`java.lang.String`	`getState()` Retrieves a string that represents the changes in the state of a `ThinBean` since the `ThinBean` was created or since setBaseState() was called.
`Selection`	`getUniverseSelection(java.lang.String dimension)` Retrieves the `Selection` object that is being used as the starting "universe" corresponding to the specified dimension.
`void`	`initCubeQuery(java.lang.String[] measures, java.lang.String[][] dimensions)` Creates a query that is based on one or more specified Measures.
`void`	`initQuery(java.lang.String[][] dimensions, java.lang.String[] measures)` Creates a default query based on the specified dimensions; an optional measure can also be specified.
`java.lang.Boolean`	`isDependentOn(MDObject object)` Checks a given `MDObject` (measures are the only type of `MDObject` checked at this time) and determines whether the query makes use of the object in its selections or measure list.
`java.lang.Boolean`	`layout(java.lang.String[][] dimensions)` Arranges the layout of dimensions along the query's edges.
`void`	`pivot(java.lang.String source, java.lang.String target, int flags)` Performs the specified pivot operation.
`void`	`refresh(boolean rebuild)` Refreshes all cursors and/or structures of this `Query` object.
`void`	`removeCubeMeasures(java.lang.String[] measures)` Removes one or more measures from an existing query.
`void`	`removeSelection(Selection selection)` Removes the specified `Selection` object from this `Query`.
`void`	`removeUndoableEditListener(javax.swing.event.UndoableEditListener l)` Removes a Swing-compatible undo listener from the Query
`void`	`setAsymmetricDrilling(boolean asymmetric)` Indicates whether asymmetric drilling should be used
`void`	`setAutoUpdate(boolean b)` Controls whether operations should be sent to the middle tier for immediate processing or accumulated in a pending operations queue.
`void`	`setBaseState()` Establishes a base state for the `ThinBean` from which state changes that go onto the state string are tracked.
`void`	`setCheckpointState(java.lang.String state)` Used to set state differences from the last time that state was checkpointed.
`void`	`setCurrentPage(int page, QDR qdrPage)` Specifies the current page if pages are shared among listeners.
`void`	`setDataMap(DataMap map)` Specifies a data map that determines the data to be fetched for all clients and all subsequent cursors for this query.
`void`	`setDebugMode(boolean mode)` Indicates whether debug printouts should be produced.
`void`	`setDefaultColumnCount(int numCol)` Specifies the default number of dimensions to put on a column for default layouts.
`void`	`setDefaultRowCount(int numRow)` Specifies the default number of dimensions to put on a row for default layouts.
`void`	`setEvaluateCursor(boolean evalCursor)` Controls actual cursor evaluation.
`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`	`setMeasures(java.lang.String[] measures)` Specifies a list of measures and creates a default cube for the query.
`void`	`setMetadataMap(java.lang.String dimension, MetadataMap map)` Specifies a metadata map that determines the metadata to be fetched for all clients and all subsequent cursors for this query.
`void`	`setPrintQueryState(boolean mode)` Indicates whether query state printouts should be produced on every query operation.
`void`	`setQueryManager(QueryManager qm)` Specifies the QueryManager property for this `QueryClient` object.
`void`	`setQueryState(QueryState state)` Restores the `Query` to a previous state in this session.
`void`	`setSeparatePage(boolean separate)` Indicates whether pages are fetched as separate cursors
`void`	`setSharePage(boolean b)` Specifies whether page changes are transmitted among listeners.
`void`	`setState(java.lang.String state)` Specifies a state string that represents the changes on a `ThinBean`, since the `ThinBean` was created or since setBaseState() was called.
`void`	`setSuppressColumns(int suppress)` Specifies the suppression state (none, NA, zero, or both NA and zero) on the column edge of the query when data is fetched.
`void`	`setSuppressionState(int[] suppress)` Specifies the suppression state (none, NA, zero, or both NA and zero) to use for this `Query` when data is fetched.
`void`	`setSuppressionState(int index, int suppress)` Specifies the suppression (none, NA, zero, or both NA and zero) for an edge of this `Query` when data is fetched.
`void`	`setSuppressRows(int suppress)` Specifies the suppression state (none, NA, zero, or both NA and zero) on the row edge of a query when data is fetched.
`void`	`setUniverseSelection(java.lang.String dimension, Selection selection)` Specifies a `Selection` object to be used as the starting "universe" corresponding to the specified dimension.
`void`	`setXMLValidated(boolean validate)` Indicates whether the Query validates XML against its DTD.
`boolean`	`submit(com.sun.java.util.collections.List qdrCollection)` Sends the writeback changes in the QDRoverride collection to update the database server.
`void`	`swap(java.lang.String source, java.lang.String target)` Performs the specified swap operation.
`void`	`swapEdges(int source, int target)` Performs the specified edge swap operation.
`ValidationObject`	`validate(int validationType)` Validates the entire `Query` with OLAP API.
`ValidationObject`	`validate(int validationType, int edge)` Validates the an entire edge with the OLAP API
`ValidationObject`	`validate(int validationType, Selection selection)` Validates a Selection with the OLAP API.
`ValidationObject`	`validate(int validationType, Step step)` Validatess a specific Step with the OLAP API.

Methods inherited from class oracle.dss.dataSource.common.Query

addPropertyChangeListener, addQueryListener, applyLayoutAccess, applyQueryAccess, cancel, clone, createCubeDataDirector, createCubeLayoutAccess, createLayoutAccess, createQueryAccess, createRelationalDataDirector, createRelationalLayoutAccess, getDataMap, getDefaultColumnCount, getDefaultRowCount, getFetchPageEdge, getFetchSize, getMetadataMap, getMetadataMap, getName, getSuppressColumns, getSuppressionState, getSuppressionState, getSuppressRows, getThinBeanName, isAsymmetricDrilling, isAutoUpdate, isDebugMode, isEvaluateCursor, isHierarchicalDrilling, isPrintQueryState, isSeparatePage, isSharePage, isUpdatePending, isXMLValidated, removePropertyChangeListener, removeQueryListener, setCurrentPageAndFireEvent, setName, setThinBeanName, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Methods inherited from interface javax.infobus.InfoBusDataProducer

dataItemRequested

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Methods inherited from interface oracle.dss.util.persistence.Persistable

getPersistableAttributes, getPersistableComponents, initialize, setPersistableAttributes, setPersistableComponents

Methods inherited from interface oracle.dss.util.persistence.StringXMLizable

getXMLAsString, setXMLAsString

Constructor Detail

QueryClient

public QueryClient()

Constructs a QueryClient object without specifying the QueryManager object that will track it. This QueryClient object will not have state or evaluate until its QueryManager property is specified.

QueryClient

public QueryClient(QueryManager qm)
            throws java.lang.Exception

Constructs a QueryClient object and specifies the QueryManager object that will track the QueryClient.

Throws:: java.lang.Exception - Error encountered bringing back query after persistence

Method Detail

setQueryManager

public void setQueryManager(QueryManager qm)
                     throws java.lang.Exception

Specifies the QueryManager property for this QueryClient object.

Overrides:: setQueryManager in class Query

Parameters:: qm - An instance of a QueryManager object.
Throws:: java.lang.Exception - Error encountered bringing back query after persistence.

getQueryManager

public QueryManager getQueryManager()

Retrieves a reference to the QueryManager object that tracks this QueryClient object.

Overrides:: getQueryManager in class Query

Returns:: A reference to a QueryManager object or null.

setXMLValidated

public void setXMLValidated(boolean validate)

Indicates whether the Query validates XML against its DTD.

Overrides:: setXMLValidated in class Query

Parameters:: validate - true if XML is validated; false if the Query applies XML without testing for validity.

setMeasures

public void setMeasures(java.lang.String[] measures)

Specifies a list of measures and creates a default cube for the query. Note this method may throw a QueryRuntimeException.

Overrides:: setMeasures in class Query

Parameters:: measures - The list of measures to use to make a default cube.

getMeasures

public java.lang.String[] getMeasures()

Retrieves the list of measures that were used to produce the current query. Note this method may throw a QueryRuntimeException.

Overrides:: getMeasures in class Query

Returns:: The list of measures.

clone

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

Clones this Query and provides the performance option of bypassing cursor evaluation. If the EvaluateCursor property is set to false, then the Query does not ask the OLAP API to create a cursor based on the user's API calls. The caller of this method still gets the full set of events along with the "cursors" but these cursors will not have any data or metadata values in them. The cursors will contain only basic edge, layer level wireframe information (such as the dimensions and where they are located in the layout).

Overrides:: clone in class Query

Parameters:: evaluateCursor - true if this clone should have cursor evaluation turned on (this is the default value); false if this clone does not require cursor evaluation.
Returns:: A newly-created copy of the Query.
Throws:: java.lang.CloneNotSupportedException - If a Query can not be cloned.
See Also:: Query.isEvaluateCursor(), setEvaluateCursor(boolean)

setEvaluateCursor

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

Controls actual cursor evaluation. The default setting for the EvaluateCursor property is true. If this setting is changed to false, then the clone(boolean) method bypasses cursor evaluation when copying a Query.

Overrides:: setEvaluateCursor in class Query

Parameters:: evalCursor - Indicates whether cursors should be evaluated for a Query.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

drill

public void drill(java.lang.String dimension,
                  java.lang.String value,
                  java.lang.String hierarchy,
                  int delta,
                  java.lang.String valueParent,
                  java.lang.String queryParent)
           throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Drills to a relative level of the specified hierarchy accepting a value's parent for optimization of drill steps later.

Parameters:: dimension - The dimension to drill.; value - The dimension value, also known as the dimension member, to drill.; hierarchy - The target hierarchy for the drill.; delta - The relative number of levels to traverse within the specified hierarchy. Positive numbers drill down, negative numbers drill up.; valueParent - Value's parent dimension value; used for optimizing later potential drill up requests.; queryParent - The item from the original query members under which this drill occurs.
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.

drill

public void drill(java.lang.String dimension,
                  java.lang.String value,
                  java.lang.String hierarchy,
                  int delta,
                  java.lang.String valueParent,
                  java.lang.String queryParent,
OlapQDR parentQDR)
           throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Drills to a relative level of the specified hierarchy accepting a value's parent for optimization of drill steps later.

Parameters:: dimension - The dimension to drill.; value - The dimension value, also known as the dimension member, to drill.; hierarchy - The target hierarchy for the drill.; delta - The relative number of levels to traverse within the specified hierarchy. Positive numbers drill down, negative numbers drill up.; valueParent - Value's parent dimension value; used for optimizing later potential drill up requests.; queryParent - The item from the original query members under which this drill occurs.; parentQDR - An optional OlapQDR that specifies dimension/member pairs that limit where this drill (down) should take place (parents of the target).
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.

drill

public void drill(java.lang.String dimension,
                  java.lang.String value,
                  java.lang.String hierarchy,
                  int delta,
                  java.lang.String valueParent,
                  java.lang.String queryParent,
                  int levelDepth,
OlapQDR parentQDR)
           throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Drills to a relative level of the specified hierarchy accepting a value's parent for optimization of drill steps later.

Parameters:: dimension - The dimension to drill.; value - The dimension value, also known as the dimension member, to drill.; hierarchy - The target hierarchy for the drill.; delta - The relative number of levels to traverse within the specified hierarchy. Positive numbers drill down, negative numbers drill up.; valueParent - Value's parent dimension value; used for optimizing later potential drill up requests.; queryParent - The item from the original query members under which this drill occurs.; levelDepth - Optional performance hint that indicates the numeric level at which the drill target sits within its hierarchy.; parentQDR - An optional OlapQDR that specifies dimension/member pairs that limit where this drill (down) should take place (parents of the target).
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.

drill

public void drill(java.lang.String dimension,
                  java.lang.String value,
                  java.lang.String hierarchy,
                  java.lang.String level,
                  int action,
                  java.util.BitSet flags)
           throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Drills to specified level of the specified hierarchy.

Parameters:: dimension - The dimension to drill.; value - The dimension value (also known as member) to drill.; hierarchy - The name of the target hierarchy.; level - The number of the target level to traverse to.; action - The selection step action (Step.ADD, Step.KEEP, Step.REMOVE, or Step.SELECT).; flags - A list of optional flags. These flags are drill constants that begin with the prefix DRILL_EXCLUDE_ and are found in oracle.dss.dataSource.common.DrillConstants.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.
See Also:: DrillConstants.DRILL_EXCLUDE_RANGE, DrillConstants.DRILL_EXCLUDE_SELF, DrillConstants.DRILL_EXCLUDE_SIBLINGS, Step.ADD, Step.KEEP, Step.REMOVE, Step.SELECT

layout

public java.lang.Boolean layout(java.lang.String[][] dimensions)
                         throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Arranges the layout of dimensions along the query's edges.

Parameters:: dimensions - An array of dimension layout arrays.
Returns:: true if the operation is successful; false if the operation is not successful.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

getLayout

public java.lang.String[][] getLayout()

Retrieves the current layout of dimensions in the query as a two-dimensional String. Note this method may throw a QueryRuntimeException.

Returns:: The current layout of dimensions in the query.

pivot

public void pivot(java.lang.String source,
                  java.lang.String target,
                  int flags)
           throws InvalidStepArgException,
QueryException,
SelectionException,
MetadataManagerException

Performs the specified pivot operation.

Parameters:: source - The source dimension.; target - The target dimension (if an edge is empty, then this parameter must be a number that indicates the target edge).; flags - A constant that indicates the type of pivot. Use PivotConstants.PIVOT_AFTER or PivotConstants.PIVOT_BEFORE.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.
See Also:: PivotConstants.PIVOT_AFTER, PivotConstants.PIVOT_BEFORE

swap

public void swap(java.lang.String source,
                 java.lang.String target)
          throws InvalidStepArgException,
QueryException,
SelectionException,
MetadataManagerException

Performs the specified swap operation.

Parameters:: source - The source dimension.; target - The target dimension.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

swapEdges

public void swapEdges(int source,
                      int target)
               throws InvalidStepArgException,
QueryException,
SelectionException,
MetadataManagerException

Performs the specified edge swap operation.

Parameters:: source - A constant that represents the source edge. Use one of the constants that ends with _EDGE in oracle.dss.util.DataDirector.; target - A constant that represents the target edge. Use one of the constants that ends with _EDGE in oracle.dss.util.DataDirector.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.
See Also:: DataDirector.COLUMN_EDGE, DataDirector.DATA_ELEMENT_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

applySelection

public void applySelection(Selection selection)
                    throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Applies the information from the specified Selection object to the corresponding Selection object in this Query.

Parameters:: selection - The Selection to be applied.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

removeSelection

public void removeSelection(Selection selection)
                     throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Removes the specified Selection object from this Query.

Parameters:: selection - The Selection to remove.
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.

applySelections

public void applySelections(Selection[] selections)
                     throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Applies the information from the given Selection objects to the corresponding Selection objects in this Query.

Parameters:: selections - The Selection objects to apply.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data. after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

findAllSelections

public com.sun.java.util.collections.List findAllSelections()

Retrieves a reference to the complete collection of Selection objects for this Query. Each Selection object corresponds to an underlying dimension (including the Measure dimension). The Query is registered as a listener to all the Selection objects in the collection, such that changes to any one of them are captured as Query operations. Note this method may throw a QueryRuntimeException.

Returns:: A reference to the list of Selection objects.

findSelection

public Selection findSelection(com.sun.java.util.collections.List dimensions)

Retrieves a Selection object that corresponds to the specified dimensions. The Query is registered as a listener to this object so that changes to the underlying list of Step objects are captured as Query operations. Note this method may throw a QueryRuntimeException.

Parameters:: dimension - The dimensions for which to return the current Selection object.
Returns:: The Selection object that corresponds to the specified dimensions.

findSelection

public Selection findSelection(java.lang.String dimension)

Retrieves a Selection object that corresponds to the specified dimension. The Query is registered as a listener to this object so that changes to the underlying list of Step objects are captured as Query operations. Note this method may throw a QueryRuntimeException.

Parameters:: dimension - The dimension for which to return the current Selection object.
Returns:: The Selection object that corresponds to the specified dimension.

isDependentOn

public java.lang.Boolean isDependentOn(MDObject object)

Checks a given MDObject (measures are the only type of MDObject checked at this time) and determines whether the query makes use of the object in its selections or measure list. Note this method may throw a QueryRuntimeException.

Parameters:: object - MDObject that represents the object to check.
Returns:: true if the query uses the object; false if the query does not use the object.

setUniverseSelection

public void setUniverseSelection(java.lang.String dimension,
Selection selection)
                          throws InvalidStepArgException,
MetadataManagerException,
SelectionException,
QueryException

Specifies a Selection object to be used as the starting "universe" corresponding to the specified dimension. This action invalidates any existing query and overrides any MetadataManager bean universes for the specified dimension. Note that universe Selections may not be set for the measure dimension.

Parameters:: dimension - The dimension for which to set the universe.; selection - The Selection object to set as the universe.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

getUniverseSelection

public Selection getUniverseSelection(java.lang.String dimension)
                               throws IllegalArgException

Retrieves the Selection object that is being used as the starting "universe" corresponding to the specified dimension. Note this method may throw a QueryRuntimeException.

Parameters:: dimension - The dimension for which to return the universe Selection object.
Returns:: The Selection object, if there is one; null if there is no Selection object that is being used as the starting "universe".
Throws:: IllegalArgException - If arguments are invalid.

addCubeMeasures

public void addCubeMeasures(java.lang.String[] measures)
                     throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Adds one or more measures to an existing query. Creates the query if one does not yet exist.

Parameters:: measures - An array of the names of the measures to add.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

applyDataMap

public void applyDataMap(DataMap map)

Requests that the types in the specified DataMap be added to the types iin the DataMap of the Query. These types will be included in subsequent cursors. Note this method may throw a QueryRuntimeException.

Parameters:: map - The DataMap object that contains the types to be added.

applyMetadataMap

public void applyMetadataMap(java.lang.String dimension,
MetadataMap map)
                      throws QueryException,
InvalidStepArgException,
MetadataManagerException,
SelectionException

Requests that the specified MetadataMap types for the specified dimension be added to the types in the MetadataMap of the Query. These MetadataMap types will be included in subsequent cursors.

Parameters:: dimension - The dimension to which this map should be applied.; map - The MetadataMap that contains the desired types.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

applyMetadataMap

public void applyMetadataMap(int edge,
MetadataMap map)
                      throws QueryException,
InvalidStepArgException,
MetadataManagerException,
SelectionException

Requests that the specified MetadataMap types be added to the types in the MetadataMap of the Query. These MetadataMap types will be included in subsequent cursors.

Parameters:: edge - A constant that represents the edge to which the new MetadataMap types will be applied. The valid constants (COLUMN_EDGE, PAGE_EDGE, ROW_EDGE) are found in oracle.dss.util.DataDirector.; map - The MetadataMap object that contains the desired types.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created,; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.
See Also:: DataDirector.COLUMN_EDGE, DataDirector.DATA_ELEMENT_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

initCubeQuery

public void initCubeQuery(java.lang.String[] measures,
                          java.lang.String[][] dimensions)
                   throws QueryException,
InvalidStepArgException,
SelectionException,
                          java.lang.IllegalArgumentException,
MetadataManagerException

Creates a query that is based on one or more specified Measures. The dimensionality of the resultant query will be based upon the superset of the dimensionality of the Measures; optionally, the caller can also describe the default layout of the dimensions along the edges of the query.

Parameters:: measures - The name or names of the measures.; dimensions - Optional array of dimension layout arrays.
Throws:: QueryException - If a cursor can not be created for this query.; InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; java.lang.IllegalArgumentException - If one or more of the arguments is invalid.; MetadataManagerException - If an error occurred using the MetadataManager bean.

initQuery

public void initQuery(java.lang.String[][] dimensions,
                      java.lang.String[] measures)
               throws QueryException,
InvalidStepArgException,
SelectionException,
                      java.lang.IllegalArgumentException,
MetadataManagerException

Creates a default query based on the specified dimensions; an optional measure can also be specified.

Parameters:: dimensions - The dimension layout arrays.; measure - Optional measure (may be null--OLAP API value source will be used in that case).
Throws:: QueryException - If a cursor can not be created for this query.; InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; java.lang.IllegalArgumentException - If one or more of the arguments is invalid.; MetadataManagerException - If an error occurred using the MetadataManager bean.

validate

public ValidationObject validate(int validationType)
                          throws InvalidStepArgException,
MetadataManagerException,
SelectionException,
QueryException

Validates the entire Query with OLAP API.

Parameters:: validationType - OR-able constants indicating types of validation to perform. Use the constants from the ValidationObject class.
Returns:: ValidationObject that indicates the results of validation.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.
See Also:: ValidationObject

validate

public ValidationObject validate(int validationType,
                                 int edge)
                          throws InvalidStepArgException,
MetadataManagerException,
SelectionException,
QueryException

Validates the an entire edge with the OLAP API

Parameters:: validationType - OR-able constants indicating types of validation to perform. Use the constants from the ValidationObject class.; edge - The edge to validate. To specify an edge, use one of the constants that end with _EDGE in oracle.dss.util.DataDirector.
Returns:: ValidationObject that indicates the results of validation.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.
See Also:: ValidationObject, DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE

validate

public ValidationObject validate(int validationType,
Selection selection)
                          throws InvalidStepArgException,
MetadataManagerException,
SelectionException,
QueryException

Validates a Selection with the OLAP API.

Parameters:: validationType - OR-able constants indicating types of validation to perform. Use the constants from the ValidationObject class.; selection - The Selection to validate.
Returns:: ValidationObject indicating results of validation
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.
See Also:: ValidationObject

validate

public ValidationObject validate(int validationType,
Step step)
                          throws InvalidStepArgException,
MetadataManagerException,
SelectionException,
QueryException

Validatess a specific Step with the OLAP API.

Parameters:: validationType - OR-able constants indicating types of validation to perform. Use the constants from the ValidationObject class.; step - The Step to validate.
Returns:: ValidationObject that indicates the results of validation.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.
See Also:: ValidationObject

removeCubeMeasures

public void removeCubeMeasures(java.lang.String[] measures)
                        throws InvalidStepArgException,
SelectionException,
QueryException,
MetadataManagerException

Removes one or more measures from an existing query. The dimensionality of the query is updated as appropriate.

Parameters:: measures - List of measures to remove.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

setDataMap

public void setDataMap(DataMap map)

Specifies a data map that determines the data to be fetched for all clients and all subsequent cursors for this query. (Note: This method resets cumulative applyDataMap operations; generally called only on a clone of the Query.) Note this method may throw a QueryRuntimeException.

Parameters:: map - The DataMap object that contains the desired data map types.

setMetadataMap

public void setMetadataMap(java.lang.String dimension,
MetadataMap map)
                    throws QueryException,
InvalidStepArgException,
MetadataManagerException,
SelectionException

Specifies a metadata map that determines the metadata to be fetched for all clients and all subsequent cursors for this query. (Note: This method resets cumulative applyMetadataMap operations; generally called only on a clone of the Query.)

Parameters:: dimension - The dimension for which the metadata map will be set.; map - The MetadataMap object that contains the desired metadata map types.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

refresh

public void refresh(boolean rebuild)
             throws QueryException,
InvalidStepArgException,
SelectionException,
MetadataManagerException

Refreshes all cursors and/or structures of this Query object.

Parameters:: rebuild - true, refreshes the structural elements of the query such as calculations; false performs a minimal refresh from the database.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

setQueryState

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

Restores the Query to a previous state in this session.

Parameters:: state - A state marker (also known as a token or a cookie) that was retrieved previously from getQueryState.
Throws:: InvalidStepArgException - If a step in a selection is bad.; SelectionException - If a selection can not be created.; QueryException - If there is a problem fetching data after this operation.; MetadataManagerException - If an error occurred using the MetadataManager bean.

getQueryState

public QueryState getQueryState()
                         throws CloneException

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

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

addUndoableEditListener

public void addUndoableEditListener(javax.swing.event.UndoableEditListener l)

Adds a Swing-compatible undo listener to the Query.

Parameters:: l - Listener to add.

removeUndoableEditListener

public void removeUndoableEditListener(javax.swing.event.UndoableEditListener l)

Removes a Swing-compatible undo listener from the Query

Parameters:: l - Listener to removex

close

public void close()

Closes any open Query middle tier references for proper clean up.

Overrides:: close in class Query

submit

public boolean submit(com.sun.java.util.collections.List qdrCollection)
               throws QueryException

Sends the writeback changes in the QDRoverride collection to update the database server. Note: This method must complete successfully before the commit method can be called to update the actual database.

Parameters:: qdrCollection - Contains a QDR override for each cell that was edited.
Throws:: QueryException - If any error occurs during the operation.
See Also:: commit()

commit

public boolean commit()
               throws QueryException

Updates the actual database with changes that have been posted to the database server by the submit method. Note: If a database is open in read-only mode, then the commit method will not succeed.

Throws:: QueryException - If any error occurs during the operation.
See Also:: submit(com.sun.java.util.collections.List)

setAutoUpdate

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

Controls whether operations should be sent to the middle tier for immediate processing or accumulated in a pending operations queue.

Overrides:: setAutoUpdate in class Query

Parameters:: b - true sends each operation for immediate processing; false lets operations accumulate in a pending operations queue.
Throws:: All - Any of the exceptions that are contained in the operations that are currently in the queue.

setDefaultColumnCount

public void setDefaultColumnCount(int numCol)

Specifies the default number of dimensions to put on a column for default layouts.

Overrides:: setDefaultColumnCount in class Query

Parameters:: numCol - The number of dimensions to put on the column for default layouts.

setDefaultRowCount

public void setDefaultRowCount(int numRow)

Specifies the default number of dimensions to put on a row for default layouts.

Overrides:: setDefaultRowCount in class Query

Parameters:: numRow - The number of dimensions to put on the row for default layouts.

setDebugMode

public void setDebugMode(boolean mode)

Indicates whether debug printouts should be produced.

Overrides:: setDebugMode in class Query

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

setHierarchicalDrilling

public void setHierarchicalDrilling(boolean hierDrill)

Indicates whether hierarchical drilling should be used exclusively f

Overrides:: setHierarchicalDrilling in class Query

Parameters:: hierDrill - true to always use hierarchical drilling

setPrintQueryState

public void setPrintQueryState(boolean mode)

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

Overrides:: setPrintQueryState in class Query

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

setAsymmetricDrilling

public void setAsymmetricDrilling(boolean asymmetric)

Indicates whether asymmetric drilling should be used

Overrides:: setAsymmetricDrilling in class Query

Parameters:: asymmetric - true to use asymmetric drilling

setSeparatePage

public void setSeparatePage(boolean separate)

Indicates whether pages are fetched as separate cursors

Overrides:: setSeparatePage in class Query

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

setFetchSize

public void setFetchSize(int size)

Sets fetch buffer size

Overrides:: setFetchSize in class Query

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

setFetchPageEdge

public void setFetchPageEdge(boolean fullfetch)

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

Overrides:: setFetchPageEdge in class Query

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

setSuppressionState

public void setSuppressionState(int index,
                                int suppress)
                         throws java.lang.ArrayIndexOutOfBoundsException

Specifies the suppression (none, NA, zero, or both NA and zero) for an edge of this Query when data is fetched.

Overrides:: setSuppressionState in class Query

Parameters:: index - A constant that represents the edge of interest. Valid edge constants are found in oracle.dss.util.DataDirector.; suppress - Identifies the kind of suppression. Valid suppression constants are found in oracle.dss.util.DataDirector.
Throws:: java.lang.ArrayIndexOutOfBoundsException - If index is invalid.
See Also:: DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataDirector.NO_SUPPRESSION, DataDirector.NA_SUPPRESSION, DataDirector.ZERO_SUPPRESSION, DataDirector.NA_ZERO_SUPPRESSION

setSuppressionState

public void setSuppressionState(int[] suppress)

Specifies the suppression state (none, NA, zero, or both NA and zero) to use for this Query when data is fetched.

Overrides:: setSuppressionState in class Query

Parameters:: suppress - An array that identifies the kind of suppression for each edge in a Query. The edge constants in oracle.dss.util.DataDirector provide an index into the array to identify column, row, or page edge. Valid suppression constants are found in oracle.dss.util.DataDirector.
See Also:: DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataDirector.NO_SUPPRESSION, DataDirector.NA_SUPPRESSION, DataDirector.ZERO_SUPPRESSION, DataDirector.NA_ZERO_SUPPRESSION

setSuppressColumns

public void setSuppressColumns(int suppress)

Specifies the suppression state (none, NA, zero, or both NA and zero) on the column edge of the query when data is fetched.

Overrides:: setSuppressColumns in class Query

Parameters:: suppress - Identifies the kind of suppression. Valid suppression constants are found in oracle.dss.util.DataDirector.
See Also:: DataDirector.NO_SUPPRESSION, DataDirector.NA_SUPPRESSION, DataDirector.ZERO_SUPPRESSION, DataDirector.NA_ZERO_SUPPRESSION

setSuppressRows

public void setSuppressRows(int suppress)

Specifies the suppression state (none, NA, zero, or both NA and zero) on the row edge of a query when data is fetched.

Overrides:: setSuppressRows in class Query

Parameters:: suppress - Identifies the kind of suppression. Valid suppression constants are found in oracle.dss.util.DataDirector.
See Also:: DataDirector.NO_SUPPRESSION, DataDirector.NA_SUPPRESSION, DataDirector.ZERO_SUPPRESSION, DataDirector.NA_ZERO_SUPPRESSION

setSharePage

public void setSharePage(boolean b)

Specifies whether page changes are transmitted among listeners. By default, if there are multiple listeners of any kind on a Query, then a change to the page edge of the query by one listener will be transmitted to the cursors of all the other listeners. (Each listener has its own copy of the cursor on the client side.)

Overrides:: setSharePage in class Query

Parameters:: b - true indicates that page changes should be shared among all listeners; false indicates that a page change by one listener will not be shared among the other listeners.

setCurrentPage

public void setCurrentPage(int page,
QDR qdrPage)

Specifies the current page if pages are shared among listeners.

Overrides:: setCurrentPage in class Query

Parameters:: page - Page number to share among listeners.; qdrPage - QDR version of the current page.

getCurrentPage

public int getCurrentPage()

Returns the current page number if shared among listeners Note this method may throw a QueryRuntimeException.

Overrides:: getCurrentPage in class Query

Returns:: Page number that is shared among listeners

getMetadataManager

public getMetadataManager()

Returns the current MetadataManager that is set on the QueryManager for this Query.

Overrides:: getMetadataManager in class Query

Returns:: The MetadataManager.

getDatabaseName

public java.lang.String getDatabaseName()

Retrieves the name of the current MetadataManager that is in use by the QueryManager object that tracks this Query.

Overrides:: getDatabaseName in class Query

Returns:: The name of the MetadataManager.

setBaseState

public void setBaseState()

Establishes a base state for the ThinBean from which state changes that go onto the state string are tracked. This call will effectively clear the thin bean's current state string. Note this method may throw a QueryRuntimeException.

setState

public void setState(java.lang.String state)

Specifies a state string that represents the changes on a ThinBean, since the ThinBean was created or since setBaseState() was called. This string is placed onto the URLs/Forms that an application generates, so that the application can re-establish the thin bean's state from a request's URL.

Placing an application's state onto a URL provides the ability for the application to support re-establishing application state from a bookmark. Note this method may throw a QueryRuntimeException.

Parameters:: state - A ThinBean state.

getState

public java.lang.String getState()

Retrieves a string that represents the changes in the state of a ThinBean since the ThinBean was created or since setBaseState() was called. This state string is placed onto the URLs/Forms that an application generates so that the application can re-establish the thin bean's state from a request's URL.

Placing an application's state onto the URL provides the ability for the application to support re-establishing application state from a bookmark. Note this method may throw a QueryRuntimeException.

Returns:: The state of the ThinBean.

getCheckpointState

public java.lang.String getCheckpointState()

Used to retrieve the state differences from the last time that state was checkpointed. Note this method may throw a QueryRuntimeException.

Returns:: the state differences from the last checkpoint

setCheckpointState

public void setCheckpointState(java.lang.String state)
                        throws ThinException

Used to set state differences from the last time that state was checkpointed.

Parameters:: state - the state differences from the last checkpoint
Throws:: ThinException - if the state could not be set

checkpointState

public void checkpointState()

Tells the ThinBean to start tracking state changes. Note this method may throw a QueryRuntimeException.

Following copied from interface: oracle.dss.thin.beans.CheckpointState

See Also:: ThinBean.getState(), BIStateManager

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.client Class QueryClient

QueryClient

QueryClient

setQueryManager

getQueryManager

setXMLValidated

setMeasures

getMeasures

clone

setEvaluateCursor

drill

drill

drill

drill

layout

getLayout

pivot

swap

swapEdges

applySelection

removeSelection

applySelections

findAllSelections

findSelection

findSelection

isDependentOn

setUniverseSelection

getUniverseSelection

addCubeMeasures

applyDataMap

applyMetadataMap

applyMetadataMap

initCubeQuery

initQuery

validate

validate

validate

validate

removeCubeMeasures

setDataMap

setMetadataMap

refresh

setQueryState

getQueryState

addUndoableEditListener

removeUndoableEditListener

close

submit

commit

setAutoUpdate

setDefaultColumnCount

setDefaultRowCount

setDebugMode

setHierarchicalDrilling

setPrintQueryState

setAsymmetricDrilling

setSeparatePage

setFetchSize

setFetchPageEdge

setSuppressionState

setSuppressionState

setSuppressColumns

setSuppressRows

setSharePage

setCurrentPage

getCurrentPage

getMetadataManager

getDatabaseName

setBaseState

setState

getState

getCheckpointState

setCheckpointState

checkpointState

oracle.dss.dataSource.client
Class QueryClient