oracle.dss.dataSource.common
Interface MainManager

All Superinterfaces:

BaseManager

All Known Implementing Classes:

Query, QueryServer

public interface MainManager

extends BaseManager

Defines methods that shape the Query object at a query level.

Method Summary

void	addCubeMeasures(java.lang.String[] measures) Adds one or more measures to an existing query in a Query object.
void	applyDataMap(DataMap map) Adds the types in the specified data map to the DataMap for this Query object.
void	applyMetadataMap(int edge, MetadataMap map) Adds the types in the specified metadata map to the MetadataMap of this Query object.
void	applyMetadataMap(java.lang.String dimension, MetadataMap map) Adds the types in the specified metadata map to the MetadataMap for a specific dimension in this Query object.
DataMap	getDataMap() Retrieves a map that represents all data types requested by all current clients of this Query object.
java.lang.String[]	getMeasures() Retrieves a list of the measure names that a Query object is using.
MetadataMap	getMetadataMap(int edge) Retrieves a map that represents all metadata types that were requested by all current clients of this Query for the specified edge.
MetadataMap	getMetadataMap(java.lang.String dimension) Retrieves a map that represents all metadata types that were requested by all current clients of this Query object for the specified dimension.
void	initCubeQuery(java.lang.String[] measures, java.lang.String[][] dimensions) Initializes a Query object 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 if the query makes use of the object in its selections or measure list.
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	setDataMap(DataMap map) Specifies a map that determines the contents of future data cursors for this query for all clients of this Query.
void	setMetadataMap(java.lang.String dimension, MetadataMap map) Specifies a map that determines the contents of future metadata cursors for all clients of this Query object.
ValidationObject	validate(int validationType) Validates the entire Query object with OLAPI.
ValidationObject	validate(int validationType, int edge) Validates an entire edge of a query with OLAPI.
ValidationObject	validate(int validationType, Selection selection) Validates a Selection with OLAPI.
ValidationObject	validate(int validationType, Step step) Validates a specific Step with OLAPI.

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

addQueryListener, cancel, clone, getFetchPageEdge, getFetchSize, getQueryState, getSuppressionState, isAsymmetricDrilling, isAutoUpdate, isEvaluateCursor, isHierarchicalDrilling, isUpdatePending, removeQueryListener, setAsymmetricDrilling, setAutoUpdate, setEvaluateCursor, setFetchPageEdge, setFetchSize, setHierarchicalDrilling, setQueryState, setSuppressionState, update

Method Detail

addCubeMeasures

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

Adds one or more measures to an existing query in a Query object. Creates a query if none exists.

Parameters:

measures - An array of the names of the measures to add to the 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.

applyDataMap

public void applyDataMap(DataMap map)

Adds the types in the specified data map to the DataMap for this Query object. These data map types will be included in subsequent data cursors for the Query object.

Parameters:

map - The DataMap that contains the desired types (such as formatted or unformatted data).

applyMetadataMap

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

Adds the types in the specified metadata map to the MetadataMap for a specific dimension in this Query object. These metadata types will be included in subsequent metadata cursors for this Query object.

Parameters:

dimension - The dimension to which this map should be applied.

map - The MetadataMap that contains the desired types (such as short labels or long labels).

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

Adds the types in the specified metadata map to the MetadataMap of this Query object. These metadata types will be included in subsequent metadata cursors for the edges of this Query object.

Parameters:

edge - The edge to which these metadata types apply. Use the oracle.dss.util.DataDirector constants with the suffix _EDGE to specify edges.

map - The MetadataMap that contains the desired types (such as short labels or long labels).

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.ROW_EDGE, DataDirector.PAGE_EDGE

initCubeQuery

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

Initializes a Query object based on one or more specified measures. The dimensions parameter is optional when initializing a cube (or multidimensional) query.

Parameters:

measures - An array of measure names.

dimensions - An 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 - An array of dimension layout arrays.

measure - An optional measure. (If null, the OLAPI 'Value' Source will be used.)

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.

getDataMap

public DataMap getDataMap()

Retrieves a map that represents all data types requested by all current clients of this Query object.

Returns:

A map that contains all the data types that were requested.

getMetadataMap

public MetadataMap getMetadataMap(java.lang.String dimension)

Retrieves a map that represents all metadata types that were requested by all current clients of this Query object for the specified dimension.

Parameters:

dimension - The dimension for which metadata types have been requested. null if default.

Returns:

A map that contains all the metadata types that were requested.

getMetadataMap

public MetadataMap getMetadataMap(int edge)

Retrieves a map that represents all metadata types that were requested by all current clients of this Query for the specified edge.

Parameters:

edge - The edge for which metadata types have been requested. To specify an edge, use one of the constants that end with _EDGE in oracle.dss.util.DataDirector.

Returns:

A map that contains all the metadata types for the specified edge for all current clients.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE

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 - An array of the names of the measures to be removed.

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 map that determines the contents of future data cursors for this query for all clients of this Query. (Resets cumulative applyDataMap operations; generally only called on a clone of the Query.)

Parameters:

map - The map that contains the desired data types.

setMetadataMap

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

Specifies a map that determines the contents of future metadata cursors for all clients of this Query object. (Resets cumulative applyMetadataMap operations; generally only called on a clone of the Query.)

Parameters:

dimension - The name of the dimension for which the MetadataMap is to be specified.

map - The MetadataMap that contains the desired metadata 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 - if true, refreshes the structural elements of the query such as calculations. If false, false a minimal refresh from the database is performed

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.

getMeasures

public java.lang.String[] getMeasures()

Retrieves a list of the measure names that a Query object is using.

Returns:

An array of measure names.

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 if the query makes use of the object in its selections or measure list.

Parameters:

object - MDObject representing the object to check

Returns:

true if the query uses the object, false otherwise

validate

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

Validates the entire Query object with OLAPI.

Parameters:

validationType - OR-able constants that indicate the 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 an entire edge of a query with OLAPI.

Parameters:

validationType - OR-able constants that indicate 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 OLAPI.

Parameters:

validationType - OR-able constants that indicate the types of validation to perform.

selection - 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

Validates a specific Step with OLAPI.

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