<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
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.util.DataAccessAdapter
Null implementation of DataAccess and DataDirector interface. Data providers can extend this class and override methods to provide a real implementation of the two interfaces.
| 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 | |
DataAccessAdapter() | |
| 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 slice of data, on the specified edge, that is designated as the current slice by using hierarchical addressing. |
boolean |
changeEdgeCurrentSlice(int edge, int slice)Changes the slice, on the specified edge, that is designated as the current slice of data. |
boolean |
deleteMemberCalc(int edge, int layer, int slice)Deletes a calculation from the display based on a member that is located at the specified edge, layer, and slice. |
boolean |
deleteValueCalc(int row, int column)Deletes a calculation at the specified row and column of the body of a data for a view. |
boolean |
drill(int edge, int layer, int[] slice, int flags)Drills in data based on multiple selected members. |
boolean |
drill(int edge, int layer, int slice, int flags)Drills in the data for a single member. |
boolean |
drillOK(int edge, int layer, int[] slice, int flags)Indicates whether the specified drill operation from multiple selected members would be a valid drill. |
boolean |
drillOK(int edge, int layer, int slice, int flags)Indicates whether a drill operation from a single selected member would be legal. |
boolean |
dropChanges()Clears the QDR overrides in the writeback collection. |
void |
endGroupEdit()Indicates the end of a group of setValue calls. |
int |
findMember(int edge, int[] hPos, int memberLayer, java.lang.String s, java.lang.String type, int flags)Searches a set of child members for the specified value starting at a specified offset. |
boolean |
forceFetch(int[] startSlice, int[] endSlice)Ensures that a block of data has been fetched locally. |
DataMap |
getDataMap()Retrieves the list of types of data that can be retrieved or set for each location in the data cursor. |
int |
getEdgeCount()Retrieves the total number of edges in the cursor. |
int[] |
getEdgeCurrentHPos(int edge)Retrieves, for the specified edge, the hierarchical address of the location that is defined by the implementor as the "current" location. |
int |
getEdgeCurrentSlice(int edge)Retrieves the zero-based index of the slice that is defined by the implementor as the current slice. |
int |
getEdgeExtent(int edge)Retrieves the total number of slices that are available on the specified edge. |
int[] |
getFirstHPos(int edge)Retrieves the hPos array that identifies the members at each physical layer of slice 0 on the specified edge. |
int[] |
getLastHPos(int edge)Retrieves the hPos array that identifies the members at each physical layer in the last slice on the specified edge. |
int |
getLayerCount(int edge)Retrieves the total number of layers on the specified edge. |
java.lang.Object |
getLayerMetadata(int edge, int layer, java.lang.String type)Retrieves the specified type of metadata for a member at the specified location. |
QDR |
getLayerQDR(int edge, int layer, int flags)Retrieves the QDR object that represents the specified logical layer. |
int |
getMemberDepth(int edge, int layer, int slice)Retrieves the size (expressed in layers that are perpendicular to the specified edge orientation) of a member at the specified layer, slice, and edge. |
int |
getMemberExtent(int edge, int layer, int slice)Retrieves the size of a member, that is, the number of slices that the member spans at a specified edge, layer, and slice location (parallel to the direction of the edge). |
int[] |
getMemberHPos(int edge, int layer, int slice)Retrieves the hierarchical address for an absolute address that is specified as edge, physical layer, and slice. |
int |
getMemberLogicalLayer(int edge, int layer, int slice)Retrieves the logical layer to which the member at the specified edge, physical layer, and slice location belongs. |
java.lang.Object |
getMemberMetadata(int edge, int[] hPos, int memberLayer, int hIndex, java.lang.String type)Retrieves the specified type of metadata for the member at a specified location. |
java.lang.Object |
getMemberMetadata(int edge, int layer, int slice, java.lang.String type)Retrieves the specified type of metadata for a member at the specified location. |
QDR |
getMemberQDR(int edge, int[] hPos, int memberLayer, int flags)Retrieves a QDR object that represents the specified member using hierarchical addressing. |
QDR |
getMemberQDR(int edge, int layer, int slice, int flags)Retrieves a QDR object that represents the data value for the member at the specified edge, layer, and slice. |
int |
getMemberSiblingCount(int edge, int[] hPos, int memberLayer)Retrieves the count of all the sibling members at a specified logical layer based on a series of relative indexes for each logical layer down to the specified logical layer. |
int |
getMemberStartLayer(int edge, int layer, int slice)Retrieves the starting layer at which a member at the specified edge, layer, and slice location begins. |
int |
getMemberStartSlice(int edge, int layer, int slice)Retrieves the absolute number of the first slice that a member spans. |
MetadataMap |
getMetadataMap(int edge, int layer)Retrieves the list of all the types of metadata that callers have requested to be included in the cursors for the specified logical layer. |
int[] |
getNextHPos(int edge, int[] hPos)Retrieves the hPos that identifies the next member on the specified edge relative to a specified hPos. |
int[] |
getPrevHPos(int edge, int[] hPos)Retrieves the hPos array that identifies the members at each physical layer of the slice that is immediately previous to the specified hPos on the specified edge. |
java.util.Vector |
getQDRoverrideCollection()Retrieves a read-only copy of the QDR overrides in the writeback collection. |
java.lang.Object |
getSliceLabel(int edge, int slice, java.lang.String type)Retrieves the label (or concatenated metadata) for the specified slice. |
int |
getSliceMemberCount(int edge, int slice)Retrieves the number of unique logical layers (that is, the number of members that run perpendicular to the orientation of the edge) at the specified slice and edge. |
int |
getSliceOutlineLayer(int edge, int slice)Retrieves the starting logical layer of a specified slice in a specified edge when the Crosstab (along with the DataAccess implementor) is set to return data in outline mode. |
QDR |
getSliceQDR(int edge, int slice, int flags)Retrieves a QDR object that represents the data value at the specified slice on the edge (that is, across all relevant logical layers of the slice). |
DataMap |
getSupportedDataMap()Return a DataMap that contains all of the types that this DataAccessAdapter can support. |
LayerMetadataMap |
getSupportedLayerMetadataMap()Return a LayerMetadataMap that contains all of the types that this DataAccessAdapter can support. |
MetadataMap |
getSupportedMetadataMap()Retrieves a MetadataMap that contains all of the types that this DataAccessAdapter can support. |
java.lang.Object |
getValue(int row, int col, java.lang.String type)Retrieves a data value for the specified row and column intersection. |
QDR |
getValueQDR(int row, int column, int flags)Retrieves a QDR object that represents the value at the specified row and column in the data area of the cursor. |
boolean |
insertMemberCalc(int edge, int layer, int slice, int flags, java.lang.Object calc)Inserts a calculation into a display based on the member at the 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 in the body of a view's data. |
boolean |
isAutoSubmit()Indicates whether automatic submission is set for cell editing. |
boolean |
isCancelable()Indicates whether this DataDirector implementor allows views to cancel an operation that takes a long time. |
boolean |
isFetched(int[] startSlice, int[] endSlice)Indicates whether a block of data has been fetched locally. |
boolean |
isOutline()Indicates whether data is provided in outline form or inline form. |
boolean |
pivot(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags)Pivots or swaps 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 |
redoEdit()Performs a redo of the latest undo action. |
boolean |
refresh()Refreshes data and fires a DataChangedEvent to all registered listeners. |
void |
release()Informs the implementor that the caller no longer needs this DataAccess reference. |
void |
removeDataDirectorListener(DataDirectorListener l)Removes a listener from the data source. |
boolean |
reorder(int edge, int fromLayer, int toLayer, int flags)Reorders the layers (that is, columns) of a Table object. |
boolean |
revalidate()Rebuilds (that is, reruns) a query, refreshes the data cache, and fires a DataChangedEvent. |
void |
setAutoSubmit(boolean bValue)Specifies that the QDR override in the writeback collection for a cell will be submitted automatically as soon as it is entered. |
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 the cursors for the specified logical layer. |
void |
setOutline(boolean outline)Specifies whether data is provided to a view in outline form. |
boolean |
setValue(java.lang.Object data, int row, int col, java.lang.String type)Specifies a data value for the specified row and column intersection. |
void |
startGroupEdit()Indicates the start of a group of setValue calls. |
boolean |
submitChanges()Writes the current group of QDR overrides in the writeback collection to the database and flushes the entries in the writeback collection. |
boolean |
undoEdit()Performs an undo of the latest setValue operation. |
void |
update()Processes batched DataDirector operations. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public DataAccessAdapter()
| Method Detail |
public int getEdgeExtent(int edge)
throws EdgeOutOfRangeException
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.EdgeOutOfRangeException - If the edge parameter is not valid.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGEpublic int getEdgeCount()
This implementation returns 1.
public java.lang.Object getValue(int row,
int col,
java.lang.String type)
throws RowOutOfRangeException,
ColumnOutOfRangeException
This implementation returns null.
row - The row to get.col - The column to get.type - Type of data to return, such as formatted or unformatted. Valid type values are defined in the DataMap.RowOutOfRangeException - If row is negative or too large.ColumnOutOfRangeException - If column is negative or too large.DataMap
public boolean setValue(java.lang.Object data,
int row,
int col,
java.lang.String type)
throws RowOutOfRangeException,
ColumnOutOfRangeException
This implementation returns false.
data - The data to set into the cursor.row - The row at which to set the data.col - The column at which set the data.map - Type of data to set, such as formatted or unformatted. Valid type values are defined in the DataMap.truefalse if not.RowOutOfRangeException - If row is negative or too large.ColumnOutOfRangeException - If column is negative or too large.DataMap
public java.lang.Object getSliceLabel(int edge,
int slice,
java.lang.String type)
throws EdgeOutOfRangeException,
SliceOutOfRangeException
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.slice - An absolute index (zero-based) along the specified edge that indicates the slice for which concatenated metadata is desired.type - A constant that specifies the kind of metadata that the caller wants to have returned. Valid type values are defined in the class MetadataMap class.EdgeOutOfRangeException - If edge is out of range.SliceOutOfRangeException - If slice is negative or too large.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getEdgeCurrentSlice(int edge)
throws EdgeOutOfRangeException
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.EdgeOutOfRangeException - If the edge parameter is not in the valid range.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int[] getEdgeCurrentHPos(int edge)
throws EdgeOutOfRangeException
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.EdgeOutOfRangeException - If the parameter edge is not valid.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getLayerCount(int edge)
throws EdgeOutOfRangeException
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.layer parameter in other API calls: the valid range is from zero to this return value minus one. This implementation returns zero.EdgeOutOfRangeException - If edge is out of range.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getSliceMemberCount(int edge,
int slice)
throws EdgeOutOfRangeException,
SliceOutOfRangeException
This implementation returns 0.
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.slice - An absolute index (zero-based) that indicates the location of a slice along the specified edge. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.EdgeOutOfRangeException - If edge is out of range.SliceOutOfRangeException - If slice is negative or too large.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getSliceOutlineLayer(int edge,
int slice)
throws EdgeOutOfRangeException,
SliceOutOfRangeException
DataAccess implementor) is set to return data in outline mode. Because, in outline mode, the getSliceMemberCount method always return the value 1, the Crosstab uses getSliceOutlineLayer to determine the logical layer.
This implementation returns 0.
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector. The slice is zero-based. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.slice - An absolute index (zero-based) that indicates the location of a slice along the specified edge. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.EdgeOutOfRangeException - If the edge parameter is not valid.SliceOutOfRangeException - If slice is negative or too large.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getMemberDepth(int edge,
int layer,
int slice)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
The sum of all the members' values for this method, within a specified slice, should not exceed the value that getLayerCount returns for the specified edge.
This method is useful only in cases of asymmetry where the members on an edge do not all cover one layer and have a depth of 1. On a symmetric edge, all members have a member depth of 1.
This implementation returns 0.
edge - A constant that represents the edge in which to look for the layer and slice. The constants end with _EDGE in DataDirector.layer - The zero-based index of the starting physical layer in which to look for the slice, as returned by getMemberStartLayer.slice - An absolute index (zero-based) that indicates the location of a slice along the specified edge. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If layer is negative or too large.SliceOutOfRangeException - If slice is negative or too large.getLayerCount(int), getMemberStartLayer(int, int, int), DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getMemberStartLayer(int edge,
int layer,
int slice)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
getMemberDepth to retrieve the following information depending on the edge:
getMemberStartLayer, and getMemberDepth should not exceed the value that is returned by getLayerCount for an edge.
This method is useful only in cases of asymmetry where the members on an edge do not all cover one layer. In a symmetric edge, all members have a member start layer equal to their layer.
edge - A constant that represents the edge in which to look for layer and slice. The constants end with _EDGE in DataDirector.layer - The zero-based index of the physical layer in which to look for the slice.slice - An absolute index (zero-based) that indicates the location of a slice along the specified edge. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If layer is negative or too large.SliceOutOfRangeException - If slice is negative or too large.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getMemberLogicalLayer(int edge,
int layer,
int slice)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
layer parameter should yield the same logical layer.
The value returned by this method can be used as input to getLayerMetadata and should not exceed the value that is returned by getMemberCount.
edge - A constant that represents the edge in which to look for the layer and slice. The constants end with _EDGE in DataDirector.layer - The zero-based index of the physical layer of the member.slice - An absolute index (zero-based) that indicates the location of a slice along the specified edge. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If layer is negative or too large.SliceOutOfRangeException - If slice is negative or too large.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public java.lang.Object getLayerMetadata(int edge,
int layer,
java.lang.String type)
throws EdgeOutOfRangeException,
LayerOutOfRangeException
This implementation returns null.
edge - A constant that represents the edge in which to look for the member metadata. The constants end with _EDGE in DataDirector.layer - The zero-based index of the layer for which metadata is requested. Uses a depth computation to identify the location of the layer or layer member; 0 is the outer-most layer on the edge. The value for this parameter can be obtained by calling getMemberLogicalLayer.type - A constant that specifies the kind of metadata that you want. Valid type values are defined in the LayerMetadataMap.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If layer is negative or too large.LayerMetadataMap, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getMemberExtent(int edge,
int layer,
int slice)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
The sum of all the unique getMemberExtent values for an edge should not exceed the getEdgeExtent value for the same edge.
This implementation returns 0.
edge - A constant that represents the edge in which to look for the layer and slice. The constants end with _EDGE in DataDirector.layer - The zero-based index of the physical layer of the member whose size will be returned. Valid values are zero to total layers at the specified slice.slice - An absolute index (zero-based) that indicates the location along the edge of the member whose extent will be returned. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If layer is negative or too largeSliceOutOfRangeException - If slice is negative or too largegetMemberStartSlice(int, int, int), DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getMemberStartSlice(int edge,
int layer,
int slice)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
getMemberExtent.
This implementation returns 0.
edge - A constant that represents the edge in which to look for the layer and slice. The constants end with _EDGE in DataDirector.layer - The zero-based index of the physical layer of the member whose first slice will be returned. Valid values are zero to total layers at the specified slice.slice - An absolute index (zero-based) that indicates the location along the specified edge of the member whose starting slice will be returned. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If layer is negative or too large.SliceOutOfRangeException - If slice is negative or too large.getMemberExtent(int, int, int), DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public java.lang.Object getMemberMetadata(int edge,
int layer,
int slice,
java.lang.String type)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
edge - A constant that represents the edge in which to look for the member metadata. The constants end with _EDGE in DataDirector.layer - The zero-based index of the physical layer in which to find the slice. Valid values are zero to total layers at the specified slice.slice - An absolute index (zero-based) that indicates the location along the edge of a slice that belongs to the member for which metadata is requested. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.type - A constant that specifies the kind of metadata requested. Valid type values are defined in MetadataMap. The caller should have intialized the appropriate MetadataMap object with any types of metadata that the caller intends to use.LayerOutOfRangeException - If layer is negative or too large.SlieOutOfRangeException - If slice is negative or too large.MetadataMap, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int getMemberSiblingCount(int edge,
int[] hPos,
int memberLayer)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
| June | July | ||||||||||
| Tents | Canoes | Tents | Canoes | ||||||||
| NY | Boston | LA | Toronto | Winnepeg | NY | LA | NY | Boston | LA | Toronto | Winnepeg |
A caller can use this method to find the number of Geography values (that is, sibling members) under the members July and Tents. This count is 3 (for NY, Boston, and LA). The hPos and memberLayer parameters for this example are as follows:
hPos, an array of relative indexes, holds an entry for July, Tents, and any one of the siblings that are to be counted. A valid hPos in this example must contain indexes for at least layers 0, 1, and 2. Valid arrays for this example could be any of the following: {1,0,0} or {1,0,1} or {1,0,2).memberLayer, which identifies the layer at which to count the siblings, must be 2.Note: The value that is returned by this method provides the upper limit to the hIndex that a caller passes in getMemberMetadata.
This implementation returns 0.
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.hPos - An array that contains an index for the member values at each layer up to and including the layer of the sibling members that are to be counted. These indexes are relative to the number of members at each layer. When a member spans more than one layer, any layers beyond the starting layer should have their place held by a -1 index.memberLayer - The index into the hPos array for which the call should return the sibling member count.hPos and memberLayer. In the example, this method returns 3 (for the siblings NY, Boston, and LA). This implementation returns 0.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If memberLayer is too large.SliceOutOfRangeException - If any slice in hPos is too large.getMemberMetadata(int, int, int, java.lang.String), DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public java.lang.Object getMemberMetadata(int edge,
int[] hPos,
int memberLayer,
int hIndex,
java.lang.String type)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
The user of this method makes the following calls:
getMemberSiblingCount to retrieve the number of sibling members for a specified tree of members.hPos and memberLayer parameters as found in getMemberSiblingCount to specify the parent tree of members. Each call of this method also uses the hIndex parameter that indicates the specific sibling member for which to return metadata. Valid values for hIndex range from 0 to (getMemberSiblingCount() - 1).edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.hPos - An array of relative indexes, organized by logical layer, for the parent tree of members above the sibling member that is specified by hIndex. The array includes entries for layer 0 through at least the layer that is specified by memberLayer.memberLayer - The zero-based index into the hPos array for which the call should address the set of sibling members.hIndex - The zero-based index of a sibling member relative to its siblings. This index specifies the sibling member for which to return the specified metadata.type - A constant that specifies the kind of metadata to return. Valid type values are defined in MetadataMap.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If memberLayer is too large.SliceOutOfRangeException - If any slice in hPos is too large, or if the hIndex is too large.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int[] getMemberHPos(int edge,
int layer,
int slice)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
hPos parameter in calls such as getMemberSiblingCount and getMemberMetadata.
As an example, this method can retrieve an array of indexes from a page edge. The array includes an index for each layer in the page edge. Consider pivoting the following column header to a page edge.
| June | July | ||||||||||
| Tents | Canoes | Tents | Canoes | ||||||||
| NY | Boston | LA | Toronto | Winnepeg | NY | LA | NY | Boston | LA | Toronto | Winnepeg |
If the current page displayed June, Canoes, and Winnepeg, this method would return the array {0,1,1}. June is at index 0 in layer 0. Canoes is at index 1 in layer 1 under June. Winnepeg is at index 1 in layer 2 under Canoes. To find the number of members under Canoes under June, call getMemberSiblingCount with the array {0,1,1} and the memberLayer parameter 2.
edge - A constant that represents the edge in which to look for the slice. The constants end with _EDGE in DataDirector.layer - The zero-based index of the physical layer of the member whose hierarchical address will be returned.slice - An absolute index (zero-based) along an edge that indicates the location of the slice whose hierarchical location will be returned. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int[] getFirstHPos(int edge)
throws EdgeOutOfRangeException
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.EdgeOutOfRangeException - If edge is too large.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int[] getLastHPos(int edge)
throws EdgeOutOfRangeException
edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.EdgeOutOfRangeException - If edge is too large.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int[] getPrevHPos(int edge,
int[] hPos)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
hPos on the specified edge. If there is no new member at a particular layer (because the member spans more than one physical layer) then the index value in the hPos array will be -1 for that layer.edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.hPos - Identifies the member for which this call should return the previous member on the edge.null if the hPos parameter represents the first slice on the edge. This implementation returns <coded>null.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If hPos is too long.SliceOutOfRangeException - If any slice in hPos is too largeDataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public int[] getNextHPos(int edge,
int[] hPos)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
hPos. If there is no new member at a particular layer (because the member spans more than one physical layer) then the index value in the hPos array will be -1 for that layer.edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.hPos - Identifies the member for which this call should return the next member on the edge.null if the specified hPos is the last one on the edge. This implementation returns <coded>null.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If hPos is too long.SliceOutOfRangeException - If any slice in hPos is too largeDataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGEpublic QDR getValueQDR(int row, int column, int flags) throws RowOutOfRangeException, ColumnOutOfRangeException
QDR object that represents the value at the specified row and column in the data area of the cursor.row - The row in the data cursor for which to return the QDR.column - The column in the data cursor for which to return the QDR.flags - A constant that identifies whether to include page edge information if the QDR is not for the page edge. Valid constants are listed in the See Also section.QDR object that refers to the data at the specified location. This implementation returns <coded>null.RowOutOfRangeException - If the row parameter is not valid.ColumnOutOfRangeException - If the column parameter is not valid.DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGEpublic QDR getSliceQDR(int edge, int slice, int flags) throws EdgeOutOfRangeException, SliceOutOfRangeException
QDR object that represents the data value at the specified slice on the edge (that is, across all relevant logical layers of the slice).edge - A constant that represents the edge of in which to find the slice. The constants end with _EDGE in DataDirector.slice - An absolute index (zero-based) that indicates the location of the slice along the specified edge.flags - A constant that identifies whether to include page edge information if the QDR is not for the page edge. Valid constants are listed in the See Also section.QDR object that refers to the data at the specified location. This implementation returns null.EdgeOutOfRangeException - If the edge parameter is not valid.SliceOutOfRangeException - If the slice parameter is not valid.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGEpublic QDR getMemberQDR(int edge, int layer, int slice, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException
QDR object that represents the data value for the member at the specified edge, layer, and slice.edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.layer - A zero-based index that represents the physical layer of the member for which the QDR object is requested.slice - An absolute index (zero-based) that indicates the location, along the specified edge, of a slice that belongs to the member for which the QDR object is requested.flags - A constant that identifies whether to include page edge information if the QDR is not for the page edge. Valid constants are listed in the See Also section.QDR object that refers to the data at the specified position. This implementation returns null.EdgeOutOfRangeException - If edge is not valid.LayerOutOfRangeException - If layer is not valid for the specified edge.SliceOutOfRangeException - If slice is not valid for the specified edge and layer.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGEpublic QDR getMemberQDR(int edge, int[] hPos, int memberLayer, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException
QDR object that represents the specified member using hierarchical addressing.edge - A constant that represents the edge in which to find the member. The constants end with _EDGE in DataDirector.hPos - An array of relative indices that are organized by logical layer. The indices start at layer 0 and extend at least through the layer that is specified in memberLayer.memberLayer - The zero-based index into the hpos array that indicates the layer in which to find the member.flags - A constant that identifies whether to include page edge information if the QDR is not for the page edge. Valid constants are listed in the See Also section.QDR object that refers to the data at the specified hpos and memberlayer within the hpos. This implementation returns null.EdgeOutOfRangeException - If edge is not valid.LayerOutOfRangeException - If memberLayer is not valid for the specified edge.SliceOutOfRangeException - If the values in the hpos array are not valid relative indices in the specified hierarchy.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGEpublic QDR getLayerQDR(int edge, int layer, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException
QDR object that represents the specified logical layer.edge - A constant that represents the edge in which to find the logical layer. The constants end with _EDGE in DataDirector.layer - The zero-based index of the logical layer for which to return the QDR.flags - A constant that identifies whether to include page edge information if the QDR is not for the page edge. Valid constants are listed in the See Also section.QDR object that refers to the data in the specified layer. This implementation returns null.EdgeOutOfRangeException - If edge is not valid.LayerOutOfRangeException - If the logical layer is not valid for the specified edge.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE, DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE
public int findMember(int edge,
int[] hPos,
int memberLayer,
java.lang.String s,
java.lang.String type,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
getMemberChildCount. Returns the relative index in the specified hierarchical location for the member where the search value is found.edge - A constant that represents the edge along which to search. The constants end with _EDGE in DataDirector.hPos - The hierarchically specified set of values to search. An array of relative indexes that are organized by logical layer. The indexes start at layer 0 and extend at least through the layer indicated by memberlayer. The relative indexes that are specified for the outermost layers indicate a parent tree of members; the relative index for the innermost layer indicates a zero-based starting position within the set of sibling members at which to start the search.memberLayer - The zero-based index into the hPos array for indicating the starting position for the search operation.s - The String to find.type - A constant that indicates the type of metadata for which to search. Valid type values are defined in MetadataMap.flags - The type of search - not yet defined.String is not found. This implementation returns -1.EdgeOutOfRangeException - If edge is invalid.LayerOutOfRangeException - If memberlayer is invalid for the edge.SliceOutOfRangeException - If hPos that are not valid relative indexes 0.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public boolean isFetched(int[] startSlice,
int[] endSlice)
throws SliceOutOfRangeException
For example, this method can be used for a printing routine that wants to keep the UI running and to be sure that the block of data that it is about to print has already been fetched.
Implementors are not required to support this method. This implementation returns true.
startSlice - A list of starting slices that define one "side" of the data block, organized by edge. For example, this parameter might refer to the starting column and row. This method ignores array elements above the maximum supported edge.endSlice - A matching list (as defined by startSlice) of ending slices that define the other "side" of the data block. For example, this parameter might refer to the ending column and row. This method ignores array elements above the maximum supported edge.true if the block of data has been fetched locally or if the call is unsupported; false if the block of data has not been fetched locally.SliceOutOfRangeException - If any of the slices are invalid.
public boolean forceFetch(int[] startSlice,
int[] endSlice)
throws SliceOutOfRangeException
isFetched will return true.
Implementors are not required to support this method. This implementation returns true.
startSlice - A list of starting slices that define one "side" of the data block, organized by edge. For example, this parameter might refer to the starting column and row. This method ignores array elements above the maximum supported edge.endSlice - A matching list (as defined by startSlice) of ending slices that define the other "side" of the data block. For example, this parameter might refer to the ending column and row. This method ignores array elements above the maximum supported edge.true If the block of data was successfully fetched or if the method is not supported. false if the block of data was not fetched.SliceOutOfRangeException - If any of the slices are invalid.public void release()
DataAccess reference. Provides an opportunity for cleaning up the cursor when a caller is finished with it.
Views should not call this method for normal DataAccess instances, because calling this method makes the DataAccess reference unavailable to other presentation beans that might be using it. This method is useful only in special cases where a caller has wrapped a DataAccess around a private single-layer cursor.
The implementor may or may not implement this method, depending on the underlying cursor.
public void startGroupEdit()
setValue calls. This group of setValue calls will be treated as a unit in terms of undo and redo actions. For this reason, it is important that endGroupEdit is called when the client finishes the group editing.setValue(java.lang.Object, int, int, java.lang.String), endGroupEdit()public void endGroupEdit()
setValue calls. This group of setValue calls will be treated as a unit in terms of undo and redo actions.setValue(java.lang.Object, int, int, java.lang.String), startGroupEdit()public boolean submitChanges()
QDR overrides in the writeback collection to the database and flushes the entries in the writeback collection. This implementation returns false.true if changes are submitted successfully; false if changes are not submitted successfully.public boolean undoEdit()
setValue operation. This implementation returns false.true if the undo was successful; false if the undo was not successful.public boolean redoEdit()
undo action. This implementation returns false.true if the redo was successful; false if the redo was not successful.public boolean dropChanges()
QDR overrides in the writeback collection. This implementation returns false.true if the clear operation was successful; false if the clear operation was not successful.public void setAutoSubmit(boolean bValue)
QDR override in the writeback collection for a cell will be submitted automatically as soon as it is entered.bValue - true specifies automatic submission; false specifies no automatic submission.public boolean isAutoSubmit()
false.true specifies that automatic submission is set for cell editing; false specifies that automatic submission is not set for cell editing.public java.util.Vector getQDRoverrideCollection()
QDR overrides in the writeback collection.
This implementation returns null.
QDR overrides in the writeback collection.
public boolean pivot(int fromEdge,
int toEdge,
int fromLayer,
int toLayer,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException
false.pivot in interface DataDirectorfromEdge - A constant that indicates the edge from which a layer should be pivoted. Valid constants end with _EDGE in this interface.toEdge - A constant that indicates the edge to which a layer should be pivoted. Valid constants end with _EDGE in this interface.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 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.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_MOVE_TO, DataDirector.PIVOT_SWAP
public boolean pivotOK(int fromEdge,
int toEdge,
int fromLayer,
int toLayer,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException
pivot method and does not perform the actual pivot. The data provider determines its own rules for valid pivot operations.
This implementation returns false.
pivotOK in interface DataDirectorfromEdge - A constant that indicates the edge from which a layer should be pivoted. Valid constants end with _EDGE in this interface.toEdge - A constant that indicates the edge to which a layer should be pivoted. Valid constants end with _EDGE in this interface.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 this interface.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.EdgeOutOfRangeException - If either edge is too large.LayerOutOfRangeException - If either depth is negative or too large.DataDirectorException - If a data provider error occurs.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_MOVE_TO, DataDirector.PIVOT_SWAP
public boolean drill(int edge,
int layer,
int slice,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException
This implementation returns false.
drill in interface DataDirectoredge - A constant that indicates the edge to drill. Valid constants end with _EDGE in this interface.layer - The zero-based index of the physical layer of the member to be drilled. The outermost layer on the edge is 0.slice - The zero-based index (along the specified edge) of the slice that represents the member that is to be drilled. Each member in the innermost layer has a unique slice. In outer layers, any slice that the member spans can be used.flags - Not yet defined.true if the drill operation is successful; false if the drill operation is not successful.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.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public boolean drillOK(int edge,
int layer,
int slice,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException
drill method and does not perform the actual drill.
This implementation returns false.
drillOK in interface DataDirectoredge - A constant that indicates the edge to drill. Valid constants end with _EDGE in this interface.layer - The zero-based index of the physical layer of the member that is to be drilled. The outermost layer on the edge is 0.slice - The zero-based index (along the specified edge) of the slice that represents the members that are to be drilled. Each member in the innermost layer has a unique slice. In outer layers, any slice that the member spans can be used.flags - Not yet defined.true if the specified drilling operation is legal, false if the specified operation is not legal.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.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public boolean drill(int edge,
int layer,
int[] slice,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException
This implementation returns false.
drill in interface DataDirectoredge - A constant that indicates the edge to drill. Valid constants end with _EDGE in this interface.layer - The zero-based index of the physical layer of the members to be drilled. The outermost layer on the edge is 0.slice - A list of the zero-based indexes (along the specified edge) of the slices that represent the members that are to be drilled. Each member in the innermost layer has a unique slice. In outer layers, any slice that the member spans can be used.flags - Not yet defined.true if the drill operation is successful, false if the drill operation is not successful.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.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public boolean drillOK(int edge,
int layer,
int[] slice,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException
drill method and does not perform the actual drill.
This implementation returns false.
drillOK in interface DataDirectoredge - A constant that indicates the edge to drill. Valid constants end with _EDGE in this interface.layer - The zero-based index of the physical layer of the member to be drilled. The outermost layer on the edge is 0.slice - A list of the zero-based indexes (along the specified edge) of the slices that represent the members that are to be drilled. Each member in the innermost layer has a unique slice. In outer layers, any slice that the member spans can be used.flags - Not yet defined.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.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public boolean changeEdgeCurrentSlice(int edge,
int slice)
throws EdgeOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException
slice parameter to indicate the new current slice.
This implementation returns false.
changeEdgeCurrentSlice in interface DataDirectoredge - A constant that indicates the edge on which to change the current slice. Valid constants end with _EDGE in this interface.slice - The zero-based index (along the specified edge) of the slice that is to become the current slice.true if the change is successful, false if the change is not successful.EdgeOutOfRangeException - If edge is too large.SliceOutOfRangeException - If slice is too large.DataDirectorException - If a data provider error occurs.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public boolean changeEdgeCurrentHPos(int edge,
int[] hPos,
int maxLayerSpecified)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException
This implementation returns false.
changeEdgeCurrentHPos in interface DataDirectoredge - A constant that indicates the edge on which to make the change. Valid constants end with _EDGE in this interface.hPos - An array of relative indexes starting with the outermost layer and working in at least to maxLayerSpecified. This array indicates the set of new values to give to the various layers that specify the new current slice.maxLayerSpecified - The maximum index into hPos (layer) that this method should use in making the change to the current slice.true if the current slice change is successful, false if the current slice change is not successful.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.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public boolean reorder(int edge,
int fromLayer,
int toLayer,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException
Table object. The flags parameter uses the pivot constants from this interface to specify the operation that is to be performed. These constants are as follows:
PIVOT_SWAP -- Swaps fromLayer with toLayer.PIVOT_MOVE_BEFORE -- Moves fromLayer before toLayer.PIVOT_MOVE_AFTER -- Moves fromLayer after toLayer.reorder in interface DataDirectoredge - A constant that identifies the edge on which the reorder takes place. Valid constants end with _EDGE in this interface.fromLayer - The zero-based index of the physical layer (column) that the Table object wants to move. The outermost layer on the edge is 0.toLayer - The zero-based index of the physical layer (column) with which or to which the Table object is moving the fromLayer. The outermost layer on the edge is 0.flags - A constant that indicates the operation to be performed. The constants begin with PIVOT_ in this interface.true if reordering is successful, false if reordering is not successful.EdgeOutOfRangeException - If edge is too large.LayerOutOfRangeException - If layer is negative or too large.DataDirectorException - If a data provider error occurs.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.PIVOT_MOVE_AFTER, DataDirector.PIVOT_MOVE_BEFORE, DataDirector.PIVOT_SWAP, DataDirector.ROW_EDGE
public boolean insertValueCalc(int row,
int column,
int flags,
java.lang.Object calc)
throws RowOutOfRangeException,
ColumnOutOfRangeException,
DataDirectorException
This implementation returns false.
insertValueCalc in interface DataDirectorrow - The row at which to insert the calculation.column - The column at which to insert the calculation.flags - Not yet defined.calc - Not yet defined.true if the calculation is inserted, false if the calculation is not inserted.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 DataDirectoredge - A constant that specifies the edge that contains the member at which to insert the calculation. Valid constants end with _EDGE in this interface.layer - The zero-based index of the physical layer that contains the member at which to insert the calculation. The outermost layer on the edge is 0.slice - The zero-based index (along the specified edge) of the slice at which to insert the calculation.flags - Not yet defined.calc - Not yet defined.true if the calculation is inserted, false if the calculation is not inserted.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.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE
public boolean deleteValueCalc(int row,
int column)
throws RowOutOfRangeException,
ColumnOutOfRangeException,
DataDirectorException
This implementation returns false.
deleteValueCalc in interface DataDirectorrow - 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 the calculation is not deleted.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 deleteMemberCalc(int edge,
int layer,
int slice)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException,
DataDirectorException
This implementation returns false.
deleteMemberCalc in interface DataDirectoredge - A constant that specifies the edge that contains the member for which to delete the calculation. Valid constants end with _EDGE in this interface.layer - The zero-based index of the physical layer that contains the member for which to delete the calculation. The outermost layer on the edge is 0.slice - The zero-based index (along the specified edge) of the slice at which to delete the calculation.true if the calculation is deleted, false if the calculation is not deleted.LayerOutOfRangeException - If layer is negative or too large.SliceOutOfRangeException - If sliceDataDirectorException - If a data provider error occurs.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGEpublic void addDataDirectorListener(DataDirectorListener l)
This implementation does nothing.
addDataDirectorListener in interface DataDirectorl - The listener to add.public void removeDataDirectorListener(DataDirectorListener l)
This implementation does nothing.
removeDataDirectorListener in interface DataDirectorl - The listener to remove.
public boolean refresh()
throws DataDirectorException
This implementation returns false.
refresh in interface DataDirectortrue if data will be refreshed, false if data will not be refreshed.DataDirectorException - If a data provider error occurs
public boolean revalidate()
throws DataDirectorException
This implementation returns false.
revalidate in interface DataDirectortrue if data will be refreshed, false if data will not be refreshedDataDirectorException - If a data provider error occurs
public void setOutline(boolean outline)
throws DataDirectorException
For example, if the row edge uses outline form, all layers appear in the same label column. If the row edge does not use outline form, then there is a separate column for each layer.
This implementation does nothing.
setOutline in interface DataDirectoroutline - true to specify outline form for data, false to use inline form for data.DataDirectorException - If a data provider error occurspublic boolean isOutline()
false if the implementor does not support outline form.
In a Crosstab, for example, if a row edge uses outline form, then all layers appear in the same label column. If a row edge does not use outline form, then there is a separate column for each layer.
This implementation returns false.
isOutline in interface DataDirectortrue if the data is provided in outline form, false if the data is provided in inline form.
public void setMetadataMap(int edge,
int layer,
MetadataMap map,
int size)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
DataDirectorException
This implementation does nothing.
setMetadataMap in interface DataDirectoredge - A constant that indicates the edge that contains the logical layer of interest. Valid constants end with _EDGE in this interface. To set a default map for all edges, pass -1.layer - The index for the logical layer whose MetadataMap is to be set. To refer to all of the layers on an edge, use -1.map - A list of the metadata types that the implementor should fetch for the specified layer, if possible.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. This parameter is ignored if the implementor does not support partial fetches.EdgeOutOfRangeException - If edge is out of range.LayerOutOfRangeException - If layer is out of range.DataDirectorException - If a data provider error occurs.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGEpublic void setDataMap(DataMap map, int sizeRow, int sizeColumn) throws DataDirectorException
This implementation does nothing.
setDataMap in interface DataDirectormap - A list of the data types that the caller expects 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
layer. This list includes the types of metadata that have been specified in setMetadataMap requests by any views that use this data provider.
This implementation returns null.
getMetadataMap in interface DataDirectoredge - A constant that indicates the edge that contains the logical layer. Valid constants end with _EDGE in this interface. A value of -1 is a request for the default MetadataMap.layer - A zero-based index for the logical layer for which to retrieve the metadata map. The outermost layer on the specified edge is zero. A layer value of -1 indicates all of the layers on the specified edge.layer.EdgeOutOfRangeException - if edge is out of range.LayerOutOfRangeException - If no layer exists at this location.DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGEpublic DataMap getDataMap()
This implmentation returns null.
getDataMap in interface DataDirectorpublic boolean isCancelable()
DataDirector implementor allows views to cancel an operation that takes a long time.
This implementation returns false.
isCancelable in interface DataDirectortrue if the data provider supports cancelation of long operations, false if not.
public boolean cancel()
throws DataDirectorException
This implementation returns false.
cancel in interface DataDirectorfalse if the implementor did not or could not cancel the operation.DataDirectorException - If a data provider error occurspublic void setManualUpdate()
update are batched.
This implementation does nothing.
setManualUpdate in interface DataDirectorupdate()
public void update()
throws DataDirectorException
setManualUpdate and this method are batched. This method should also turn off manual update mode.
This implementation does nothing.
update in interface DataDirectorDataDirectorException - If a data provider error occurssetManualUpdate()public MetadataMap getSupportedMetadataMap()
MetadataMap that contains all of the types that this DataAccessAdapter can support. Some types of metadata might not be available in some types of queries.getSupportedMetadataMap in interface DataDirectornull.public LayerMetadataMap getSupportedLayerMetadataMap()
LayerMetadataMap that contains all of the types that this DataAccessAdapter can support. Some types of layer metadata might not be available in some types of queries.getSupportedLayerMetadataMap in interface DataDirectornull.public DataMap getSupportedDataMap()
DataMap that contains all of the types that this DataAccessAdapter can support. Some types of data might not be available in some types of queries.getSupportedDataMap in interface DataDirectornull.
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||