oracle.dss.dataSource.common
Class DrillEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.dss.dataSource.common.QueryEvent
              |
              +--oracle.dss.dataSource.common.DrillEvent

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

DrillRequestedEvent, DrillRequestingEvent

public abstract class DrillEvent

extends QueryEvent

Base class to distinguish drill sequence events.

See Also:

Serialized Form

Constructor Summary

DrillEvent(java.lang.Object source, 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)
Constructor to use to drill to a relative level of the specified hierarchy.

DrillEvent(java.lang.Object source, java.lang.String dimension, java.lang.String value, java.lang.String hierarchy, java.lang.String level, int action, java.util.BitSet flags)
Constructor to use to drill to a specific level of the specified hierarchy.

Method Summary

int	getAction() Retrieves the selection step action flag.
int	getDelta() Retrieves the relative number of levels to traverse within the specified hierarchy.
java.lang.String	getDimension() Retrieves the dimension to drill.
java.util.BitSet	getFlags() Retrieves a list of optional flags that are drill constants.
java.lang.String	getHierarchy() Retrieves the target hierarchy that defines the drill semantics.
java.lang.String	getLevel() Retrieves the name of the target level to traverse to.
int	getLevelDepth() Retrieves the leveldepth of the target from the drill call.
OlapQDR	getParentQDR() Retrieves the parent QDR parameter of the drill call.
java.lang.String	getQueryParent() Retrieves the query parent parameter from the drill call.
java.lang.String	getValue() Retrieves the dimension value (also known as the dimension member) that is being drilled.
java.lang.String	getValueParent() Retrieves the parent parameter from the drill call.

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

clone

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DrillEvent

public DrillEvent(java.lang.Object source,
                  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)

Constructor to use to drill to a relative level of the specified hierarchy.

Parameters:

source - The source of the event, that is, the object that fired the event.

dimension - The dimension to drill

value - The dimension value, also known as dimension member, to be drilled.

hierarchy - The target hierarchy that defines the drill semantics.

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)

DrillEvent

public DrillEvent(java.lang.Object source,
                  java.lang.String dimension,
                  java.lang.String value,
                  java.lang.String hierarchy,
                  java.lang.String level,
                  int action,
                  java.util.BitSet flags)

Constructor to use to drill to a specific level of the specified hierarchy.

Parameters:

source - The source of the event, that is, the object that fired the event.

dimension - The dimension to drill

value - The dimension value, also known as dimension member, to be drilled.

hierarchy - The target hierarchy that defines the drill semantics.

level - The name of 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_.

See Also:

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

Method Detail

getDimension

public java.lang.String getDimension()

Retrieves the dimension to drill.

Returns:

The dimension to drill.

getValue

public java.lang.String getValue()

Retrieves the dimension value (also known as the dimension member) that is being drilled.

Returns:

The dimension member that is being drilled.

getQueryParent

public java.lang.String getQueryParent()

Retrieves the query parent parameter from the drill call.

Returns:

The query parent parameter.

getValueParent

public java.lang.String getValueParent()

Retrieves the parent parameter from the drill call.

Returns:

The parent parameter.

getParentQDR

public OlapQDR getParentQDR()

Retrieves the parent QDR parameter of the drill call.

Returns:

The parent QDR of the drill call

getLevelDepth

public int getLevelDepth()

Retrieves the leveldepth of the target from the drill call.

Returns:

The target's leveldepth.

getHierarchy

public java.lang.String getHierarchy()

Retrieves the target hierarchy that defines the drill semantics.

Returns:

The target hierarchy.

getLevel

public java.lang.String getLevel()

Retrieves the name of the target level to traverse to.

Returns:

The target level to traverse to, if a specific level is identified; null if the drill is to a relative level.

getDelta

public int getDelta()

Retrieves the relative number of levels to traverse within the specified hierarchy.

Returns:

The relative number of levels. Positive numbers indicate drill down; negative numbers indicate drill up.

getFlags

public java.util.BitSet getFlags()

Retrieves a list of optional flags that are drill constants.

Returns:

The list of flags. These flags are drill constants that begin with the prefix DRILL_EXCLUDE_.

See Also:

DrillConstants.DRILL_EXCLUDE_RANGE, DrillConstants.DRILL_EXCLUDE_SELF, DrillConstants.DRILL_EXCLUDE_SIBLINGS

getAction

public int getAction()

Retrieves the selection step action flag.

Returns:

A constant that represents the selection step action, such as Step.ADD, or -1, if there is no selection step action.

See Also:

Step.ADD, Step.KEEP, Step.REMOVE, Step.SELECT