oracle.dss.dataView
Class PivotEvent

java.lang.Object
  java.util.EventObject
      oracle.dss.dataView.DataviewEvent
          oracle.dss.dataView.PivotEvent

All Implemented Interfaces:

java.io.Serializable

public class PivotEvent
extends DataviewEvent

The event that describes a pivot from the Dataview. This event also describes reorders in Crosstab measures and in the Table column header.

See Also:

Serialized Form

Field Summary

static int	TYPE_PIVOT PivotType: Pivot.
static int	TYPE_REORDER PivotType: Reorder.

Fields inherited from class oracle.dss.dataView.DataviewEvent

consumed

Fields inherited from class java.util.EventObject

source

Constructor Summary

PivotEvent(java.lang.Object source, int fromEdge, int toEdge)
Constructor for an edge swap.

PivotEvent(java.lang.Object source, int fromEdge, int toEdge, int fromLayer, int toLayer, int _flags)
Constructor.

PivotEvent(java.lang.Object source, int fromEdge, int toEdge, int fromLayer, int toLayer, int fromSlice, int toSlice, int _flags, int pivotType)

Method Summary

int	getFromDimension() Retrieves the from dimension.
int	getFromEdge() Retrieves the from edge.
int	getFromSlice() Retrieves the from slice.
int	getPivotType() Retrieves the type (pivot or reorder) of this pivot event.
int	getToDimension() Retrieves the to dimension.
int	getToEdge() Retrieves the to edge.
int	getToSlice() Retrieves the to slice.
boolean	isDimensionSwap() Indicates whether dimensions (layers) are being swapped.
boolean	isEdgeSwap() Indicates whether edges are being swapped.
boolean	isMoveAfter() Indicates whether a dimension or item is being moved after another.
boolean	isMoveBefore() Indicates whether a dimension or item is being moved before another.

Methods inherited from class oracle.dss.dataView.DataviewEvent

consume, isConsumed

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_PIVOT

public static final int TYPE_PIVOT

PivotType: Pivot.

See Also:

Constant Field Values

TYPE_REORDER

public static final int TYPE_REORDER

PivotType: Reorder. Applies to Crosstab measure reordering and Table column reordering.

See Also:

Constant Field Values

Constructor Detail

PivotEvent

public PivotEvent(java.lang.Object source,
                  int fromEdge,
                  int toEdge,
                  int fromLayer,
                  int toLayer,
                  int _flags)

Constructor.

Parameters:

source - The source of the event.

fromEdge - The edge from which an item is being pivoted.

toEdge - The edge to which an item is being pivoted.

fromLayer - The layer (dimension) from which an item is being pivoted.

toLayer - the layer (dimension) to which an item is being pivoted.

_flags - A constant that identifies the nature of the pivot action. Valid constants are listed in the See Also section.

See Also:

DataDirector.PIVOT_MOVE_AFTER, DataDirector.PIVOT_MOVE_BEFORE, DataDirector.PIVOT_MOVE_TO, DataDirector.PIVOT_SWAP, DataDirector.PIVOT_EDGES

PivotEvent

public PivotEvent(java.lang.Object source,
                  int fromEdge,
                  int toEdge)

Constructor for an edge swap. Sets the flags to DataDirector.PIVOT_EDGES.

Parameters:

source - The source of the event.

fromEdge - The first edge.

toEdge - The edge to swap with fromEdge.

See Also:

DataDirector.PIVOT_EDGES

PivotEvent

public PivotEvent(java.lang.Object source,
                  int fromEdge,
                  int toEdge,
                  int fromLayer,
                  int toLayer,
                  int fromSlice,
                  int toSlice,
                  int _flags,
                  int pivotType)

Parameters:

source - the event source

fromEdge - the edge pivoting from

toEdge - the edge pivoting to

fromLayer - the layer (dimension) pivoting from

toLayer - the layer (dimension) pivoting to

fromSlice - the slice reordering from

toLayer - the slice reordering to

_flags - enumerated flag value indicating the type of pivot (move before, move after, swap, edge)

pivotType - indicates if this is a pivot or a reorder

See Also:

TYPE_PIVOT, TYPE_REORDER

Method Detail

getFromEdge

public int getFromEdge()

Retrieves the from edge.

Returns:

The original edge, from which an item is being pivoted.

getToEdge

public int getToEdge()

Retrieves the to edge.

Returns:

The new edge, to which an item is being pivoted.

getFromDimension

public int getFromDimension()

Retrieves the from dimension.

Returns:

The dimension from which an item is being pivoted, or -1 if edges are being swapped.

getToDimension

public int getToDimension()

Retrieves the to dimension.

Returns:

The dimension to which an item is being pivoted to, or -1 if edges are being swapped.

getFromSlice

public int getFromSlice()

Retrieves the from slice. This slice is only used for Crosstab measure reordering.

Returns:

The slice from which an item is being reordered.

See Also:

getPivotType()

getToSlice

public int getToSlice()

Retrieves the to slice. This slice is only used for Crosstab measure reordering.

Returns:

The slice to which an item is being reordered.

See Also:

getPivotType()

isEdgeSwap

public boolean isEdgeSwap()

Indicates whether edges are being swapped.

Returns:

true if the nature of the pivot is DataDirector.PIVOT_EDGES, false if it is not.

See Also:

DataDirector.PIVOT_EDGES

isDimensionSwap

public boolean isDimensionSwap()

Indicates whether dimensions (layers) are being swapped.

Returns:

true if the nature of the pivot is DataDirector.PIVOT_SWAP, false if it is not.

See Also:

DataDirector.PIVOT_SWAP

isMoveAfter

public boolean isMoveAfter()

Indicates whether a dimension or item is being moved after another.

Returns:

true if the nature of the pivot is DataDirector.PIVOT_MOVE_AFTER, false if it is not.

See Also:

DataDirector.PIVOT_MOVE_AFTER

isMoveBefore

public boolean isMoveBefore()

Indicates whether a dimension or item is being moved before another.

Returns:

true if the nature of the pivot is DataDirector.PIVOT_MOVE_BEFORE, false if it is not.

See Also:

DataDirector.PIVOT_MOVE_BEFORE

getPivotType

public int getPivotType()

Retrieves the type (pivot or reorder) of this pivot event. The default is TYPE_PIVOT.

Returns:

TYPE_REORDER for Crosstab measure reordering and Table column reordering, otherwise TYPE_PIVOT.

See Also:

TYPE_PIVOT, TYPE_REORDER