|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dss.dataSource.common.QueryDataDirector
QueryDataDirector Implementation of common DataDirector functions
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 |
Method Summary | |
void |
addDataDirectorListener(DataDirectorListener l) Registers a listener to the data source for changes. |
boolean |
cancel() Cancels the current long-running operation, if possible. |
boolean |
changeEdgeCurrentHPos(int edge, int[] hPos, int maxLayerSpecified) Changes the current slice of data on the given edge. |
boolean |
changeEdgeCurrentSlice(int edge, int slice) Changes the current slice of data on the given edge. |
boolean |
deleteMemberCalc(int edge, int layer, int slice) Deletes a calculated value at the specified edge, layer, and slice. |
boolean |
deleteValueCalc(int row, int column) Deletes a calculated value at the specified row and column. |
boolean |
drill(int edge, int layer, int[] slice, int flags) Drills in data, from multiple selected members. |
boolean |
drill(int edge, int layer, int slice, int flags) Drills in the data, from a single member. |
boolean |
drillOK(int edge, int layer, int[] slice, int flags) Indicates whether the drill operation from multiple selected members is legal. |
boolean |
drillOK(int edge, int layer, int slice, int flags) Indicates whether a drill operation from a single selected member is legal. |
DataMap |
getDataMap() Retrieves the list of types of data that can be retrieved or set for each location in the data cursor. |
MetadataMap |
getMetadataMap(int edge, int layer) Retrieves the list of available types of metadata. |
DataMap |
getSupportedDataMap() Return a Datamap containing all of the types the implementor can support. |
LayerMetadataMap |
getSupportedLayerMetadataMap() Return a LayerMetadataMap containing all of the types the implementor can support. |
MetadataMap |
getSupportedMetadataMap() Return a MetadataMap containing all of the types the implementor can support. |
boolean |
insertMemberCalc(int edge, int layer, int slice, int flags, java.lang.Object calc) Inserts a calculation at a specified edge, layer, and slice. |
boolean |
insertValueCalc(int row, int column, int flags, java.lang.Object calc) Inserts a calculation at a specified row and column. |
boolean |
isCancelable() Indicates whether this DataDirector implementor allows views to cancel an operation that takes a long time. |
boolean |
isOutline() Indicates whether the data is provided in outline form or inline form. |
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 is legal. |
boolean |
refresh() Refreshes data and fires a DataChangedEvent. |
void |
removeDataDirectorListener(DataDirectorListener l) Removes a listener from the data source. |
boolean |
reorder(int edge, int fromLayer, int toLayer, int flags) Reorder dimension members or edge items and updates data. |
boolean |
revalidate() Rebuilds a query, refreshes data, and fires a DataChangedEvent. |
void |
setDataMap(DataMap map, int sizeRow, int sizeColumn) Specifies the types of data to provide in a data cursor. |
void |
setManualUpdate() Batches DataDirector operations. |
void |
setMetadataMap(int edge, int layer, MetadataMap map, int size) Specifies the types of metadata to provide in an edge cursor or in a layer cursor. |
void |
setOutline(boolean outline) Specifies whether the data is provided in outline form. |
void |
update() Processes batched DataDirector operations. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public boolean pivot(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, DataDirectorException
pivot
in interface DataDirector
fromEdge
- The edge to pivot from.toEdge
- The edge to pivot to.fromLayer
- The layer to pivot from. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.toLayer
- The layer to pivot to.flags
- Constant that indicates the type of pivot to perform. The constants begin with PIVOT_ in this interface.true
if the pivot is successful, false
if not.EdgeOutOfRangeException
- If either edge is too large.LayerOutOfRangeException
- If either layer is negative or too large.DataDirectorException
- If a data provider error occurs.public boolean pivotOK(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, DataDirectorException
pivotOK
in interface DataDirector
fromEdge
- The edge to pivot from.toEdge
- The edge to pivot to.fromLayer
- The layer to pivot from. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.toLayer
- The layer to pivot to.flags
- Constant that indicates the type of pivot to perform. The constants begin with PIVOT_ in this interface.true
if the pivot is legal according to the data provider's rules, false
if not.EdgeOutOfRangeException
- If either edge is too large.LayerOutOfRangeException
- If either depth is negative or too large.DataDirectorException
- If a data provider error occurs.public boolean drill(int edge, int layer, int slice, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
drill
in interface DataDirector
edge
- The edge to drill.layer
- The layer to drill. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.slice
- The slice to drill. The slice is zero-based. Each dimension member in the innermost dimension has a unique slice. In outer dimensions, any slice that the outer dimension spans can be used.flags
- Constant that indicates the type of drill. The constants begin with DRILLABLE_ in this interface.true
If drilling is successful, false
if not.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.public boolean drillOK(int edge, int layer, int slice, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
drillOK
in interface DataDirector
edge
- The edge to drill.layer
- The layer to drill. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.slice
- The slice to drill. The slice is zero-based. Each dimension member in the innermost dimension has a unique slice. In outer dimensions, any slice that the outer dimension spans can be used.flags
- Constant that indicates the type of drill. The constants begin with DRILLABLE_ in this interface.true
if this drilling operation is legal, false
if not.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.public boolean changeEdgeCurrentSlice(int edge, int slice) throws EdgeOutOfRangeException, SliceOutOfRangeException, DataDirectorException
changeEdgeCurrentSlice
in interface DataDirector
edge
- The edge on which to make the change.slice
- The slice to make current. Page numbers begin at zero and are incremented as in the following example:
Suppose that you have a Time dimension and a City dimension on the page edge. Suppose the City dimension has three members. The first five pages are as follows:
true
if the page change is successful, false
if not.EdgeOutOfRangeException
- If edge
is too large.SliceOutOfRangeException
- If slice
is too large.DataDirectorException
- If a data provider error occurs.public boolean changeEdgeCurrentHPos(int edge, int[] hPos, int maxLayerSpecified) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
changeEdgeCurrentHPos
in interface DataDirector
edge
- The edge on which to make the change.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 slicemaxLayerSpecified
- The maximum index into hPos
(layer) that the call should use in making the slice change.true
if the page change is successful, false
if not.EdgeOutOfRangeException
- If edge
is too large.LayerOutOfRangeException
- If number of layers in hPos
is too large.SliceOutOfRangeException
- If the slices in hPos
are too large.DataDirectorException
- If a data provider error occurs.public void addDataDirectorListener(DataDirectorListener l)
addDataDirectorListener
in interface DataDirector
l
- The listener to add.public void removeDataDirectorListener(DataDirectorListener l)
removeDataDirectorListener
in interface DataDirector
l
- The listener to remove.public void setMetadataMap(int edge, int layer, MetadataMap map, int size) throws EdgeOutOfRangeException, LayerOutOfRangeException, DataDirectorException
setMetadataMap
in interface DataDirector
edge
- The edge of interest. To set a default map for all edges, pass -1.layer
- The layer of interest. Use a depth computation to identify the location of the layer; 0 is the outer-most layer on the edge. To refer to all of the layers on an edge, pass -1. This parameter is not currently used.map
- A list of the metadata types that the view wants in an edge cursor or a layer cursor that the DataAccess
fetches.size
- A suggested number of metatdata values that the data provider should fetch at a time. This is a guide for the data provider about the size of metadata chunks.EdgeOutOfRangeException
- If edge
is out of range.LayerOutOfRangeException
- If layer
is out of range.DataDirectorException
- If a data provider error occurs.public void setDataMap(DataMap map, int sizeRow, int sizeColumn) throws DataDirectorException
setDataMap
in interface DataDirector
map
- A list of the data planes that the caller wants to get in data cursors that the DataAccess
implementation fetches.sizeRow
- The suggested number of rows that the data provider should fetch at a time.sizeColumn
- The suggested number of columns that the data provider should fetch at a time.DataDirectorException
- If a data provider error occurspublic MetadataMap getMetadataMap(int edge, int layer) throws EdgeOutOfRangeException, LayerOutOfRangeException
getMetadataMap
in interface DataDirector
edge
- The edge of interest. A value of -1 is a request for for the default MetadataMap
.layer
- The layer of interest. Uses a depth computation to identify the location of the layer; 0 is the outer-most layer on the edge. A layer
value of -1 indicates all of the layers on an edge.EdgeOutOfRangeException
- if edge
is out of range.LayerOutOfRangeException
- If no layer exists at this location.public DataMap getDataMap()
getDataMap
in interface DataDirector
public boolean reorder(int edge, int fromLayer, int toLayer, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, DataDirectorException
reorder
in interface DataDirector
edge
- A constant that identifies the edge that contains the dimension or items to reorder.fromLayer
- The layer from which to reorder.toLayer
- The layer to which to move the item near, or with which to swap.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.true
if reordering is successful, false
if not.EdgeOutOfRangeException
- If edge
is too large.LayerOutOfRangeException
- If layer
is negative or too large.DataDirectorException
- If a data provider error occurs.public boolean insertValueCalc(int row, int column, int flags, java.lang.Object calc) throws RowOutOfRangeException, ColumnOutOfRangeException, DataDirectorException
This implementation returns false
.
insertValueCalc
in interface DataDirector
row
- The row at which the calculation should be inserted.column
- The column at which the calculation should be inserted.flags
- A constant that specifies he type of calculation to insert. The data provider specifies the constants.calc
- Flag and data-provider-dependent information about the calculation to insert.true
if the calculation is inserted, false
if not.RowOutOfRangeException
- If row
is negative or too large.ColumnOutOfRangeException
- If column
is negative or too large.DataDirectorException
- If a data provider error occurs.public boolean insertMemberCalc(int edge, int layer, int slice, int flags, java.lang.Object calc) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
This implementation returns false
.
insertMemberCalc
in interface DataDirector
edge
- A constant that specifies the edge on which to insert the calculation.layer
- The layer at which to insert the calculation. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.slice
- The slice at which to insert the calculation.flags
- A constant that specifies the type of calculation to insert. The data provider specifies the constants.calc
- Flag and data-provider-dependent information about the calculation to insert.true
if the calculation is inserted, false
if not.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.public boolean deleteValueCalc(int row, int column) throws RowOutOfRangeException, ColumnOutOfRangeException, DataDirectorException
This implementation returns false
.
deleteValueCalc
in interface DataDirector
row
- The row at which to delete the calculation.column
- The column at which to delete the calculation.true
if the calculation is deleted, false
if not.RowOutOfRangeException
- If row
is negative or too large.ColumnOutOfRangeException
- If column
is negative or too large.DataDirectorException
- If a data provider error occurspublic boolean deleteMemberCalc(int edge, int layer, int slice) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
This implementation returns false
.
deleteMemberCalc
in interface DataDirector
edge
- A constant that specifies the edge from which to delete the calculation.layer
- The layer at which to delete the calculation. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.slice
- The slice at which to delete the calculation.true
if the calculation is inserted, false
if not.LayerOutOfRangeException
- If layer
is negative or too large.SliceOutOfRangeException
- If slice
DataDirectorException
- If a data provider error occurs.public boolean drill(int edge, int layer, int[] slice, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
This implementation returns false
.
drill
in interface DataDirector
edge
- The edge to drill.layer
- The layer to drill. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.slice
- The slices to drill. Slices are zero-based. Each dimension member in the innermost dimension has a unique slice. In outer dimensions, any slice that the outer dimension spans can be used.flags
- Constant that indicates the type of drill. The constants begin with DRILLSTATE_ in this interface.true
If drilling is successful, false
if not.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.public boolean drillOK(int edge, int layer, int[] slice, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException, DataDirectorException
This implementation returns false
.
drillOK
in interface DataDirector
edge
- The edge to drill.layer
- The layer to drill. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.slice
- The slice to drill. The slice is zero-based. Each dimension member in the innermost dimension has a unique slice. In outer dimensions, any slice that the outer dimension spans can be used.flags
- Constant that indicates the type of drill. The constants begin with DRILLSTATE_ in this interface.true
if this drilling operation is legal, false
if not.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.public boolean refresh() throws DataDirectorException
refresh
in interface DataDirector
true
if data will be refreshed, false
if not.DataDirectorException
- If a data provider error occurspublic boolean revalidate() throws DataDirectorException
revalidate
in interface DataDirector
true
if data will be refreshed, false
if not.DataDirectorException
- If a data provider error occurspublic void setOutline(boolean outline) throws DataDirectorException
For example, if the row edge uses outline form, all dimensions appear in the same label column. If it does not use outline form, there is a separate column for each dimension.
setOutline
in interface DataDirector
outline
- true
to set data provision to outline form, false
to use inline form.DataDirectorException
- If a data provider error occurspublic boolean isOutline()
For example, if the row edge uses outline form, all dimensions appear in the same label column. If it does not use outline form, there is a separate column for each dimension.
isOutline
in interface DataDirector
true
if the data is provided in outline form, false
if the data is provided in inline form.public boolean isCancelable()
DataDirector
implementor allows views to cancel an operation that takes a long time.isCancelable
in interface DataDirector
true
if the data provider supports cancelation of long operations, false
if not.public boolean cancel()
cancel
in interface DataDirector
true
if the implementor canceled the operation, false
if the implementor did not or could not cancel the operation.public void setManualUpdate()
update
are batched. Note this method may throw a QueryRuntimeException.setManualUpdate
in interface DataDirector
update()
public void update() throws DataDirectorException
setManualUpdate
and this method are batched. This method should also turn off manual update mode.update
in interface DataDirector
DataDirectorException
- If a data provider error occurssetManualUpdate()
public MetadataMap getSupportedMetadataMap()
getSupportedMetadataMap
in interface DataDirector
public LayerMetadataMap getSupportedLayerMetadataMap()
getSupportedLayerMetadataMap
in interface DataDirector
public DataMap getSupportedDataMap()
getSupportedDataMap
in interface DataDirector
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |