oracle.dss.dataSource.common
Class LayoutEvent

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

LayoutChangedEvent, LayoutChangingEvent

public abstract class LayoutEvent

extends QueryEvent

Base class to distinguish layout sequence events.

See Also:

Serialized Form

Constructor Summary

LayoutEvent(java.lang.Object source, java.util.BitSet edges, java.lang.String[][] dimensions)
Constructor to use if the affected dimension names are available from the original call that changed the layout.

LayoutEvent(java.lang.Object source, java.util.BitSet edges, java.lang.String sourcedim, java.lang.String targetdim, java.lang.String[][] dimensions)
Constructor to use for a swap or pivot of specific dimensions.

LayoutEvent(java.lang.Object source, java.util.BitSet edges, java.lang.String sourcedim, java.lang.String targetdim, java.lang.String[][] dimensions, int flags)
Constructor to use to specify the kind of pivot.

LayoutEvent(java.lang.Object source, int sourceedge, int targetedge, java.lang.String[][] dimensions)
Constructor to use for an edge swap.

Method Summary

java.lang.String[][]	getDimensions() Retrieves the layout of this event.
int	getFlags() Retrieves flags that indicate the kind of layout change.
java.lang.String	getSourceDimension() Retrieves the name of the source dimension, if any.
java.lang.String	getTargetDimension() Retrieves the name of the target dimension, if any.
boolean	isEdgeDirty(int edge) Determines whether an edge is dirty.

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

LayoutEvent

public LayoutEvent(java.lang.Object source,
                   java.util.BitSet edges,
                   java.lang.String[][] dimensions)

Constructor to use if the affected dimension names are available from the original call that changed the layout. Specifically, the constructor to use when the layout method of the Query class is called.

Parameters:

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

edges - A list of the dirty edges, if known. In this list, to refer to edges, use the constants DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE.

dimensions - The names of the dimensions that were affected by the call that changed the layout. This is the same parameter that is used in the layout method call in the Query class.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

LayoutEvent

public LayoutEvent(java.lang.Object source,
                   java.util.BitSet edges,
                   java.lang.String sourcedim,
                   java.lang.String targetdim,
                   java.lang.String[][] dimensions,
                   int flags)

Constructor to use to specify the kind of pivot.

Parameters:

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

edges - A list of the dirty edges, if known. In this list, to refer to edges, use the constants DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE.

sourcedim - The name of the source dimension for a pivot or swap.

targetdim - The name of the target dimension for a pivot or swap.

dimensions - The names of the dimensions that were affected by the call that changed the layout. This is the same parameter that is used in the layout method call in the Query class.

flags - A constant that indicates the type of pivot. Use either PivotConstants.PIVOT_AFTER or PivotConstants.PIVOT_BEFORE.

See Also:

PivotConstants.PIVOT_AFTER, PivotConstants.PIVOT_BEFORE, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

LayoutEvent

public LayoutEvent(java.lang.Object source,
                   java.util.BitSet edges,
                   java.lang.String sourcedim,
                   java.lang.String targetdim,
                   java.lang.String[][] dimensions)

Constructor to use for a swap or pivot of specific dimensions.

Parameters:

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

edges - A list of the dirty edges, if known. In this list, to refer to edges, use the constants DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE.

sourcedim - The name of the source dimension for a pivot or swap.

targetdim - The name of the target dimension for a pivot or swap.

dimensions - The names of the dimensions that were affected by the call that changed the layout. This is the same parameter that is used in the layout method call in the Query class.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

LayoutEvent

public LayoutEvent(java.lang.Object source,
                   int sourceedge,
                   int targetedge,
                   java.lang.String[][] dimensions)

Constructor to use for an edge swap.

Parameters:

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

sourceedge - A constant (DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE) that represents the source edge for an edge swap.

targetedge - A constant (DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE) that represents the target edge for an edge swap.

dimensions - The names of the dimensions that were affected by the call that changed the layout. This is the same parameter that is used in the layout method call in the Query class.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

Method Detail

getDimensions

public java.lang.String[][] getDimensions()

Retrieves the layout of this event.

Returns:

The dimension layout.

isEdgeDirty

public boolean isEdgeDirty(int edge)

Determines whether an edge is dirty.

Parameters:

edge - A constant (DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, or DataDirector.ROW_EDGE) that represents the edge to check.

Returns:

true if the edge is dirty, false if not.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getSourceDimension

public java.lang.String getSourceDimension()

Retrieves the name of the source dimension, if any.

Returns:

The name of the source dimension for a pivot or swap, or null if a direct layout.

getTargetDimension

public java.lang.String getTargetDimension()

Retrieves the name of the target dimension, if any.

Returns:

The name of the target dimension for a pivot or swap, or null if a direct layout.

getFlags

public int getFlags()

Retrieves flags that indicate the kind of layout change.

Returns:

A constant (PivotConstants.PIVOT_AFTER or PivotConstants.PIVOT_BEFORE) that represents the kind of pivot; -1 if not a pivot.

See Also:

PivotConstants.PIVOT_AFTER, PivotConstants.PIVOT_BEFORE