Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.dataSource.common
Class RelationalQueryDataDirector

java.lang.Object
  |
  +--oracle.dss.dataSource.common.QueryDataDirector
        |
        +--oracle.dss.dataSource.common.RelationalQueryDataDirector
All Implemented Interfaces:
DataDirector, RelationalDataDirector, java.io.Serializable

public class RelationalQueryDataDirector
extends QueryDataDirector
implements RelationalDataDirector

Specific relational-based implementation of util.DataDirector.

See Also:
Serialized Form

Fields inherited from interface oracle.dss.util.DataDirector
COLUMN_EDGE, DATA_ELEMENT_EDGE, DRILL_REPLACE, DRILLSTATE_DRILLABLE, DRILLSTATE_IS_DRILLED, DRILLSTATE_NOT_DRILLABLE, GROUPSORT_END, GROUPSORT_MIDDLE, GROUPSORT_NONE, GROUPSORT_START, max_edge, NA_SUPPRESSION, NA_ZERO_SUPPRESSION, NO_SUPPRESSION, PAGE_EDGE, PIVOT_EDGES, PIVOT_MOVE_AFTER, PIVOT_MOVE_BEFORE, PIVOT_MOVE_TO, PIVOT_SWAP, ROW_EDGE, ZERO_SUPPRESSION

 

Constructor Summary
RelationalQueryDataDirector(Query ds)
          Constructor that uses a QueryCommon object.
RelationalQueryDataDirector(QueryDataDirector dd)
          Constructor that uses a QueryDataDirector object.

 

Method Summary
 LayerMetadataMap getSupportedLayerMetadataMap()
          Return a LayerMetadataMap containing all of the types the implementor can support.
 boolean pivot(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags)
          Pivots data.
 boolean pivotOK(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags)
          Indicates whether the specified pivot operation would be valid for the current data layout.
 boolean reorder(int edge, int fromLayer, int toLayer, int flags)
          Reorders dimension members or edge items and updates data.

 

Methods inherited from class oracle.dss.dataSource.common.QueryDataDirector
addDataDirectorListener, cancel, changeEdgeCurrentHPos, changeEdgeCurrentSlice, deleteMemberCalc, deleteValueCalc, drill, drill, drillOK, drillOK, getDataMap, getMetadataMap, getSupportedDataMap, getSupportedMetadataMap, insertMemberCalc, insertValueCalc, isCancelable, isOutline, refresh, removeDataDirectorListener, revalidate, setDataMap, setManualUpdate, setMetadataMap, setOutline, update

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface oracle.dss.util.DataDirector
addDataDirectorListener, cancel, changeEdgeCurrentHPos, changeEdgeCurrentSlice, deleteMemberCalc, deleteValueCalc, drill, drill, drillOK, drillOK, getDataMap, getMetadataMap, getSupportedDataMap, getSupportedMetadataMap, insertMemberCalc, insertValueCalc, isCancelable, isOutline, refresh, removeDataDirectorListener, revalidate, setDataMap, setManualUpdate, setMetadataMap, setOutline, update

 

Constructor Detail

RelationalQueryDataDirector

public RelationalQueryDataDirector(Query ds)
Constructor that uses a QueryCommon object.

RelationalQueryDataDirector

public RelationalQueryDataDirector(QueryDataDirector dd)
Constructor that uses a QueryDataDirector object.
Method Detail

reorder

public boolean reorder(int edge,
                       int fromLayer,
                       int toLayer,
                       int flags)
                throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException
Reorders dimension members or edge items and updates data. In a CubeDataDirector, reorders dimension members. In a RelationalDataDirector, reorders edge items. This method moves one dimension member or edge item to a new position within the dimension or edge, or swaps one dimension member or edge item with another, within the dimension or edge.
Specified by:
reorder in interface DataDirector
Overrides:
reorder in class QueryDataDirector
Parameters:
edge - A constant that identifies the edge that contains the dimension or items to reorder. The constants are defined in util.DataDirector and end with _EDGE.
fromLayer - The source layer for the reorder.
toLayer - The target layer for the reorder.
flags - Constant that indicates whether to move fromLayer before or after toLayer, or whether to swap the two layers. You can use the PIVOT_ constants.
Returns:
true if reordering is successful; false if reordering is not successful.
Throws:
EdgeOutOfRangeException - If edge is too large.
LayerOutOfRangeException - If layer is negative or too large.
DataDirectorException - If a data provider error occurs.
See Also:
DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

pivot

public boolean pivot(int fromEdge,
                     int toEdge,
                     int fromLayer,
                     int toLayer,
                     int flags)
              throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException
Pivots data. Operations include:
Specified by:
pivot in interface DataDirector
Overrides:
pivot in class QueryDataDirector
Parameters:
fromEdge - A constant that indicates the edge from which a layer should be pivoted. Valid constants end with _EDGE in util.DataDirector.
toEdge - A constant that indicates the edge to which a layer should be pivoted. Valid constants end with _EDGE in util.DataDirector.
fromLayer - The zero-based index of the physical layer on the fromEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object will report columns as its layers.
toLayer - The zero-based index of the physical layer on the toEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object will report columns as its layers.
flags - A constant that indicates the type of pivot to perform. The constants begin with PIVOT_ in util.DataDirector.
Returns:
true if the pivot is successful; false if the pivot is not successful.
Throws:
EdgeOutOfRangeException - If either edge is too large.
LayerOutOfRangeException - If either layer is negative or too large.
DataDirectorException - If a data provider error occurs.
See Also:
DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataDirector.PIVOT_EDGES, DataDirector.PIVOT_MOVE_AFTER, DataDirector.PIVOT_MOVE_BEFORE, DataDirector.PIVOT_SWAP

pivotOK

public boolean pivotOK(int fromEdge,
                       int toEdge,
                       int fromLayer,
                       int toLayer,
                       int flags)
                throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException
Indicates whether the specified pivot operation would be valid for the current data layout. This method is called before the pivot method and does not perform the actual pivot. The data provider determines its own rules for valid pivot operations.
Specified by:
pivotOK in interface DataDirector
Overrides:
pivotOK in class QueryDataDirector
Parameters:
fromEdge - A constant that indicates the edge from which a layer should be pivoted. Valid constants end with _EDGE in util.DataDirector.
toEdge - A constant that indicates the edge to which a layer should be pivoted. Valid constants end with _EDGE in util.DataDirector.
fromLayer - The zero-based index of the physical layer on the fromEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object will report columns as its layers.
toLayer - The zero-based index of the physical layer on the toEdge that should be pivoted or swapped. The outermost layer on the edge is 0. Note that a Table object will report columns as its layers.
flags - A constant that indicates the type of pivot to perform. The constants begin with PIVOT_ in util.DataDirector.
Returns:
true if the pivot is legal according to the data provider's rules, false if the pivot is not legal according to the data provider's rules.
Throws:
EdgeOutOfRangeException - If either edge is too large.
LayerOutOfRangeException - If either depth is negative or too large.
DataDirectorException - If a data provider error occurs.
See Also:
DataDirector.COLUMN_EDGE, DataDirector.DATA_ELEMENT_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataDirector.PIVOT_EDGES, DataDirector.PIVOT_MOVE_AFTER, DataDirector.PIVOT_MOVE_BEFORE, DataDirector.PIVOT_SWAP

getSupportedLayerMetadataMap

public LayerMetadataMap getSupportedLayerMetadataMap()
Return a LayerMetadataMap containing all of the types the implementor can support. This is not meant to guarantee views that they can get the types they want in every query.
Specified by:
getSupportedLayerMetadataMap in interface DataDirector
Overrides:
getSupportedLayerMetadataMap in class QueryDataDirector
Returns:
LayerMetadataMap containing all of the possibly supported types

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.