oracle.dss.util
Interface DataAccess

All Superinterfaces:

CDFDataAccess

All Known Subinterfaces:

CubeDataAccess, RelationalDataAccess

All Known Implementing Classes:

DataAccessAdapter, GaugeLocalDataSource, LocalDataSource, LocalXMLDataSource, SampleDataSource

public interface DataAccess
extends CDFDataAccess

Methods that are necessary for a presentation bean to access data from a data provider.

Field Summary

static java.lang.String	DATATYPE_BOOLEAN Boolean data type, as defined by the data store.
static java.lang.String	DATATYPE_DATE Date data type, as defined by the data store.
static java.lang.String	DATATYPE_DOUBLE Double data type, as defined by the data store.
static java.lang.String	DATATYPE_FLOAT Float data type, as defined by the data store.
static java.lang.String	DATATYPE_INTEGER Integer data type, as defined by the data store.
static java.lang.String	DATATYPE_LONG Long data type, defined by the data store.
static java.lang.String	DATATYPE_SHORT Short data type, as defined by the data store.
static java.lang.String	DATATYPE_STRING String data type, as defined by the data store.
static int	FIND_CASE_INSENSITIVE Marks the search in the findMember method as case insensitive.
static int	FIND_CONTAINS Searches for strings that contain the given search string in the findMember method.
static int	FIND_ENDS_WITH Searches for strings that end with the given search string in the findMember method.
static int	FIND_EXACT Searches for an exact match in the findMember method.
static int	FIND_PRIOR Searches backwards through the list from the position down to 0 in the findMember method.
static int	FIND_STARTS_WITH Searches for strings that start with the given search string in the findMember method.
static int	QDR_WITH_PAGE Get QDR: Include current page edge information, even if the QDR is not for the page edge itself.
static int	QDR_WITHOUT_PAGE Get QDR: Do not include current page edge information, if the QDR is not for the page edge itself.

Method Summary

boolean	allSlicesFetched(int edge) Returns true if all slices on the entire given edge have been fetched and are available.
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, int flag) Ensures that a block of data has been fetched or computed locally.
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.
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 number of the slice that is defined by the implementor as the current slice.
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.
QDR	getLayerQDR(int edge, int layer, int flags) Retrieves the QDR object that represents the specified logical layer.
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.
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[]	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) Returns an array of absolute slice positions in an edge-orderered array (column edge 0, row edge 1, etc.), given a QDR specifying a position in the current cursor.
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, 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	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.
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 interface oracle.dss.util.CDFDataAccess

getEdgeCount, getEdgeExtent, getEdgeSymmetric, getLayerCount, getLayerMetadata, getMemberDepth, getMemberExtent, getMemberMetadata, getMemberStartLayer, getMemberStartSlice

Field Detail

FIND_EXACT

static final int FIND_EXACT

Searches for an exact match in the findMember method.

See Also:

Constant Field Values

FIND_CONTAINS

static final int FIND_CONTAINS

Searches for strings that contain the given search string in the findMember method.

See Also:

Constant Field Values

FIND_STARTS_WITH

static final int FIND_STARTS_WITH

Searches for strings that start with the given search string in the findMember method.

See Also:

Constant Field Values

FIND_ENDS_WITH

static final int FIND_ENDS_WITH

Searches for strings that end with the given search string in the findMember method.

See Also:

Constant Field Values

FIND_CASE_INSENSITIVE

static final int FIND_CASE_INSENSITIVE

Marks the search in the findMember method as case insensitive.

See Also:

Constant Field Values

FIND_PRIOR

static final int FIND_PRIOR

Searches backwards through the list from the position down to 0 in the findMember method.

See Also:

Constant Field Values

DATATYPE_BOOLEAN

static final java.lang.String DATATYPE_BOOLEAN

Boolean data type, as defined by the data store.

See Also:

Constant Field Values

DATATYPE_SHORT

static final java.lang.String DATATYPE_SHORT

Short data type, as defined by the data store.

See Also:

Constant Field Values

DATATYPE_INTEGER

static final java.lang.String DATATYPE_INTEGER

Integer data type, as defined by the data store.

See Also:

Constant Field Values

DATATYPE_LONG

static final java.lang.String DATATYPE_LONG

Long data type, defined by the data store.

See Also:

Constant Field Values

DATATYPE_FLOAT

static final java.lang.String DATATYPE_FLOAT

Float data type, as defined by the data store.

See Also:

Constant Field Values

DATATYPE_DOUBLE

static final java.lang.String DATATYPE_DOUBLE

Double data type, as defined by the data store.

See Also:

Constant Field Values

DATATYPE_STRING

static final java.lang.String DATATYPE_STRING

String data type, as defined by the data store.

See Also:

Constant Field Values

DATATYPE_DATE

static final java.lang.String DATATYPE_DATE

Date data type, as defined by the data store.

See Also:

Constant Field Values

QDR_WITHOUT_PAGE

static final int QDR_WITHOUT_PAGE

Get QDR: Do not include current page edge information, if the QDR is not for the page edge itself.

See Also:

Constant Field Values

QDR_WITH_PAGE

static final int QDR_WITH_PAGE

Get QDR: Include current page edge information, even if the QDR is not for the page edge itself.

See Also:

Constant Field Values

Method Detail

getValue

java.lang.Object getValue(int row,
                          int col,
                          java.lang.String type)
                          throws RowOutOfRangeException,
                                 ColumnOutOfRangeException

Retrieves a data value for the specified row and column intersection.

Parameters:

row - The row to retrieve.

col - The column to retrieve.

type - Type of data to retrieve, such as formatted or unformatted. Valid type values are defined in DataMap. Note: This call requires that the appropriate DataMap object is initialized with any types of data that the caller intends to use.

Returns:

The specified type of information for the specified row and column location.

Throws:

RowOutOfRangeException - If row is negative or too large.

ColumnOutOfRangeException - If column is negative or too large.

See Also:

DataMap

setValue

boolean setValue(java.lang.Object data,
                 int row,
                 int col,
                 java.lang.String type)
                 throws RowOutOfRangeException,
                        ColumnOutOfRangeException

Specifies a data value for the specified row and column intersection.

Parameters:

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 DataMap.

Returns:

truefalse if not.

Throws:

RowOutOfRangeException - If row is negative or too large.

ColumnOutOfRangeException - If column is negative or too large.

See Also:

DataMap

getSliceLabel

java.lang.Object getSliceLabel(int edge,
                               int slice,
                               java.lang.String type)
                               throws EdgeOutOfRangeException,
                                      SliceOutOfRangeException

Retrieves the label (or concatenated metadata) for the specified slice. The method of concatenation is usually each member label separated by a space or other character, but can be implementation dependent.

Parameters:

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. The caller should have initialized the appropriate MetadataMap with any type that is requested in this parameter. Otherwise, this call should return null.

Returns:

The label (or metadata) for the specified slice.

Throws:

EdgeOutOfRangeException - If the edge parameter is not in the valid range.

SliceOutOfRangeException - If the slice parameter is negative or too large.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getEdgeCurrentSlice

int getEdgeCurrentSlice(int edge)
                        throws EdgeOutOfRangeException

Retrieves the zero-based number of the slice that is defined by the implementor as the current slice. For the row and column edges, the view do not require support for the concept of a current slice. This concept is usually associated with a view paging control on the page edge.

Parameters:

edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.

Returns:

The slice (zero-based) that is defined as the current slice. Often the slice that represents the page that is currently displayed in a Crosstab when this method is called for the page edge. (On the page edge, the value of slice is one less than the actual page number, which is 1-based.)

Throws:

EdgeOutOfRangeException - If the edge parameter is not in the valid range.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getEdgeCurrentHPos

int[] getEdgeCurrentHPos(int edge)
                         throws EdgeOutOfRangeException

Retrieves, for the specified edge, the hierarchical address of the location that is defined by the implementor as the "current" location. The row and column edges of view do not require support for the concept of a current location. This concept is usually associated with a paging control on the page edge of a view.

Parameters:

edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.

Returns:

The hPos array that represents the current location on the specified edge. When this method is called for the page edge, the hPos that represents the page that is currently displayed in a Crosstab.

Throws:

EdgeOutOfRangeException - If the parameter edge is not valid.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getSliceMemberCount

int getSliceMemberCount(int edge,
                        int slice)
                        throws EdgeOutOfRangeException,
                               SliceOutOfRangeException

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. This method is useful in cases of asymmetry where the members on an edge do not all span the same layers.

Parameters:

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.

Returns:

The total number of unique logical layers for the specified slice and edge. This return value determines the range of valid values, on the specified edge and slice, for logical layer parameters in other API calls: the valid range is from zero to this return value minus one. The return value for this method will be less than or equal to the number returned by the getLayerCount method for the same edge.

Throws:

EdgeOutOfRangeException - If the edge parameter is not valid.

SliceOutOfRangeException - If the slice parameter is negative or too large.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberLogicalLayer

int getMemberLogicalLayer(int edge,
                          int layer,
                          int slice)
                          throws EdgeOutOfRangeException,
                                 LayerOutOfRangeException,
                                 SliceOutOfRangeException

Retrieves the logical layer to which the member at the specified edge, physical layer, and slice location belongs. If a particular member spans more than one physical layer at the specified slice, then passing in any of the spanned physical layer positions for the 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.

Parameters:

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 number 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.

Returns:

The logical layer of the member within the specified edge.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberSiblingCount

int getMemberSiblingCount(int edge,
                          int[] hPos,
                          int memberLayer)
                          throws EdgeOutOfRangeException,
                                 LayerOutOfRangeException,
                                 SliceOutOfRangeException

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. This method is useful in populating a page control for a view. For an example, consider the following column header.

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. 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.

Parameters:

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.

Returns:

The number of sibling members that are found on the specified edge at the location that is specified by hPos and memberLayer. In the example, this method returns 3 (for the siblings NY, Boston, and LA).

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If memberLayer is too large.

SliceOutOfRangeException - If any slice in hPos is too large.

See Also:

getMemberMetadata(int, int[], int, int, java.lang.String), DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberMetadata

java.lang.Object getMemberMetadata(int edge,
                                   int[] hPos,
                                   int memberLayer,
                                   int hIndex,
                                   java.lang.String type)
                                   throws EdgeOutOfRangeException,
                                          LayerOutOfRangeException,
                                          SliceOutOfRangeException

Retrieves the specified type of metadata for the member at a specified location. For example, this method is useful for retrieving labels for display in views.

The user of this method makes the following calls:

• Calls getMemberSiblingCount to retrieve the number of sibling members for a specified tree of members.
• Calls this method once for each sibling member to retrieve the specified metadata for that member.

The call for this method uses the same 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).

Parameters:

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.

Returns:

The requested metadata for the member at the specified location.

Throws:

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.

See Also:

MetadataMap, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberHPos

int[] getMemberHPos(int edge,
                    int layer,
                    int slice)
                    throws EdgeOutOfRangeException,
                           LayerOutOfRangeException,
                           SliceOutOfRangeException

Retrieves the hierarchical address for an absolute address that is specified as edge, physical layer, and slice. This method constructs an array that can be used in creating the 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.

Parameters:

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.

Returns:

An array of relative indexes. There is one index for each layer in the edge up to and including the layer argument, with -1 representing non-starting layers when a member happens to span more than one layer.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If memberLayer is too large.

SliceOutOfRangeException - If any slice in hPos is too large

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getFirstHPos

int[] getFirstHPos(int edge)
                   throws EdgeOutOfRangeException

Retrieves the hPos array that identifies the members at each physical layer of slice 0 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.

Parameters:

edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.

Returns:

An hPos array that fully identifies the first slice on the specified edge.

Throws:

EdgeOutOfRangeException - If edge is too large.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getLastHPos

int[] getLastHPos(int edge)
                  throws EdgeOutOfRangeException

Retrieves the hPos array that identifies the members at each physical layer in the last slice 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.

Parameters:

edge - A constant that represents the edge of interest. The constants end with _EDGE in DataDirector.

Returns:

An hPos array that fully identifies the last slice on the specified edge.

Throws:

EdgeOutOfRangeException - If edge is too large.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getPrevHPos

int[] getPrevHPos(int edge,
                  int[] hPos)
                  throws EdgeOutOfRangeException,
                         LayerOutOfRangeException,
                         SliceOutOfRangeException

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. 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.

Parameters:

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.

Returns:

An hPos array that fully identifies the previous slice on the edge. Returns null if the hPos parameter represents the first slice on the edge.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If hPos is too long.

SliceOutOfRangeException - If any slice in hPos is too large

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getNextHPos

int[] getNextHPos(int edge,
                  int[] hPos)
                  throws EdgeOutOfRangeException,
                         LayerOutOfRangeException,
                         SliceOutOfRangeException

Retrieves the hPos that identifies the next member on the specified edge relative to a specified 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.

Parameters:

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.

Returns:

An hPos array that fully identifies the next slice on the specified edge. Returns null if the specified hPos is the last one on the edge.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If hPos is too long.

SliceOutOfRangeException - If any slice in hPos is too large

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getSlicesFromQDR

int[] getSlicesFromQDR(QDRInterface qdr,
                       int[] startSlices,
                       int[] endSlices)

Returns an array of absolute slice positions in an edge-orderered array (column edge 0, row edge 1, etc.), given a QDR specifying a position in the current cursor. If a cell position corresponding to the QDR cannot be found, -1 values for the edge slices are returned. If this method has not been implemented, null is returned.

Parameters:

qdr - 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.

Returns:

the location of the given QDR as an array of absolute slice positions, ordered by edge. If there is no edge in a particular set of data, the slice value will be -1 in that array position. If the QDR cannot be located or cannot be located within the given viewport if specified, -1 values will be returned. If the method is not implemented, null is returned.

findMember

int findMember(int edge,
               int[] hPos,
               int memberLayer,
               java.lang.String s,
               java.lang.String type,
               int flags)
               throws EdgeOutOfRangeException,
                      LayerOutOfRangeException,
                      SliceOutOfRangeException

Searches a set of child members for the specified value starting at a specified offset. The child members are addressed as in getMemberChildCount. Returns the relative index in the specified hierarchical location for the member where the search value is found.

Parameters:

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 using constants, some constants that affect case sensitivity may be ANDed with the actual type of the search. The valid constants begin with FIND_ in this class.

Returns:

The relative index of the member in which the search value was found. Returns -1 if the String is not found.

Throws:

EdgeOutOfRangeException - If edge is invalid.

LayerOutOfRangeException - If memberlayer is invalid for the edge.

SliceOutOfRangeException - If hPos that are not valid relative indexes 0.

See Also:

FIND_EXACT, FIND_CONTAINS, FIND_STARTS_WITH, FIND_ENDS_WITH, FIND_CASE_INSENSITIVE, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

isFetched

boolean isFetched(int[] startSlice,
                  int[] endSlice,
                  int flag)
                  throws SliceOutOfRangeException

Indicates whether a block of data has been fully computed or processed locally. The block of data is specified as matched pairs of start and end slice locations organized in array parameters by edge.

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.

Parameters:

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.

flag - A DataDirector3 flag indicating the type of block the caller is interested in (spans, relative indent, etc.)

Returns:

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.

Throws:

SliceOutOfRangeException - If any of the slices are invalid.

See Also:

DataDirector3

forceFetch

boolean forceFetch(int[] startSlice,
                   int[] endSlice,
                   int flag)
                   throws SliceOutOfRangeException

Ensures that a block of data has been fetched or computed locally. If this call is successful, then the caller can expect that isFetched will return true.

Implementors are not required to support this method.

Parameters:

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.

flag - A bitwise DataDirector3 flag indicating the type of blocks the caller is interested in (spans, relative indent, etc.)

Returns:

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..

Throws:

SliceOutOfRangeException - If the startSlice parameter is invalid

See Also:

DataDirector3

isMemberExtentComplete

boolean isMemberExtentComplete(int edge,
                               int layer,
                               int slice)
                               throws EdgeOutOfRangeException,
                                      LayerOutOfRangeException,
                                      SliceOutOfRangeException

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. Views use this method to determine whether the width of a member in a column header or the height of a member in a row header when not in outline form will increase further, in order for views to support dynamic span information from implementations.

Parameters:

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 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.

Returns:

true if the extent of the specified member has been fully computed, false if not.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

See Also:

CDFDataAccess.getMemberStartSlice(int, int, int), CDFDataAccess.getMemberExtent(int, int, int), DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

release

void release()

Informs the implementor that the caller no longer needs this 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.

startGroupEdit

void startGroupEdit()

Indicates the start of a group of 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.

See Also:

setValue(java.lang.Object, int, int, java.lang.String), endGroupEdit()

endGroupEdit

void endGroupEdit()

Indicates the end of a group of setValue calls. This group of setValue calls will be treated as a unit in terms of undo and redo actions.

See Also:

setValue(java.lang.Object, int, int, java.lang.String), startGroupEdit()

undoEdit

boolean undoEdit()

Performs an undo of the latest setValue operation.

Returns:

true if the undo was successful; false if the undo was not successful.

redoEdit

boolean redoEdit()

Performs a redo of the latest undo action.

Returns:

true if the redo was successful; false if the redo was not successful.

submitChanges

boolean submitChanges()

Writes the current group of QDR overrides in the writeback collection to the database and flushes the entries in the writeback collection.

Returns:

true if changes are submitted successfully; false if changes are not submitted successfully.

dropChanges

boolean dropChanges()

Clears the QDR overrides in the writeback collection.

Returns:

true if the clear operation was successful; false if the clear operation was not successful.

setAutoSubmit

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.

Parameters:

bValue - true specifies automatic submission; false specifies no automatic submission.

isAutoSubmit

boolean isAutoSubmit()

Indicates whether automatic submission is set for cell editing.

Returns:

true specifies that automatic submission is set for cell editing; false specifies that automatic submission is not set for cell editing.

getQDRoverrideCollection

java.util.Vector getQDRoverrideCollection()

Retrieves a read-only copy of the QDR overrides in the writeback collection.

Returns:

The read-only copy of the QDR overrides in the writeback collection.

getValueQDR

QDR getValueQDR(int row,
                int column,
                int flags)
                throws RowOutOfRangeException,
                       ColumnOutOfRangeException

Retrieves a QDR object that represents the value at the specified row and column in the data area of the cursor.

Parameters:

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.

Returns:

QDR object that refers to the data at the specified location.

Throws:

RowOutOfRangeException - If the row parameter is not valid.

ColumnOutOfRangeException - If the column parameter is not valid.

See Also:

QDR_WITH_PAGE, QDR_WITHOUT_PAGE

getSliceQDR

QDR getSliceQDR(int edge,
                int slice,
                int flags)
                throws EdgeOutOfRangeException,
                       SliceOutOfRangeException

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).

Parameters:

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.

Returns:

QDR object that refers to the data at the specified location.

Throws:

EdgeOutOfRangeException - If the edge parameter is not valid.

SliceOutOfRangeException - If the slice parameter is not valid.

See Also:

QDR_WITH_PAGE, QDR_WITHOUT_PAGE, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberQDR

QDR getMemberQDR(int edge,
                 int layer,
                 int slice,
                 int flags)
                 throws EdgeOutOfRangeException,
                        LayerOutOfRangeException,
                        SliceOutOfRangeException

Retrieves a QDR object that represents the data value for the member at the specified edge, layer, and slice.

Parameters:

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.

Returns:

QDR object that refers to the data at the specified position.

Throws:

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.

See Also:

QDR_WITH_PAGE, QDR_WITHOUT_PAGE, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberQDR

QDR getMemberQDR(int edge,
                 int[] hPos,
                 int memberLayer,
                 int flags)
                 throws EdgeOutOfRangeException,
                        LayerOutOfRangeException,
                        SliceOutOfRangeException

Retrieves a QDR object that represents the specified member using hierarchical addressing.

Parameters:

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.

Returns:

QDR object that refers to the data at the specified hpos and memberlayer within the hpos.

Throws:

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.

See Also:

QDR_WITH_PAGE, QDR_WITHOUT_PAGE, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getLayerQDR

QDR getLayerQDR(int edge,
                int layer,
                int flags)
                throws EdgeOutOfRangeException,
                       LayerOutOfRangeException

Retrieves the QDR object that represents the specified logical layer.

Parameters:

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.

Returns:

QDR object that refers to the data in the specified layer.

Throws:

EdgeOutOfRangeException - If edge is not valid.

LayerOutOfRangeException - If the logical layer is not valid for the specified edge.

See Also:

QDR_WITH_PAGE, QDR_WITHOUT_PAGE, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getSliceOutlineLayer

int getSliceOutlineLayer(int edge,
                         int slice)
                         throws EdgeOutOfRangeException,
                                SliceOutOfRangeException

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. Because, in outline mode, the getSliceMemberCount method always returns the value 1, the Crosstab uses getSliceOutlineLayer to determine the logical layer.

Parameters:

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.

Returns:

The logical layer of the specified slice in the specified edge for outline mode only.

Throws:

EdgeOutOfRangeException - If the edge parameter is not valid.

SliceOutOfRangeException - If the slice parameter is not valid for the specified edge.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getUniqueMemberMetadata

java.util.List getUniqueMemberMetadata(int edge,
                                       int layer,
                                       java.lang.String[] types,
                                       int start,
                                       int count)
                                       throws EdgeOutOfRangeException,
                                              LayerOutOfRangeException,
                                              SliceOutOfRangeException

Returns an unordered List 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.

Parameters:

edge - The edge containing the layer for which to build the member list

layer - The zero-based index of the physical layer for which to build the member list

types - An array of MetadataMap types indicating the nature of the returned metadata in the List elements

start - 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.

Returns:

a List of Object arrays, with each element of the List representing one unique member for the given edge and layer. Each element of the Object array has a one-to-one correspondence to the metadata specified in the types parameter. Returns null if not implemented. Returns an empty List if there are no values

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If a problem with counting the members occurs

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, MetadataMap

getUniqueMemberMetadata

java.util.List getUniqueMemberMetadata(java.lang.String layerName,
                                       java.lang.String[] types,
                                       int start,
                                       int count)
                                       throws LayerOutOfRangeException,
                                              SliceOutOfRangeException

Returns an unordered List 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.

Parameters:

layerName - 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 List elements

start - 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.

Returns:

a List of Object arrays, with each element of the List representing one unique member for * the given layerName. Each element of the Object array has a one-to-one correspondence to the metadata specified in the types parameter. Returns null if not implemented. Returns an empty List if there are no values

Throws:

LayerOutOfRangeException - If the layerName is not found at any edge or layer in the DataAccess.

SliceOutOfRangeException - If a problem with counting the members occurs

See Also:

MetadataMap

getCorrespondingMemberMetadata

java.util.List getCorrespondingMemberMetadata(int edge,
                                              int layer,
                                              java.lang.String[] values,
                                              java.lang.String[] types,
                                              boolean inDataAccess)
                                              throws EdgeOutOfRangeException,
                                                     LayerOutOfRangeException

Returns a List 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.

Parameters:

edge - 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 List elements

inDataAccess - Assumed to be true at this time. Only return corresponding Metadata for member values found in DataAccess. The returned List will contain a null element for member values that are not found at all.

Returns:

A List of Object arrays containing corresponding metadata information for the given list of member values. The size of the List will match the size of the values parameter, but may contain null elements if a particular member or members were not found. Returns null if not implemented. Returns an empty List if there are no values

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE, MetadataMap

getCorrespondingMemberMetadata

java.util.List getCorrespondingMemberMetadata(java.lang.String layerName,
                                              java.lang.String[] values,
                                              java.lang.String[] types,
                                              boolean inDataAccess)
                                              throws LayerOutOfRangeException

Returns a List 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.

Parameters:

layerName - The name of the layer at which to fi nd 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 List elements

inDataAccess - Assumed to be true at this time. Only return corresponding Metadata for member values found in DataAccess. The returned List will contain a null element for member values that are not found at all.

Returns:

A List of Object arrays containing corresponding metadata information for the given list of member values. The size of the List will match the size of the values parameter, but may contain null elements if a particular member or members were not found. Returns null if not implemented. Returns an empty List if there are no values

Throws:

LayerOutOfRangeException - If the layerName is not found at any edge and layer in the DataAccess.

See Also:

MetadataMap

allSlicesFetched

boolean allSlicesFetched(int edge)
                         throws EdgeOutOfRangeException

Returns true if all slices on 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

Parameters:

edge - The edge for which to determine if all slices have been fetched

Returns:

true if all slices have been fetched

Throws:

EdgeOutOfRangeException - If edge is invalid