oracle.dss.dataSource.common
Class StateChangeEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

StateChangedEvent, StateChangingEvent

public abstract class StateChangeEvent

extends QueryEvent

Base class for events that indicate that the state of a Query object has been changed or is about to be changed.

See Also:

Serialized Form

Field Summary

static int	DATA_MAP A constant that represents a Data map change for a Query object.
static int	METADATA_MAP A constant that represents a Metadata map change for a Query object.
static int	REDO A constant that represents the Redo type of state change for a Query object.
static int	STATE A constant that represents a state marker type of change for a Query object.
static int	UNDO A constant that represents the Undo type of state change for a Query object.
static int	UNIVERSE A constant that represents a Universe selection change for a Query object.

Constructor Summary

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

StateChangeEvent(java.lang.Object source, op, int t)
Constructs the event for a specific operation.

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

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

Method Summary

interface	getOperation() Retrieves the Operation object that will be undone or redone.
int	getType() Retrieves the type of state change: undo, redo, or state change

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

Field Detail

UNDO

public static final int UNDO

A constant that represents the Undo type of state change for a Query object. This type of change occurs when the undo method of the QueryEdit object is called.

REDO

public static final int REDO

A constant that represents the Redo type of state change for a Query object. This type of change occurs when the redo method of the QueryEdit object is called.

STATE

public static final int STATE

A constant that represents a state marker type of change for a Query object. This constant is used when constructing a StateChangedEvent after the state of a Query object has been reset to a previous state by invoking the BaseManager.setQueryState method.

METADATA_MAP

public static final int METADATA_MAP

A constant that represents a Metadata map change for a Query object.

DATA_MAP

public static final int DATA_MAP

A constant that represents a Data map change for a Query object.

UNIVERSE

public static final int UNIVERSE

A constant that represents a Universe selection change for a Query object.

Constructor Detail

StateChangeEvent

public StateChangeEvent(java.lang.Object source,
                         op,
                        int t)

Constructs the event for a specific operation.

Parameters:

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

op - An Operation object.

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

See Also:

REDO, STATE, UNDO

StateChangeEvent

public StateChangeEvent(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; null means all dimensions.

m - The Map object that is involved.

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

See Also:

DATA_MAP, METADATA_MAP

StateChangeEvent

public StateChangeEvent(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.

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 for which the map has changed.

m - The Map object that is involved.

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

See Also:

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

StateChangeEvent

public StateChangeEvent(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 the dimension of the universe selection that is involved in the query change.

s - The Selection object that will be used after the change.

Method Detail

getOperation

public getOperation()

Retrieves the Operation object that will be undone or redone.

Returns:

The Operation object that will be undone or redone.

getType

public int getType()

Retrieves the type of state change: undo, redo, or state change

Returns:

A constant (UNDO, REDO, or STATE) that represents the type of state change.

See Also:

REDO, STATE, UNDO