oracle.dss.dataSource.common
Interface DrillManager

All Superinterfaces:

BaseManager

All Known Implementing Classes:

Query, QueryServer

public interface DrillManager

extends BaseManager

Defines methods that perform various drill operations. A drill operation is really a short-cut for applying one or more complicated Steps to the specified dimension; this implies that a drill operation represents a change to the underlying query.

Method Summary

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 later optimization of drill steps.
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.

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

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 later optimization of drill steps.

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 specifying dimension/member pairs limiting 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 indicating the numeric level at which the drill target sits within its hierarchy

parentQDR - An optional OlapQDR specifying dimension/member pairs limiting 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 the dimension member, to drill.

hierarchy - The target hierarchy.

level - The target level to traverse to.

action - A constant (Step.ADD, Step.KEEP, Step.REMOVE, or Step.SELECT) that represents the selection step action.

flags - A list of optional flags. These flags are drill constants that begin with the prefix DRILL_EXCLUDE_.

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.

See Also:

DrillConstants.DRILL_EXCLUDE_RANGE, DrillConstants.DRILL_EXCLUDE_SELF, DrillConstants.DRILL_EXCLUDE_SIBLINGS, Step.ADD, Step.KEEP, Step.REMOVE, Step.SELECT