oracle.dss.dataSource.common
Class RelationalQueryDataAccess

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

All Implemented Interfaces:

DataAccess, RelationalDataAccess, java.io.Serializable

public class RelationalQueryDataAccess

extends QueryDataAccess

implements RelationalDataAccess

Specific Relational-based implementation of DataAccess.

See Also:

Serialized Form

Fields inherited from interface oracle.dss.util.DataAccess

FIND_CASE_INSENSITIVE, FIND_CONTAINS, FIND_ENDS_WITH, FIND_EXACT, FIND_PRIOR, FIND_STARTS_WITH, QDR_WITH_PAGE, QDR_WITHOUT_PAGE

Constructor Summary

RelationalQueryDataAccess(QueryDataAccess da, boolean ownChange)
Constructor that uses methods of the QueryDataAccess object to retrieve a CubeCursor object and to create a new RelationalQueryDataDirector object.

Method Summary

int	getEdgeCurrentSlice(int edge) Retrieves the number of the current slice.
int	getEdgeExtent(int edge) Retrieves the total number of slices that are available on the specified edge.
int	getLayerCount(int edge) Retrieves the number of layers on the specified edge.
java.lang.Object	getLayerMetadata(int edge, int dimension, java.lang.String type) Retrieves a piece of metadata for a dimension (also known as a layer) that is found at a specified edge.
QDR	getLayerQDR(int edge, int layer, int flags) Retrieves the QDR object that represents the specified logical layer.
int	getMemberDepth(int edge, int layer, int slice) Retrieves the size (expressed in layers that are perpendicular to the specified edge orientation) of a member at the specified layer, slice, and edge.
int	getMemberExtent(int edge, int layer, int slice) Retrieves the size of a member, that is, the number of slices that the member spans at a specified edge, layer, and slice location (parallel to the direction of the edge).
int[]	getMemberHPos(int edge, int layer, int slice) Retrieves the hierarchical address for an absolute address that is specified as edge, physical layer, and slice.
java.lang.Object	getMemberMetadata(int edge, int[] hPos, int memberLayer, int hIndex, java.lang.String type) Retrieves the specified type of metadata for the member at a specified location.
java.lang.Object	getMemberMetadata(int edge, int layer, int slice, java.lang.String type) Retrieves the specified type of metadata for a member at the specified location.
QDR	getMemberQDR(int edge, int[] hPos, int memberLayer, int flags) Retrieves a QDR object that represents the specified member using hierarchical addressing.
QDR	getMemberQDR(int edge, int layer, int slice, int flags) Retrieves a QDR object that represents the data value for the member at the specified edge, layer, and slice.
int	getMemberSiblingCount(int edge, int[] hPos, int memberLayer) Retrieves the count of all the sibling members at a specified logical layer based on a series of relative indexes for each logical layer down to the specified logical layer.
int	getMemberStartSlice(int edge, int layer, int slice) Retrieves the absolute number of the first slice that a member spans.
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 that identifies the previous member on the specified edge, relative to a specified hPos.
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.
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) 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.

Methods inherited from class oracle.dss.dataSource.common.QueryDataAccess

dropChanges, endGroupEdit, findMember, forceFetch, forceFetch, getEdgeCount, getEdgeCurrentHPos, getFirstHPos, getLastHPos, getMemberLogicalLayer, getMemberStartLayer, getQDRoverrideCollection, getSliceLabel, getSliceOutlineLayer, isAutoSubmit, isFetched, isFetched, redoEdit, release, setAutoSubmit, setValue, startGroupEdit, submitChanges, undoEdit

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.util.DataAccess

dropChanges, endGroupEdit, findMember, forceFetch, getEdgeCount, getEdgeCurrentHPos, getFirstHPos, getLastHPos, getMemberLogicalLayer, getMemberStartLayer, getQDRoverrideCollection, getSliceLabel, getSliceOutlineLayer, isAutoSubmit, isFetched, redoEdit, release, setAutoSubmit, setValue, startGroupEdit, submitChanges, undoEdit

Constructor Detail

RelationalQueryDataAccess

public RelationalQueryDataAccess(QueryDataAccess da,
                                 boolean ownChange)

Constructor that uses methods of the QueryDataAccess object to retrieve a CubeCursor object and to create a new RelationalQueryDataDirector object.

Method Detail

getEdgeExtent

public int getEdgeExtent(int edge)
                  throws EdgeOutOfRangeException

Retrieves the total number of slices that are available on the specified edge.

Specified by:

getEdgeExtent in interface DataAccess

Overrides:

getEdgeExtent in class QueryDataAccess

Parameters:

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

Returns:

The total number of slices that are available on the specified edge. This number determines the range of valid slice values for the specified edge in other API calls: the valid range is from zero to this return value minus one.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getLayerCount

public int getLayerCount(int edge)
                  throws EdgeOutOfRangeException

Retrieves the number of layers on the specified edge.

Specified by:

getLayerCount in interface DataAccess

Overrides:

getLayerCount in class QueryDataAccess

Parameters:

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

Returns:

The number of layers on the specified edge. This number determines the range of valid values on the specified edge for the layer parameter in other API calls: the valid range is from zero to this return value minus one.

Throws:

EdgeOutOfRangeException - If edge is out of range.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberHPos

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

Specified by:

getMemberHPos in interface DataAccess

Overrides:

getMemberHPos in class QueryDataAccess

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

getNextHPos

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

Specified by:

getNextHPos in interface DataAccess

Overrides:

getNextHPos in class QueryDataAccess

Parameters:

edge - A constant that represents the edge of interest. The constants are listed in the See Also section.

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

Returns:

The hPos that fully identifies the next slice on the ' edge. If the given hPos is the last one, then this method returns null.

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.ROW_EDGE, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE

getPrevHPos

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

Retrieves the hPos that identifies the previous member on the specified edge, relative to a specified hPos.

Specified by:

getPrevHPos in interface DataAccess

Overrides:

getPrevHPos in class QueryDataAccess

Parameters:

edge - A constant that represents the edge of interest. The constants are listed in the See Also section.

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

Returns:

The hPos that fully identifies the previous slice on the edge. If the given hPos is the first one, then this method returns null.

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.ROW_EDGE, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE

getMemberSiblingCount

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

Specified by:

getMemberSiblingCount in interface DataAccess

Overrides:

getMemberSiblingCount in class QueryDataAccess

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

getMemberExtent

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

Retrieves the size of a member, that is, the number of slices that the member spans at a specified edge, layer, and slice location (parallel to the direction of the edge). 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.

The sum of all the unique getMemberExtent values for an edge should not exceed the getEdgeExtent value for the same edge.

Specified by:

getMemberExtent in interface DataAccess

Overrides:

getMemberExtent in class QueryDataAccess

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 whose size will be returned. Valid values are zero to total layers at the specified slice.

slice - An absolute index (zero-based) that indicates the location along the edge of the member whose extent will be returned. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.

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), DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberDepth

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

Retrieves the size (expressed in layers that are perpendicular to the specified edge orientation) of a member at the specified layer, slice, and edge. In other words, this method returns the following information depending upon the specified edge:

• Returns the "height" of a member in the Crosstab's column edge header, that is, the number of heading rows for the member.
• Returns the "width" of a member in the Crosstab's row edge header, that is the number of heading columns for the member.

The sum of all the members' values for this method, within a specified slice, should not exceed the value that getLayerCount returns for the specified edge.

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

Specified by:

getMemberDepth in interface DataAccess

Overrides:

getMemberDepth in class QueryDataAccess

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 starting physical layer in which to look for the slice, as returned by getMemberStartLayer.

slice - An absolute index (zero-based) that indicates the location of a slice along the specified edge. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.

Returns:

The depth (that is, the number of physical layers) that the specified member covers.

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

getMemberMetadata

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

Specified by:

getMemberMetadata in interface DataAccess

Overrides:

getMemberMetadata in class QueryDataAccess

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:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getValue

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

Specified by:

getValue in interface DataAccess

Overrides:

getValue in class QueryDataAccess

Parameters:

row - The row to retrieve.

col - The column to retrieve.

type - Type of data to return, such as formatted or unformatted. Valid type values are defined in the DataMap.

Returns:

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

Throws:

RowOutOfRangeException - If row is too large.

ColumnOutOfRangeException - If column is 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

Specified by:

getEdgeCurrentSlice in interface DataAccess

Overrides:

getEdgeCurrentSlice in class QueryDataAccess

Parameters:

edge - A constant that represents the edge whose current slice you want. Valid constants are listed in the See Also section.

Returns:

The current slice of the edge.

Throws:

EdgeOutOfRangeException - if edge is not valid.

See Also:

DataDirector.ROW_EDGE, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE

getSliceMemberCount

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

Specified by:

getSliceMemberCount in interface DataAccess

Overrides:

getSliceMemberCount in class QueryDataAccess

Parameters:

edge - A constant that represents the edge of interest. The constants end with _EDGE in util.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

getLayerMetadata

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

Retrieves a piece of metadata for a dimension (also known as a layer) that is found at a specified edge.

Specified by:

getLayerMetadata in interface DataAccess

Overrides:

getLayerMetadata in class QueryDataAccess

Parameters:

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

dimension - The zero-based dimension on the specified edge.

type - A constant that specifies the kind of metadata that should be retrieved. The caller should have intialized the appropriate LayerMetadataMap object with any types of metadata that will be used.

Returns:

The requested metadata value.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If dimension is negative or too large.

See Also:

LayerMetadataMap, DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberMetadata

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

Retrieves the specified type of metadata for a member at the specified location.

Specified by:

getMemberMetadata in interface DataAccess

Overrides:

getMemberMetadata in class QueryDataAccess

Parameters:

edge - A constant that represents the edge in which to look for the member metadata. The constants end with _EDGE in DataDirector.

layer - The zero-based index of the physical layer in which to find the slice. Valid values are zero to total layers at the specified slice.

slice - An absolute index (zero-based) that indicates the location along the edge of a slice that belongs to the member for which metadata is requested. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.

type - A constant that specifies the kind of metadata requested. Valid type values are defined in MetadataMap. The caller should have intialized the appropriate MetadataMap object with any types of metadata that will be used.

Returns:

The requested metadata.

Throws:

LayerOutOfRangeException - If layer is negative or too large.

SlieOutOfRangeException - If slice is negative or too large.

See Also:

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

getMemberStartSlice

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

Retrieves the absolute number of the first slice that a member spans. Presentation beans use this method to determine where to start painting a member label in a row or column header.

Specified by:

getMemberStartSlice in interface DataAccess

Overrides:

getMemberStartSlice in class QueryDataAccess

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 whose first slice will be returned. Valid values are zero to total layers at the specified slice.

slice - An absolute index (zero-based) that indicates the location along the specified edge of the member whose starting slice will be returned. Each member in the innermost layer has a unique slice. In outer layers, any slice that the outer member spans can be used.

Returns:

The absolute index of the first slice that the 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.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

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.

Specified by:

getValueQDR in interface DataAccess

Overrides:

getValueQDR in class QueryDataAccess

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 indicates whether to include page edge information in the QDR. 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:

DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

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

Specified by:

getSliceQDR in interface DataAccess

Overrides:

getSliceQDR in class QueryDataAccess

Parameters:

edge - A constant that represents the edge in which to find the slice. Valid constants end with _EDGE and are listed in the See Also section.

slice - An absolute index (zero-based) that indicates the location of the slice along the specified edge.

flags - A constant that indicates whether to include page edge information in the QDR, if edge is not DataDirector.PAGE_EDGE. Valid constants are listed in the See Also section, and they start with QDR_.

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, DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

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.

Specified by:

getMemberQDR in interface DataAccess

Overrides:

getMemberQDR in class QueryDataAccess

Parameters:

edge - A constant that represents the edge in which to find the member. The constants end with _EDGE and are listed in the See Also section.

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 indicates whether to include page edge information in the QDR, if edge is not DataDirector.PAGE_EDGE. Valid constants are listed in the See Also section, and they start with QDR_.

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, DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

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.

Specified by:

getMemberQDR in interface DataAccess

Overrides:

getMemberQDR in class QueryDataAccess

Parameters:

edge - A constant that represents the edge of interest. The constants end with _EDGE and are listed in the See Also section.

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 indicates whether to include page edge information in the QDR, if edge is not DataDirector.PAGE_EDGE. Valid constants are listed in the See Also section, and they start with QDR_.

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, DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

getLayerQDR

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

Retrieves the QDR object that represents the specified logical layer.

Specified by:

getLayerQDR in interface DataAccess

Overrides:

getLayerQDR in class QueryDataAccess

Parameters:

edge - A constant that represents the edge in which to find the logical layer. The constants end with _EDGE and are listed in the See Also section.

layer - The zero-based index of the logical layer for which to return the QDR.

flags - A constant that indicates whether to include page edge information in the QDR, if edge is not DataDirector.PAGE_EDGE. Valid constants are listed in the See Also section, and they start with 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, DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE