oracle.dss.dataSource.common
Class DrillRequestingEvent

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

All Implemented Interfaces:

java.lang.Cloneable, Consumable, java.io.Serializable

public class DrillRequestingEvent

extends DrillEvent

implements Consumable

Informs listeners when a drill operation is requested. A listener has the option to veto the drill operation by calling the consume method of this event. If a listener vetoes the operation, then subsequent listeners are not notified and the operation is cancelled (that is, not added to the pending operation queue).

See Also:

Serialized Form

Constructor Summary

DrillRequestingEvent(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.

DrillRequestingEvent(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

void	consume() Consumes this event.
boolean	isConsumed() Indicates whether this event was consumed.

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

getAction, getDelta, getDimension, getFlags, getHierarchy, getLevel, getLevelDepth, getParentQDR, getQueryParent, getValue, getValueParent

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

DrillRequestingEvent

public DrillRequestingEvent(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)

DrillRequestingEvent

public DrillRequestingEvent(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 - dimension value to drill

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

consume

public void consume()

Consumes this event.

Specified by:

consume in interface Consumable

Overrides:

consume in class QueryEvent

isConsumed

public boolean isConsumed()

Indicates whether this event was consumed.

Specified by:

isConsumed in interface Consumable

Overrides:

isConsumed in class QueryEvent

Returns:

true if the event was consumed, false if not.