oracle.dss.dataSource.common
Interface SelectionManager

All Superinterfaces:

BaseManager

All Known Implementing Classes:

Query, QueryServer

public interface SelectionManager

extends BaseManager

Defines methods for accessing Selection objects that represent an ordered list of query steps for a particular dimension.

Method Summary

void	applySelection(Selection selection) Applies the specified Selection object to the corresponding Selection object in this Query.
void	applySelections(Selection[] selections) Applies the specified Selection objects to the corresponding Selection objects in the Query.
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.
Selection	getUniverseSelection(java.lang.String dimension) Retrieves the Selection object that is currently used as the starting universe for the specified dimension.
void	removeSelection(Selection selection) Removes the specified Selection object from this Query.
void	setUniverseSelection(java.lang.String dimension, Selection selection) Specifies a Selection object for the starting universe that corresponds to the specified dimension.

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

applySelection

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

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

Parameters:

selection - The Selection to apply.

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 specified Selection objects to the corresponding Selection objects in the Query.

Parameters:

selections - The Selection objects to apply.

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.

removeSelection

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

Removes the specified Selection object from this Query.

Parameters:

selection - The Selection object 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.

findAllSelections

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

Retrieves a reference to the complete collection of Selection objects for this Query. Each Selection 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.

Returns:

The list of Selection objects.

findSelection

public Selection findSelection(java.lang.String dimension)

Retrieves a Selection object that corresponds to the specified dimension.

Parameters:

dimension - The name of the dimension for which the current Selection object should be returned.

Returns:

The Selection object that corresponds to the specified dimension.

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.

Parameters:

dimension - The dimensions for which to return the current Selection object.

Returns:

The Selection object that corresponds to the specified dimensions.

setUniverseSelection

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

Specifies a Selection object for the starting universe that corresponds to the specified dimension. This selection scopes the specified dimension for all future selection work that is applied to that dimension or query. Note that universe Selections may not be set for the measure dimension.

Parameters:

dimension - The dimension for which the universe will be specified.

selection - The Selection to specify as the universe.

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.

getUniverseSelection

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

Retrieves the Selection object that is currently used as the starting universe for the specified dimension.

Parameters:

The - dimension for which the universe selection will be retrieved.

Returns:

The universe Selection object; null if there is no universe Selection object.

Throws:

IllegalArgException - If arguments are invalid.