oracle.dss.dataView
Interface ControllerActions

All Known Implementing Classes:

GaugeModelAdapter, GraphModelAdapter, ModelAdapter

public interface ControllerActions

Method Summary

boolean	canDrill(java.lang.Object source, int edge, int layer, int slice, int flags) Indicates whether a drill gesture is legal.
boolean	canPivot(java.lang.Object source, int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) Indicates whether a pivot operation is legal.
boolean	drillGestureHappened(java.lang.Object source, int edge, int layer, int slice, int flags) Drills in data.
boolean	pageChangeHappened(java.lang.Object source, int pos) Changes the current page.
boolean	pageChangeHappened(java.lang.Object source, int[] hPos, int maxLayerSpecified) Changes the current page.
boolean	pivotGestureHappened(java.lang.Object source, int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) Pivots data.

Method Detail

pivotGestureHappened

boolean pivotGestureHappened(java.lang.Object source,
                             int fromEdge,
                             int toEdge,
                             int fromLayer,
                             int toLayer,
                             int flags)
                             throws EdgeOutOfRangeException,
                                    LayerOutOfRangeException,
                                    DataDirectorException

Pivots data. This method first fires a viewPivotRequesting event. If the event is not consumed, this method then calls the pivot method in the data director, to pivot the data in the data source. After the call to the data director, this method fires a viewPivotRequested event.

The view calls this method when a pivot gesture is detected in the UI.

Parameters:

source - The source of any events that this method fires. The DataView passes this as this parameter.

fromEdge - A constant that represents the edge to pivot from, such as COLUMN_EDGE. Edge constants are defined in the DataDirector interface.

toEdge - A constant that represents the edge to pivot to.

fromLayer - The layer to pivot from. The layer identifies the location of the dimension or dimension member on the edge. Zero is the outer-most dimension on the edge.

toLayer - The layer to pivot to.

flags - A constant that represents the type of pivot to perform, such as PIVOT_SWAP or PIVOT_MOVE_BEFORE. The constants are defined in the DataDirector interface, and they all begin with PIVOT_.

Returns:

true if the data director performs the pivot, false if the pivot is not performed for some reason.

Throws:

EdgeOutOfRangeException - If either edge parameter is too large.

LayerOutOfRangeException - If either layer parameter is negative or too large.

DataDirectorException - If a data provider error occurs.

See Also:

DataDirector

canPivot

boolean canPivot(java.lang.Object source,
                 int fromEdge,
                 int toEdge,
                 int fromLayer,
                 int toLayer,
                 int flags)
                 throws EdgeOutOfRangeException,
                        LayerOutOfRangeException,
                        DataDirectorException

Indicates whether a pivot operation is legal. This method calls the pivotOK method in the data director, to pivot the data in the data source. The view calls this method when a pivot gesture is detected in the UI.

Parameters:

source - The source of any events that this method fires. The DataView passes this as this parameter.

fromEdge - A constant that represents the edge to pivot from, such as COLUMN_EDGE. Edge constants are defined in the DataDirector interface.

toEdge - A constant that represents the edge to pivot to.

fromLayer - The layer to pivot from. The layer identifies the location of the dimension or dimension member on the edge. Zero is the outer-most dimension on the edge.

toLayer - The layer to pivot to.

flags - A constant that represents the type of pivot to perform, such as PIVOT_SWAP or PIVOT_MOVE_BEFORE. The constants are defined in the DataDirector interface, and they all begin with PIVOT_.

Returns:

true if the pivot operation is legal, false if not.

Throws:

EdgeOutOfRangeException - If either edge parameter is too large.

LayerOutOfRangeException - If either layer parameter is negative or too large.

DataDirectorException - If a data provider error occurs.

See Also:

DataDirector

drillGestureHappened

boolean drillGestureHappened(java.lang.Object source,
                             int edge,
                             int layer,
                             int slice,
                             int flags)
                             throws EdgeOutOfRangeException,
                                    LayerOutOfRangeException,
                                    SliceOutOfRangeException,
                                    DataDirectorException

Drills in data. The view calls this method when a drill gesture is detected in the UI.

Parameters:

source - The source of any events that this method fires. The DataView passes this as this parameter.

edge - A constant that represents the edge to drill, such as COLUMN_EDGE. Edge constants are defined in the DataDirector interface.

layer - The layer to drill. The layer identifies the location of the dimension or dimension member on the edge. Zero is the outer-most layer on the edge.

slice - The slice to drill. The slice is zero-based. Each layer member in the innermost dimension has a unique slice. In outer layers, any slice that the outer layer spans can be used.

flags - A constant that represents the type of drill to perform, such as DRILLSTATE_DRILLABLE to drill down in data. Drill constants are defined in the DataDirector interface. They begin with DRILLSTATE_.

Returns:

true if the data director performs the drill, false if not.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

DataDirectorException - If a data provider error occurs.

See Also:

DataDirector

canDrill

boolean canDrill(java.lang.Object source,
                 int edge,
                 int layer,
                 int slice,
                 int flags)
                 throws EdgeOutOfRangeException,
                        LayerOutOfRangeException,
                        SliceOutOfRangeException,
                        DataDirectorException

Indicates whether a drill gesture is legal. The view calls this method when a drill gesture is detected in the UI.

Parameters:

source - The source of any events that this method fires. The DataView passes this as this parameter.

edge - A constant that represents the edge to drill, such as COLUMN_EDGE. Edge constants are defined in the DataDirector interface.

layer - The layer to drill. The layer identifies the location of the dimension or dimension member on the edge. Zero is the outer-most layer on the edge.

slice - The slice to drill. The slice is zero-based. Each layer member in the innermost layer has a unique slice. In outer layers, any slice that the outer layer spans can be used.

flags - A constant that represents the type of drill to perform, such as DRILLSTATE_DRILLABLE to drill down in data. Drill constants are defined in the DataDirector interface. They begin with DRILLSTATE_.

Returns:

true if the drill operation is legal, false if not.

Throws:

EdgeOutOfRangeException - If edge is too large.

DepthOutOfRangeException - If depth is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

DataDirectorException - If a data provider error occurs.

LayerOutOfRangeException

See Also:

DataDirector

pageChangeHappened

boolean pageChangeHappened(java.lang.Object source,
                           int pos)
                           throws SliceOutOfRangeException,
                                  DataDirectorException

Changes the current page.

Parameters:

source - The source of any event that this method fires.

pos - A constant that represents the first page, last page, next page, or previous page. Constants begin with VIEW_PAGE_.

Returns:

true if the page is changed, false if not.

Throws:

SliceOutOfRangeException - If page is negative or too large.

DataDirectorException - If a data provider error occurs.

pageChangeHappened

boolean pageChangeHappened(java.lang.Object source,
                           int[] hPos,
                           int maxLayerSpecified)
                           throws LayerOutOfRangeException,
                                  SliceOutOfRangeException,
                                  DataDirectorException

Changes the current page. The view calls this method when a page change gesture is detected in the UI.

Parameters:

source - The source of any event that this method fires.

hPos - An array of relative indices starting with the outermost layer and working in at least to maxLayerSpecified indicating the set of new values to give to the various layers that make up the target slice

maxLayerSpecified - The maximum index into hPos (layer) that the call should use in making the slice change.

Returns:

true if the page is changed, false if not.

Throws:

LayerOutOfRangeException - If there are too many layers.

SliceOutOfRangeException - If page is negative or too large.

DataDirectorException - If a data provider error occurs.