oracle.dss.util.DataAccessAdapter
oracle.dss.dataView.LocalPivotTableDataSource
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1.7.0) E12063-08 |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class LocalPivotTableDataSource
| Field Summary | |
|---|---|
protected DataDirectorListener |
listener
|
| Fields inherited from interface oracle.dss.util.DataAccess |
|---|
DATATYPE_BOOLEAN, DATATYPE_DATE, DATATYPE_DOUBLE, DATATYPE_FLOAT, DATATYPE_INTEGER, DATATYPE_LONG, DATATYPE_SHORT, DATATYPE_STRING, FIND_CASE_INSENSITIVE, FIND_CONTAINS, FIND_ENDS_WITH, FIND_EXACT, FIND_PRIOR, FIND_STARTS_WITH, QDR_WITH_PAGE, QDR_WITHOUT_PAGE |
| Constructor Summary | |
|---|---|
LocalPivotTableDataSource()
|
|
| Method Summary | |
|---|---|
void |
addDataDirectorListener(DataDirectorListener l)
Registers a listener to the data source for changes. |
boolean |
allSlicesFetched(int edge)
Returns true if all slices the entire given edge
have been fetched and are available. |
java.lang.Object |
clone()
|
CubeDataDirector |
createCubeDataDirector()
Creates a DataDirector for cube-based (OLAP) views |
DataDirector |
createDataDirector()
|
RelationalDataDirector |
createRelationalDataDirector()
Creates a DataDirector for relational views. |
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)
|
boolean |
forceFetch(int[] startSlice,
int[] endSlice,
int flag)
Ensures that a block of data has been fetched or computed locally. |
int |
getBranchingFactor(int edge)
|
java.util.List |
getCorrespondingMemberMetadata(int edge,
int layer,
java.lang.String[] values,
java.lang.String[] types,
boolean inDataAccess)
Returns a List of Object
arrays of member metadata corresponding to the given
MetadataMap.METADATA_VALUE strings
specified in the values parameter. |
java.util.List |
getCorrespondingMemberMetadata(java.lang.String layerName,
java.lang.String[] values,
java.lang.String[] types,
boolean inDataAccess)
Returns a List of Object
arrays of member metadata corresponding to the given
MetadataMap.METADATA_VALUE strings
specified in the values parameter. |
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)
Returns a String of the form "EdgeXLayerYY", e.g. |
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 layer,
int slice,
int flags)
Returns a QDR in which each member is named after its start slice, e.g. |
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). |
int[] |
getSlicesFromQDR(QDRInterface qdr,
int[] startSlices,
int[] endSlices)
Per the DataAccess contract, this method returns: {-1, -1} if qdr is empty or invalid {c, -1} if qdr is a column QDR {-1, r} if qdr is a row QDR {c, r} if qdr is a databody QDR where r and c are the row number and column number of the QDR |
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.util.List |
getUniqueDataValues(java.lang.String name,
java.lang.String[] types,
int start,
int count)
|
java.util.List |
getUniqueMemberMetadata(int edge,
int layer,
java.lang.String[] types,
int start,
int count)
Returns an unordered List of
Object arrays representing metadata for
unique member values across a layer on an edge. |
java.util.List |
getUniqueMemberMetadata(java.lang.String layerName,
java.lang.String[] types,
int start,
int count)
Returns an unordered List of
Object arrays representing metadata for
unique member values across a layer on an edge. |
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 |
isAutoSubmit()
Indicates whether automatic submission is set for cell editing. |
boolean |
isFetched(int[] startSlice,
int[] endSlice)
|
boolean |
isFetched(int[] startSlice,
int[] endSlice,
int flag)
Indicates whether a block of data has been fully computed or processed locally. |
boolean |
isMemberExtentComplete(int edge,
int layer,
int slice)
Determines if 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), has been completely calculated. |
boolean |
redoEdit()
Performs a redo of the latest undo action. |
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. |
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 |
setBranchingFactor(int edge,
int branchingFactor)
|
void |
setEdgeExtent(int edge,
int extent)
|
void |
setLayerCount(int edge,
int layerCount)
|
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. |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface oracle.dss.util.DataDirector |
|---|
cancel, changeEdgeCurrentHPos, changeEdgeCurrentSlice, deleteMemberCalc, deleteValueCalc, drill, drill, drill, drill, drillOK, drillOK, drillOK, drillOK, fireEvents, getColumnSorts, getCompatibleDataItemMetadata, getDataAccess, getDimensionSorts, getExpressions, getMemberSorts, getProperty, getSorts, getStatus, insertMemberCalc, insertValueCalc, isCancelable, isOutline, pivot, pivotCheck, pivotOK, refresh, reorder, revalidate, setColumnSorts, setDataMap, setDimensionSorts, setExpressions, setLayerMetadata, setManualUpdate, setMemberSorts, setMetadataMap, setOutline, setProperty, setSorts, startExecution, update |
| Methods inherited from interface oracle.dss.util.DataAccess |
|---|
findMembers, getLayerQDR, getMemberQDR |
| Methods inherited from interface oracle.dss.util.CDFDataAccess |
|---|
getEdgeSymmetric |
| Field Detail |
|---|
protected DataDirectorListener listener
| Constructor Detail |
|---|
public LocalPivotTableDataSource()
| Method Detail |
|---|
public void setEdgeExtent(int edge,
int extent)
public void setLayerCount(int edge,
int layerCount)
public int getBranchingFactor(int edge)
public void setBranchingFactor(int edge,
int branchingFactor)
public DataDirector createDataDirector()
public CubeDataDirector createCubeDataDirector()
DataSource
createCubeDataDirector in interface DataSourcepublic RelationalDataDirector createRelationalDataDirector()
DataSource
createRelationalDataDirector in interface DataSourcepublic void addDataDirectorListener(DataDirectorListener l)
DataAccessAdapterThis implementation does nothing.
addDataDirectorListener in interface DataDirectoraddDataDirectorListener in class DataAccessAdapterl - The listener to add.public void removeDataDirectorListener(DataDirectorListener l)
DataAccessAdapterThis implementation does nothing.
removeDataDirectorListener in interface DataDirectorremoveDataDirectorListener in class DataAccessAdapterl - The listener to remove.public java.lang.Object clone()
clone in class java.lang.Objectpublic DataMap getDataMap()
DataAccessAdapterThis implmentation returns null.
getDataMap in interface DataDirectorgetDataMap in class DataAccessAdapter
public MetadataMap getMetadataMap(int edge,
int layer)
throws EdgeOutOfRangeException,
LayerOutOfRangeException
DataAccessAdapterlayer.
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 DataDirectorgetMetadataMap in class DataAccessAdapteredge - 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_EDGE
public int getEdgeExtent(int edge)
throws EdgeOutOfRangeException
DataAccessAdapter
getEdgeExtent in interface CDFDataAccessgetEdgeExtent in class DataAccessAdapteredge - 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,
*
public java.lang.Object getValue(int row,
int col,
java.lang.String type)
throws RowOutOfRangeException,
ColumnOutOfRangeException
DataAccessAdapterThis implementation returns null.
getValue in interface DataAccessgetValue in class DataAccessAdapterrow - 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
DataAccessAdapterThis implementation returns false.
setValue in interface DataAccesssetValue in class DataAccessAdapterdata - The data to set into the cursor.row - The row at which to set the data.col - The column at which set the data.
truefalse if not.
RowOutOfRangeException - If row is negative or too
large.
ColumnOutOfRangeException - If column is negative or
too large.DataMap
public int getLayerCount(int edge)
throws EdgeOutOfRangeException
DataAccessAdapter
getLayerCount in interface CDFDataAccessgetLayerCount in class DataAccessAdapteredge - 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
DataAccessAdapterThis implementation returns 0.
getSliceMemberCount in interface DataAccessgetSliceMemberCount in class DataAccessAdapteredge - 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
DataAccessAdapterDataAccess 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.
getSliceOutlineLayer in interface DataAccessgetSliceOutlineLayer in class DataAccessAdapteredge - 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
DataAccessAdapter
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.
getMemberDepth in interface CDFDataAccessgetMemberDepth in class DataAccessAdapteredge - 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.DataAccessAdapter.getLayerCount(int),
DataAccessAdapter.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
DataAccessAdaptergetMemberDepth 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.
getMemberStartLayer in interface CDFDataAccessgetMemberStartLayer in class DataAccessAdapteredge - 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
DataAccessAdapterlayer 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.
getMemberLogicalLayer in interface DataAccessgetMemberLogicalLayer in class DataAccessAdapteredge - 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
getLayerMetadata in interface CDFDataAccessgetLayerMetadata in class DataAccessAdapteredge - 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
DataAccessAdapter
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.
getMemberExtent in interface CDFDataAccessgetMemberExtent in class DataAccessAdapteredge - 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 large
SliceOutOfRangeException - If slice is negative or
too largeDataAccessAdapter.getMemberStartSlice(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
DataAccessAdaptergetMemberExtent.
This implementation returns 0.
getMemberStartSlice in interface CDFDataAccessgetMemberStartSlice in class DataAccessAdapteredge - 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.DataAccessAdapter.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
DataAccessAdapter
getMemberMetadata in interface CDFDataAccessgetMemberMetadata in class DataAccessAdapteredge - 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.
SliceOutOfRangeException - If slice is negative or
too large.
EdgeOutOfRangeExceptionMetadataMap,
DataDirector.COLUMN_EDGE,
DataDirector.PAGE_EDGE,
DataDirector.ROW_EDGE
public boolean isFetched(int[] startSlice,
int[] endSlice)
throws SliceOutOfRangeException
SliceOutOfRangeException
public boolean forceFetch(int[] startSlice,
int[] endSlice)
throws SliceOutOfRangeException
SliceOutOfRangeException
public boolean isMemberExtentComplete(int edge,
int layer,
int slice)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
DataAccess
isMemberExtentComplete in interface DataAccessisMemberExtentComplete in class DataAccessAdapteredge - 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 number of the physical layer.
Valid values are zero to total layers at the specified
slice.slice - An absolute index (zero-based) along the edge.
Each member in the innermost layer has a unique slice.
In outer layers, any slice that the outer member spans
can be used.
true if the extent of the specified member has been fully computed,
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.CDFDataAccess.getMemberStartSlice(int, int, int),
CDFDataAccess.getMemberExtent(int, int, int),
DataDirector.COLUMN_EDGE,
DataDirector.PAGE_EDGE,
DataDirector.ROW_EDGEpublic int getEdgeCount()
DataAccessAdapterThis implementation returns 1.
getEdgeCount in interface CDFDataAccessgetEdgeCount in class DataAccessAdapter
public java.lang.Object getSliceLabel(int edge,
int slice,
java.lang.String type)
throws EdgeOutOfRangeException,
SliceOutOfRangeException
DataAccessAdapter
getSliceLabel in interface DataAccessgetSliceLabel in class DataAccessAdapteredge - 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
DataAccessAdapter
getEdgeCurrentSlice in interface DataAccessgetEdgeCurrentSlice in class DataAccessAdapteredge - 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
DataAccessAdapter
getEdgeCurrentHPos in interface DataAccessgetEdgeCurrentHPos in class DataAccessAdapteredge - 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[] getSlicesFromQDR(QDRInterface qdr,
int[] startSlices,
int[] endSlices)
getSlicesFromQDR in interface DataAccessgetSlicesFromQDR in class DataAccessAdapterqdr - QDR representing a position (edge member, edge slice, or data cell)startSlices - optional set of slices, ordered by edge (column edge 0, row edge 1, etc.),
specifying the beginning of a viewport
within which getSlicesFromQDR should check for the QDR.
endSlices optional set of slices, ordered by edge (see startSlices), specifying the end of a viewport within
which getSlicesFromQDR should check for the QDR.
public int getMemberSiblingCount(int edge,
int[] hPos,
int memberLayer)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
DataAccessAdapter
| 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.
getMemberSiblingCount in interface DataAccessgetMemberSiblingCount in class DataAccessAdapteredge - 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.DataAccessAdapter.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
DataAccessAdapterThe 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).
getMemberMetadata in interface DataAccessgetMemberMetadata in class DataAccessAdapteredge - 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
DataAccessAdapterhPos 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.
getMemberHPos in interface DataAccessgetMemberHPos in class DataAccessAdapteredge - 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.
EdgeOutOfRangeException - If edge is too large.
LayerOutOfRangeException - If memberLayer is too
large.
SliceOutOfRangeException - If any slice in hPos
is too largeDataDirector.COLUMN_EDGE,
DataDirector.PAGE_EDGE,
DataDirector.ROW_EDGE
public int[] getFirstHPos(int edge)
throws EdgeOutOfRangeException
DataAccessAdapter
getFirstHPos in interface DataAccessgetFirstHPos in class DataAccessAdapteredge - 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
DataAccessAdapter
getLastHPos in interface DataAccessgetLastHPos in class DataAccessAdapteredge - 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
DataAccessAdapterhPos 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.
getPrevHPos in interface DataAccessgetPrevHPos in class DataAccessAdapteredge - 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 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
DataAccessAdapterhPos.
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.
getNextHPos in interface DataAccessgetNextHPos in class DataAccessAdapteredge - 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 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 findMember(int edge,
int[] hPos,
int memberLayer,
java.lang.String s,
java.lang.String type,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
DataAccessAdaptergetMemberChildCount.
Returns the relative index in the specified hierarchical location for
the member where the search value is found.
findMember in interface DataAccessfindMember in class DataAccessAdapteredge - 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_EDGEpublic void release()
DataAccessAdapterDataAccess 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.
release in interface DataAccessrelease in interface DataDirectorrelease in class DataAccessAdapterpublic void startGroupEdit()
DataAccessAdaptersetValue 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.
startGroupEdit in interface DataAccessstartGroupEdit in class DataAccessAdapterDataAccessAdapter.setValue(java.lang.Object, int, int, java.lang.String),
DataAccessAdapter.endGroupEdit()public void endGroupEdit()
DataAccessAdaptersetValue calls.
This group of setValue calls will be treated as a unit in
terms of undo and redo actions.
endGroupEdit in interface DataAccessendGroupEdit in class DataAccessAdapterDataAccessAdapter.setValue(java.lang.Object, int, int, java.lang.String),
DataAccessAdapter.startGroupEdit()public boolean submitChanges()
DataAccessAdapterQDR overrides
in the writeback collection to the database and
flushes the entries in the writeback collection.
This implementation returns false.
submitChanges in interface DataAccesssubmitChanges in class DataAccessAdaptertrue if changes are submitted successfully;
false if changes are not submitted successfully.public boolean undoEdit()
DataAccessAdaptersetValue operation.
This implementation returns false.
undoEdit in interface DataAccessundoEdit in class DataAccessAdaptertrue if the undo was successful;
false if the undo was not successful.public boolean redoEdit()
DataAccessAdapterundo action.
This implementation returns false.
redoEdit in interface DataAccessredoEdit in class DataAccessAdaptertrue if the redo was successful;
false if the redo was not successful.public boolean dropChanges()
DataAccessAdapterQDR overrides in the writeback collection.
This implementation returns false.
dropChanges in interface DataAccessdropChanges in class DataAccessAdaptertrue if the clear operation was successful;
false if the clear operation was not successful.public void setAutoSubmit(boolean bValue)
DataAccessAdapterQDR override in the writeback collection for a cell
will be submitted automatically as soon as it is entered.
setAutoSubmit in interface DataAccesssetAutoSubmit in class DataAccessAdapterbValue - true specifies automatic submission;
false specifies no automatic submission.public boolean isAutoSubmit()
DataAccessAdapterfalse.
isAutoSubmit in interface DataAccessisAutoSubmit in class DataAccessAdaptertrue 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()
DataAccessAdapterQDR overrides in the writeback
collection.
This implementation returns null.
getQDRoverrideCollection in interface DataAccessgetQDRoverrideCollection in class DataAccessAdapterQDR overrides in the writeback
collection.
public java.util.List getUniqueMemberMetadata(int edge,
int layer,
java.lang.String[] types,
int start,
int count)
throws EdgeOutOfRangeException,
LayerOutOfRangeException
DataAccessList of
Object arrays representing metadata for
unique member values across a layer on an edge. The
Object arrays correspond one-to-one
with the MetadataMap types specified in
the types parameter.
An example of a types array might be:
new String[] {MetadataMap.METADATA_VALUE,
MetadataMap.METADATA_LONGLABEL}
In this case, the method would return the unique set
of values and their longlabels found across the
given layer on the given edge. This list will be
complete if the layer does not depend on any other
layers (symmetric). If it is asymmetric, the
number of items scanned will be constrained by no
more than count number of unique items
or an implementation-dependent limitation on the
number of outer layer parents scanned.
The return value might be:
listElement(0) = new Object[] {"TOTALPROD",
"Total Products"}
listElement(1) = new Object[] {"AUDIODIV",
"Audio Division"}
listElement(2) = new Object[] {"CAMCORDER",
"Camcorder"}\
If start were 1 and count
were -1, then only listElement items 1
and 2 would be returned as the 0th and 1th items in
the List. Normally,
start will be 0 and count
will be -1.
getUniqueMemberMetadata in interface DataAccessgetUniqueMemberMetadata in class DataAccessAdapteredge - The edge containing the layer for which to build the member listlayer - The zero-based index of the physical layer for which to build the member listtypes - An array of MetadataMap types indicating the nature of the returned metadata in the Vector elementsstart - Starting point in the overall unique member list of the return list. Zero indicates start from the beginning.count - Maximum number of unique values to return, beginning at index start. -1 indicates all values
should be returned. Ignored in symmetric cases. The caller is free to ignore values
returned beyond their requested count if they are managing fixed size virtual buffers.
EdgeOutOfRangeException - If edge is too large.
LayerOutOfRangeException - If layer is negative
or too large.DataDirector.COLUMN_EDGE,
DataDirector.ROW_EDGE,
DataDirector.PAGE_EDGE,
MetadataMap
public java.util.List getUniqueMemberMetadata(java.lang.String layerName,
java.lang.String[] types,
int start,
int count)
throws LayerOutOfRangeException,
SliceOutOfRangeException
DataAccessList of
Object arrays representing metadata for
unique member values across a layer on an edge. The
Object arrays correspond one-to-one
with the MetadataMap types specified in
the types parameter.
An example of a types array might be:
new String[] {MetadataMap.METADATA_VALUE,
MetadataMap.METADATA_LONGLABEL}
In this case, the method would return the unique set
of values and their longlabels found across the
given layerName layer. This list will
be complete if the layer does not depend on any
other layers (symmetric). If it is asymmetric, the
number of items scanned will be constrained by no
more than count number of unique items
or an implementation-dependent limitation on the
number of outer layer parents scanned.
The return value might be:
listElement(0) = new Object[] {"TOTALPROD",
"Total Products"}
listElement(1) = new Object[] {"AUDIODIV",
"Audio Division"}
listElement(2) = new Object[] {"CAMCORDER",
"Camcorder"}\
If start were 1 and count
were -1, then only listElement items 1
and 2 would be returned as the 0th and 1th items in
the List. Normally,
start will be 0 and count
will be -1.
getUniqueMemberMetadata in interface DataAccessgetUniqueMemberMetadata in class DataAccessAdapterlayerName - The name of the layer at which to find the given values. This value should correspond to
a name obtained via a dataAccess.getLayerMetadata(edge, layer, LayerMetadataMap.LAYER_METADATA_NAME) call.types - An array of MetadataMap types indicating the nature of the returned metadata in the Vector elementsstart - Starting point in the overall unique member list of the return list. Zero indicates start from the beginning.count - Maximum number of unique values to return, beginning at index start. -1 indicates all values
should be returned. Ignored in symmetric cases. The caller is free to ignore values
returned beyond their requested count if they are managing fixed size virtual buffers.
LayerOutOfRangeException - If the layerName is not found at any edge or layer in the DataAccess.
SliceOutOfRangeException - If a problem with counting the members occursDataDirector.COLUMN_EDGE,
DataDirector.ROW_EDGE,
DataDirector.PAGE_EDGE,
MetadataMap,
LayerMetadataMap
public java.util.List getCorrespondingMemberMetadata(int edge,
int layer,
java.lang.String[] values,
java.lang.String[] types,
boolean inDataAccess)
throws EdgeOutOfRangeException,
LayerOutOfRangeException
DataAccessList of Object
arrays of member metadata corresponding to the given
MetadataMap.METADATA_VALUE strings
specified in the values parameter.
The Object arrays correspond one-to-one
with the MetadataMap types in the
types parameter. For example, a
call such as:
List listElement =
dataAccess.getCorrespondingMemberMetadata(
DataDirector.COLUMN_EDGE, 1, new String[] {"UK",
"AMERICAS"}, new String[]
{MetadataMap.METADATA_LONGLABEL,
MetadataMap.METADATA_INDENT}, true);
would return, assuming UK and AMERICAS were
contained in the current DataAccess
results at the column edge, layer 1:
listElement(0) = {"United Kingdom", 2.0}
listElement(1) = {"Areas in the Americas",
1.0}
The inDataAccess parameter is for
future use for finding metadata that may be
outside the current DataAccess results.
getCorrespondingMemberMetadata in interface DataAccessgetCorrespondingMemberMetadata in class DataAccessAdapteredge - The edge in which to find the layer potentially containing the given values.layer - The layer in which to find the given values.types - An array of MetadataMap types indicating the nature of the returned metadata in the Vector elementsinDataAccess - Assumed to be true at this time. Only return corresponding Metadata for values
found in DataAccess. The returned Vector will contain a null element for values that
are not found at all.
EdgeOutOfRangeException - If edge is too large.
LayerOutOfRangeException - If layer is negative
or too large.DataDirector.COLUMN_EDGE,
DataDirector.ROW_EDGE,
DataDirector.PAGE_EDGE,
MetadataMap
public java.util.List getCorrespondingMemberMetadata(java.lang.String layerName,
java.lang.String[] values,
java.lang.String[] types,
boolean inDataAccess)
throws LayerOutOfRangeException
DataAccessList of Object
arrays of member metadata corresponding to the given
MetadataMap.METADATA_VALUE strings
specified in the values parameter.
The Object arrays correspond one-to-one
with the MetadataMap types in the
types parameter. For example, a
call such as:
List listElement =
dataAccess.getCorrespondingMemberMetadata(
"MDM!D_XADEMO.GEOGRAPHY", new String[] {"UK",
"AMERICAS"}, new String[]
{MetadataMap.METADATA_LONGLABEL,
MetadataMap.METADATA_INDENT}, true);
would return, assuming UK and AMERICAS were
contained in the current DataAccess
results at the layer named "MDM!D_XADEMO.GEOGRAPHY":
listElement(0) = {"United Kingdom", 2.0}
listElement(1) = {"Areas in the Americas",
1.0}
The inDataAccess parameter is for
future use for finding metadata that may be
outside the current DataAccess results.
getCorrespondingMemberMetadata in interface DataAccessgetCorrespondingMemberMetadata in class DataAccessAdapterlayerName - The name of the layer at which to find the given values. This value should correspond to
a name obtained via a dataAccess.getLayerMetadata(edge, layer, LayerMetadataMap.LAYER_METADATA_NAME) call.types - An array of MetadataMap types indicating the nature of the returned metadata in the Vector elementsinDataAccess - Assumed to be true at this time. Only return corresponding Metadata for values
found in DataAccess. The returned Vector will contain a null element for values that
are not found at all.
LayerOutOfRangeException - If the layerName is not found at any edge and layer in the DataAccess.MetadataMap,
LayerMetadataMap
public java.util.List getUniqueDataValues(java.lang.String name,
java.lang.String[] types,
int start,
int count)
throws LayerOutOfRangeException,
SliceOutOfRangeException
LayerOutOfRangeException
SliceOutOfRangeException
public boolean allSlicesFetched(int edge)
throws EdgeOutOfRangeException
DataAccessAdaptertrue if all slices the entire given edge
have been fetched and are available. A true return
value implies that the value returned by getEdgeExtent
for the same edge parameter is the actual total number of slices
available on the edge. A false value indicates that
the getEdgeExtent return value represents the number of
slices available without further data fetching, but that the
implementation believes there are more slices available and that
fetching of these slices will occur upon a
forceFetch call or other implementation-specific
view/DataSource interactions
allSlicesFetched in interface DataAccessallSlicesFetched in class DataAccessAdapteredge - The edge for which to determine if all slices have
been fetched
true if all slices have been fetched
EdgeOutOfRangeException - If edge is invalid
public boolean isFetched(int[] startSlice,
int[] endSlice,
int flag)
throws SliceOutOfRangeException
DataAccessFor 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.
isFetched in interface DataAccessisFetched in class DataAccessAdapterstartSlice - 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.flag - A DataDirector3 flag indicating the type of block
the caller is interested in (spans, relative indent, etc.)
true if the block of data has been computed locally
or if the call is unsupported;
false if the block of data has not been computed
locally.
SliceOutOfRangeException - If any of the slices are invalid.DataDirector3
public boolean forceFetch(int[] startSlice,
int[] endSlice,
int flag)
throws SliceOutOfRangeException
DataAccessisFetched will return true.
Implementors are not required to support this method.
forceFetch in interface DataAccessforceFetch in class DataAccessAdapterstartSlice - 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.flag - A bitwise DataDirector3 flag indicating the type of blocks
the caller is interested in (spans, relative indent, etc.)
true If the block of data was successfully computed
or if the method is not supported.
false if the block of data was not computed..
SliceOutOfRangeException - If the startSlice parameter is invalidDataDirector3public DataMap getSupportedDataMap()
DataAccessAdapterDataMap 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 DataDirectorgetSupportedDataMap in class DataAccessAdapternull.DataMappublic MetadataMap getSupportedMetadataMap()
DataAccessAdapterMetadataMap 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 DataDirectorgetSupportedMetadataMap in class DataAccessAdapternull.MetadataMappublic LayerMetadataMap getSupportedLayerMetadataMap()
DataAccessAdapterLayerMetadataMap 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 DataDirectorgetSupportedLayerMetadataMap in class DataAccessAdapternull.LayerMetadataMap
public QDR getMemberQDR(int edge,
int layer,
int slice,
int flags)
throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException
getMemberQDR in interface DataAccessgetMemberQDR in class DataAccessAdapteredge - 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_PAGE
public QDR getValueQDR(int row,
int column,
int flags)
throws RowOutOfRangeException,
ColumnOutOfRangeException
DataAccessAdapterQDR object that represents the value at the specified
row and column in the data area of the cursor.
getValueQDR in interface DataAccessgetValueQDR in class DataAccessAdapterrow - 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 RowOutOfRangeException - If the row parameter is
not valid.
ColumnOutOfRangeException - If the column parameter
is not valid.DataAccess.QDR_WITH_PAGE,
DataAccess.QDR_WITHOUT_PAGE
public QDR getSliceQDR(int edge,
int slice,
int flags)
throws EdgeOutOfRangeException,
SliceOutOfRangeException
DataAccessAdapterQDR object that represents the data value at the specified
slice on the edge (that is, across all relevant logical layers of the
slice).
getSliceQDR in interface DataAccessgetSliceQDR in class DataAccessAdapteredge - 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_PAGE
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1.7.0) E12063-08 |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||