oracle.dss.dataSource.common
Class QueryDataAccess

java.lang.Object
  |
  +--oracle.dss.dataSource.common.QueryDataAccess

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CubeQueryDataAccess, RelationalQueryDataAccess

public class QueryDataAccess

extends java.lang.Object

implements java.io.Serializable

  QueryDataAccess
      DataView's DataAccess interface.

See Also:

Serialized Form

Method Summary

boolean	dropChanges()
void	endGroupEdit()
int	findMember(int edge, int[] hPos, int memberLayer, java.lang.String s, java.lang.String type, int flags) Finds the location of a given string.
boolean	forceFetch(int[] startSlice, int[] endSlice) Ensures that a range of data has been fetched to the client for display, if possible.
boolean	forceFetch(long rowmin, long rowmax, long colmin, long colmax) Make sure the data (and metadata corresponding) for the given range has been fetched locally, if possible
int	getEdgeCount() Return the total number of edges in the data source.
int[]	getEdgeCurrentHPos(int edge) Retrieves the currently set position the given edge in relative hierarchical terms.
int	getEdgeCurrentSlice(int edge) Retrieves the number of the current slice.
int	getEdgeExtent(int edge) Retrieves the total number of members on the given edge.
int[]	getFirstHPos(int edge) Retrieves the hPos identifying the first member on the given edge.
int[]	getLastHPos(int edge) Retrieves the hPos identifying the last member on the given edge.
int	getLayerCount(int edge) Retrieves the number of layers on the specified edge.
java.lang.Object	getLayerMetadata(int edge, int layer, java.lang.String type) Retrieves a piece of metadata for a layer.
QDR	getLayerQDR(int edge, int layer, int flags) Retrieves the QDR object that represents the specified logical layer.
int	getMemberDepth(int edge, int layer, int slice) Retrieves the number of layers that a member spans at the specified location on the specified edge.
int	getMemberExtent(int edge, int depth, int slice) Retrieves the number of slices that a member spans.
int[]	getMemberHPos(int edge, int layer, int slice) Retrieves an array of indexes from a page number.
int	getMemberLogicalLayer(int edge, int layer, int slice) Return the logical layer that the member at the given edge, physical layer, and slice location is associated with.
java.lang.Object	getMemberMetadata(int edge, int[] hPos, int memberLayer, int hIndex, java.lang.String type) Retrieves specified metadata for a member at a specified location.
java.lang.Object	getMemberMetadata(int edge, int layer, int slice, java.lang.String type) Retrieves a piece of metadata for a dimension member.
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 number of members at a particular layer and location.
int	getMemberStartLayer(int edge, int layer, int slice) Retrieves the starting slice of a member that spans a number of layers on the specified edge.
int	getMemberStartSlice(int edge, int layer, int slice) Retrieves the first slice that a member spans.
int[]	getNextHPos(int edge, int[] hPos) Retrieves the hPos identifying the next member on the given edge relative to a given hPos.
int[]	getPrevHPos(int edge, int[] hPos) Retrieves the hPos identifying the previous member on the given edge relative to a given hPos.
java.util.Vector	getQDRoverrideCollection()
java.lang.Object	getSliceLabel(int edge, int slice, java.lang.String type) Retrieves the label for the specified column.
int	getSliceMemberCount(int edge, int slice) Retrieves the number of logical layers at the specified location on the specified edge.
int	getSliceOutlineLayer(int edge, int slice) Retrieves the "starting" layer of a specified slice for outline form.
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).
java.lang.Object	getValue(int row, int col, java.lang.String type) Return a data value for the given 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()
boolean	isFetched(int[] startSlice, int[] endSlice) Indicates whether a range of data has been fetched to the client for display.
boolean	isFetched(long rowmin, long rowmax, long colmin, long colmax) Determine if the given range of data (and of corresponding metadata) has been fetched locally.
boolean	redoEdit()
void	release() Inform the holder of the data and metadata that the caller no longer needs this data.
void	setAutoSubmit(boolean bValue)
boolean	setValue(java.lang.Object data, int row, int col, java.lang.String type)
void	startGroupEdit()
boolean	submitChanges()
boolean	undoEdit()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getEdgeExtent

public int getEdgeExtent(int edge)
                  throws EdgeOutOfRangeException

Retrieves the total number of members on the given edge. cursor.

Parameters:

edge - Edge of interest.

Returns:

The total number of members on the given edge.

getEdgeCount

public int getEdgeCount()

Return the total number of edges in the data source. Note: the views will consider all edges beyond 0 and 1 (column/ row) to be page edges, and some of the methods retrieving page counts, etc., may involve view calculations from more basic data source information. The views assume that the data source will ascribe column/row meaning to the first two edges on any query.

Returns:

the total number of pages of data to display

getValue

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

Return a data value for the given row and column intersection.

Parameters:

row - the row to get

col - the column to get

type - type specification defined by DataMap to indicate type to get

Returns:

value of the given type for the given row and column location.

Throws:

RowOutOfRangeException - thrown if row is too large

ColumnOutOfRangeException - thrown if column is too large

getSliceLabel

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

Retrieves the label for the specified column.

Parameters:

edge - Edge of interest.

slice - The slice whose label is desired.

type - A constant that specifies the kind of metadata that you want. Valid type values are defined in the MetadataMap.

Returns:

The label (or metadata) for the location on the specified edge.

Throws:

EdgeOutOfRangeException - If edge is out of range.

SliceOutOfRangeException - If slice is negative or too large.

getEdgeCurrentSlice

public int getEdgeCurrentSlice(int edge)
                        throws EdgeOutOfRangeException

Retrieves the number of the current slice. The number that this method returns is not the regular index of the page dimension. Instead, page numbers begin at 1 and are incremented as in the following example:

Suppose that you have a Time dimension and a City dimension on the page edge. Suppose the City dimension has three members. The first five pages are as follows:

• 0. Time member 0; City member 0
• 1. Time member 0; City member 1
• 2. Time member 0; City member 2
• 3. Time member 1; City member 0
• 4. Time member 1; City member 1

Returns:

The current slice of the edge.

getEdgeCurrentHPos

public int[] getEdgeCurrentHPos(int edge)
                         throws EdgeOutOfRangeException

Retrieves the currently set position the given edge in relative hierarchical terms.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

Returns:

hPos representing the current location on the edge

Throws:

EdgeOutOfRangeException - If edge is out of range.

getLayerCount

public int getLayerCount(int edge)
                  throws EdgeOutOfRangeException

Retrieves the number of layers on the specified edge.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

Returns:

The number of layers on the specified edge.

Throws:

EdgeOutOfRangeException - If edge is out of range.

getSliceMemberCount

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

Retrieves the number of logical layers at the specified location on the specified edge. This method is useful in cases of asymmetry where the dimensions on an edge do not all span the same layers.

Parameters:

edge - A constant that represents the edge of interest. Constants are defined in the DataDirector implementation.

slice - The slice that identifies a location along the edge of interest. The slice is zero-based. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer layer spans can be used.

Returns:

The number of logical layers at the specified location on the specified edge.

Throws:

EdgeOutOfRangeException - If edge is out of range.

SliceOutOfRangeException - If slice is negative or too large.

getMemberDepth

public int getMemberDepth(int edge,
                          int layer,
                          int slice)
                   throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException

Retrieves the number of layers that a member spans at the specified location on the specified edge. On the column edge, this is the number of heading rows that the specified member spans. On the row edge, this is the number of heading columns that the specified member spans.

This method is useful only in cases of asymmetry where the members on an edge do not all span one layer and have a depth of 1. Normally, all members have a member depth of 1.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

layer - The starting layer of the member, as returned by getMemberStartLayer.

slice - The location along the edge. 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.

Returns:

The number of layers that the specified member spans.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

getMemberStartLayer

public int getMemberStartLayer(int edge,
                               int layer,
                               int slice)
                        throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException

Retrieves the starting slice of a member that spans a number of layers on the specified edge.

This method is useful only in cases of asymmetry where the members on an edge do not all span one layer. Normally, all members have a member start layer equal to their layer.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

layer - The layer of the dimension

slice - The location along the edge. The slice is zero-based. Each dimension member in the innermost dimension has a unique slice. In outer layers, any slice that the outer member spans can be used.

Returns:

The layer at which the specified member starts its layer span.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

getMemberLogicalLayer

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

Return the logical layer that the member at the given edge, physical layer, and slice location is associated with. This can be used as input to getLayerMetadata.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

layer - The layer of the member

slice - The location along the edge. The slice is zero-based. Each member in the innermost dimension has a unique slice. In outer layers, any slice that the outer member spans can be used.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

getLayerMetadata

public java.lang.Object getLayerMetadata(int edge,
                                         int layer,
                                         java.lang.String type)
                                  throws EdgeOutOfRangeException,
LayerOutOfRangeException

Retrieves a piece of metadata for a layer.

Parameters:

edge - The edge of interest. The constants are defined in the DataDirector implementation.

dimension - The layer for which you want metadata. Uses a depth computation to identify the location of the layer or layer member; 0 is the outer-most layer on the edge.

type - A constant that specifies the kind of metadata that you want. Valid type values are defined in the LayerMetadataMap.

Returns:

The requested metadata.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

getMemberExtent

public int getMemberExtent(int edge,
                           int depth,
                           int slice)
                    throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException

Retrieves the number of slices that a member spans. Views use this method to determine the width of a member in a column header or the height of a member in a row header when not in outline form.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

layer - The layer of the dimension of interest. Valid values are zero to total layer at the specified slice.

slice - The location along the edge. 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.

Returns:

The number of slices that the member spans at the specified location.

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:

getMemberStartSlice(int, int, int)

getMemberStartSlice

public int getMemberStartSlice(int edge,
                               int layer,
                               int slice)
                        throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException

Retrieves the first slice that a member spans. Views use this method to determine where to start painting a member label in a row or column header. Views pass the same parameter values to this method and to getMemberExtent.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

layer - The layer of the dimension of interest. Valid values are zero to total layer at the specified slice.

slice - The location along the edge. 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.

Returns:

The starting slice value for the count that getMemberExtent returns.

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:

getMemberExtent(int, int, int)

getMemberMetadata

public java.lang.Object getMemberMetadata(int edge,
                                          int layer,
                                          int slice,
                                          java.lang.String type)
                                   throws EdgeOutOfRangeException,
LayerOutOfRangeException,
SliceOutOfRangeException

Retrieves a piece of metadata for a dimension member.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

layer - The layer of the member of interest. Valid values are zero to total layers at the specified slice.

slice - The location along the edge. 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.

type - A constant that specifies the kind of metadata that you want. Valid type values are defined in the MetadataMap.

Returns:

The requested metadata.

Throws:

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

getValueQDR

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

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.

getSliceQDR

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

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:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberQDR

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

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:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberQDR

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

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:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getLayerQDR

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

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:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberSiblingCount

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

Retrieves the number of members at a particular layer and location. For example, take the following column header:

June							July
Tents			Canoes				Tents			Canoes
NY	Boston	LA	Toronto	Winnepeg	NY	LA	NY	Boston	LA	Toronto	Winnepeg

Views would call this method to find the number of Geography values under Canoes for June. This method provides the upper limit to the hIndex that the views pass in getMemberMetadata.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

hPos - An array that contains an index for the parent values at each layer above the layer of the dimension of interest. These indexes are relative to the number of members for that parent at that layer. For the example above, hPos would be {0,1}. At depth 0 (Month), June is index 0; at depth 1 (Product), Canoes is index 1. When a member spans more than one layer, any layers beyond the starting layer should have their place held by a -1 index.

memberLayer - Indicates the layer of interest

Returns:

The number of values. In the example, this method would return 4.

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, java.lang.String)

getMemberMetadata

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

Retrieves specified metadata for a member at a specified location. Views call this method to retrieve labels to display. Views first call getMemberSiblingCount to find the number of members. Then they call this method to retrieve the metadata for each member.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

hPos - An array that contains an index for the parent values at each layer above the layer of interest. Views pass the same hPos that was passed for getMemberSiblingCount.

memberLayer - Indicates the layer of interest

hIndex - The index of the member whose metadata the view wants. Valid values are 0 to (getMemberSiblingCount() - 1).

type - A constant that specifies the kind of metadata that you want. Valid type values are defined in the MetatdataMap.

Returns:

The requested metadata.

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.

getMemberHPos

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

Retrieves an array of indexes from a page number. This method constructs an array that can be used to construct the hPos parameter in calls to getMemberSiblingCount and getMemberMetadata.

The array of indexes that this method returns has an index for each layer in the page edge. For example, imagine pivoting the following column header to the page edge.

June							July
Tents			Canoes				Tents			Canoes
NY	Boston	LA	Toronto	Winnepeg	NY	LA	NY	Boston	LA	Toronto	Winnepeg

If the current page were page 5 (June, Canoes, Winnepeg), this method would return the array {0, 1}. June is at index 0 in the dimension at depth 0. Canoes is at index 1 at depth 1 under June. To find the number of dimension members under Canoes under June, you would call getMemberSiblingCount with the array {0}.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

layer - The layer of the dimension of interest. Valid values are zero to total layer at the specified slice.

slice - The location along the edge. 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.

Returns:

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

getFirstHPos

public int[] getFirstHPos(int edge)
                   throws EdgeOutOfRangeException

Retrieves the hPos identifying the first member on the given edge.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

Returns:

hPos fully identifying the first slice on the edge

Throws:

EdgeOutOfRangeException - If edge is too large.

getLastHPos

public int[] getLastHPos(int edge)
                  throws EdgeOutOfRangeException

Retrieves the hPos identifying the last member on the given edge.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

Returns:

hPos fully identifying the last slice on the edge

Throws:

EdgeOutOfRangeException - If edge is too large.

getPrevHPos

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

Retrieves the hPos identifying the previous member on the given edge relative to a given hPos.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

hPos - Identifies the member for which this call should return the previous member on the edge

Returns:

hPos fully identifying the previous slice on the edge. If the given hPos is the first one, null is returned.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If hPos is too long.

SliceOutOfRangeException - If any slice in hPos is too large

getNextHPos

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

Retrieves the hPos identifying the next member on the given edge relative to a given hPos.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

hPos - Identifies the member for which this call should return the next member on the edge

Returns:

hPos fully identifying the next slice on the edge. If the given hPos is the last one, null is returned.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If hPos is too long.

SliceOutOfRangeException - If any slice in hPos is too large

findMember

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

Finds the location of a given string.

Parameters:

edge - A constant that represents the edge along which to search. The constants are defined in the DataDirector implementation.

hPos - The hierarchically specified set of values to search

memberLayer - the layer at which to search

s - The String to find.

type - A constant that indicates the type of metadata to search. Valid flags values are defined in the MetadataMap.

flags - type of search - not yet defined.

Returns:

The location of the string. If instatus is true, the return value is suitable to pass as the index parameter to other DataAccess methods that take edge, depth, and index parameters. Returns -1 if the String is not found.

Throws:

EdgeOutOfRangeException - if edge is invalid

LayerOutOfRangeException - If hPos has invalid layers

SliceOutOfRangeException - If hPos has invalid indexes

isFetched

public boolean isFetched(long rowmin,
                         long rowmax,
                         long colmin,
                         long colmax)

Determine if the given range of data (and of corresponding metadata) has been fetched locally.

Parameters:

rowmin - low end of row range

rowmax - high end of row range

colmin - low end of column range

colmax - high end of column range

Returns:

true if all the data is locally fetched. false if it is not all locally fetched, or this method is unimplemented.

forceFetch

public boolean forceFetch(long rowmin,
                          long rowmax,
                          long colmin,
                          long colmax)

Make sure the data (and metadata corresponding) for the given range has been fetched locally, if possible

Parameters:

rowmin - low end of row range

rowmax - high end of row range

colmin - low end of column range

colmax - high end of column range

Returns:

true if the data was successfully locally fetched. false if it could not be locally fetched, or if this method is unimplemented.

getSliceOutlineLayer

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

Retrieves the "starting" layer of a specified slice for outline form. In outline form, all layers have an actual depth of zero. This method returns a depth that views can use to determine the appropriate amount of indentation for outline form. When an edge is not in outline form, the returned value here is ignored.

Parameters:

edge - A constant that represents the edge of interest. The constants are defined in the DataDirector implementation.

slice - The location along the edge of interest. 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.

Returns:

The depth of this item for outline mode only. Valid values are zero to (getSliceMemberCount(edge, slice)-1).

Throws:

SliceOutOfRangeException - If slice is negative or too large.

isFetched

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

Indicates whether a range of data has been fetched to the client for display. If the data is fetched, its metadata is also fetched.

Parameters:

startSlice - start slices

endSlice - matching end slices

Returns:

true if all the data is fetched, false if it is not all fetched, or this method is not implemented.

Throws:

SliceOutOfRangeException - if any of the slices are invalid

forceFetch

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

Ensures that a range of data has been fetched to the client for display, if possible. Includes metadata.

Parameters:

startSlice - start slices

endSlice - matching end slices

Returns:

true if the data was successfully fetched. false if it could not be fetched, or if this method is not implemented.

Throws:

SliceOutOfRangeException - if any of the slices are invalid

release

public void release()

Inform the holder of the data and metadata that the caller no longer needs this data. The implementor may or may not implement this method, depending on the underlying cursor. Views in general will not release main data access implementations, in that they may be used by other views.

setValue

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

getQDRoverrideCollection

public java.util.Vector getQDRoverrideCollection()

startGroupEdit

public void startGroupEdit()

endGroupEdit

public void endGroupEdit()

redoEdit

public boolean redoEdit()

undoEdit

public boolean undoEdit()

submitChanges

public boolean submitChanges()

dropChanges

public boolean dropChanges()

setAutoSubmit

public void setAutoSubmit(boolean bValue)

isAutoSubmit

public boolean isAutoSubmit()