oracle.dss.dataSource.common
Class StateChangingEvent

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

All Implemented Interfaces:

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

public class StateChangingEvent

extends StateChangeEvent

implements Consumable

Informs listeners that the state of a Query object is about to be changed. A listener can veto this change by calling the consume method of this class.

See Also:

Serialized Form

Fields inherited from class oracle.dss.dataSource.common.StateChangeEvent

DATA_MAP, METADATA_MAP, REDO, STATE, UNDO, UNIVERSE

Constructor Summary

StateChangingEvent(java.lang.Object source, int type)
Constructs the event.

StateChangingEvent(java.lang.Object source, int e, AbstractMap m, int t)
Constructs the event with maps for a change on a specific edge of the Query object.

StateChangingEvent(java.lang.Object source, java.lang.String d, AbstractMap m, int t)
Constructs the event with maps for a change in one or more dimensions.

StateChangingEvent(java.lang.Object source, java.lang.String d, Selection s)
Constructs the event with a selection.

Method Summary

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

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

getOperation, getType

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

StateChangingEvent

public StateChangingEvent(java.lang.Object source,
                          int type)

Constructs the event.

Parameters:

source - Source of the event, that is, a reference to the object that fired the event.

type - A constant (StateChangeEvent.UNDO, StateChangeEvent.REDO, or StateChangeEvent.STATE) that represents the type of state change that is proposed for the Query object.

See Also:

StateChangeEvent.REDO, StateChangeEvent.STATE, StateChangeEvent.UNDO

StateChangingEvent

public StateChangingEvent(java.lang.Object source,
                          java.lang.String d,
AbstractMap m,
                          int t)

Constructs the event with maps for a change in one or more dimensions.

Parameters:

source - Source of the event, that is, a reference to the object that fired the event.

d - The name of the dimension of the map that is involved; nullm - The Map object that will be applied or set.

t - A constant <<code>StateChangeEvent.DATA_MAP or StateChangeEvent.METADATA_MAP) that represents the type of map state change for the Query object.

See Also:

StateChangeEvent.DATA_MAP, StateChangeEvent.METADATA_MAP

StateChangingEvent

public StateChangingEvent(java.lang.Object source,
                          int e,
AbstractMap m,
                          int t)

Constructs the event with maps for a change on a specific edge of the Query object.

Parameters:

source - Source of the event, that is, a reference to the object that fired the event.

e - A constant (such as DataDirector.ROW_EDGE) that represents the edge of the map that has changed.

m - The Map object that will be applied or set.

t - A constant (StateChangeEvent.DATA_MAP, or StateChangeEvent.METADATA_MAP) that indicates the type of map state change to the Query object.

See Also:

StateChangeEvent.DATA_MAP, StateChangeEvent.METADATA_MAP, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

StateChangingEvent

public StateChangingEvent(java.lang.Object source,
                          java.lang.String d,
Selection s)

Constructs the event with a selection.

Parameters:

source - Source of the event, that is, a reference to the object that fired the event.

d - The name of a dimension of the universe selection that is involved in the query change.

s - The new selection to which the query is changing.

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.