oracle.dss.util

Interface CDFDataAccess

All Known Subinterfaces:

CubeDataAccess, DataAccess, RelationalDataAccess

All Known Implementing Classes:

DataAccessAdapter, GaugeLocalDataSource, LocalDataSource, LocalPivotTableDataSource, LocalXMLDataSource, SampleDataSource

public interface CDFDataAccess

DataAccess methods that must be implemented to create CDF-compliant DataControls

Method Summary

Modifier and Type	Method and Description
int	getEdgeCount() Retrieves the total number of edges that are available in the cursor.
int	getEdgeExtent(int edge) Retrieves the total number of slices that are available on the specified edge.
boolean	getEdgeSymmetric(int edge) Returns true if the edge is completely symmetric (every parent tuple has the same set of children at each layer), or false if not.
int	getLayerCount(int edge) Retrieves the total number of layers on the specified edge.
java.lang.Object	getLayerMetadata(int edge, int layer, java.lang.String type) Retrieves a piece of metadata for a logical layer that is found at a specified edge and logical layer.
int	getMemberDepth(int edge, int layer, int slice) Retrieves the size 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).
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.
int	getMemberStartLayer(int edge, int layer, int slice) Retrieves the starting layer at which a member at the specified edge, layer, and slice location begins.
int	getMemberStartSlice(int edge, int layer, int slice) Retrieves the absolute number of the first slice that a member spans.

Method Detail

getEdgeCount

int getEdgeCount()

Retrieves the total number of edges that are available in the cursor. This total does not include the edge that is represented by DataDirector.DATA_ELEMENT_EDGE.

Returns:

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

getEdgeExtent

int getEdgeExtent(int edge)
           throws EdgeOutOfRangeException

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

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.

Throws:

EdgeOutOfRangeException - If the edge parameter is not valid.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getEdgeSymmetric

boolean getEdgeSymmetric(int edge)
                  throws EdgeOutOfRangeException

Returns true if the edge is completely symmetric (every parent tuple has the same set of children at each layer), or false if not.

Parameters:

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

Returns:

true if the edge is symmetric, false if not

Throws:

EdgeOutOfRangeException - If the edge parameter is not valid.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getLayerCount

int getLayerCount(int edge)
           throws EdgeOutOfRangeException

Retrieves the total number of layers on the specified edge.

Parameters:

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

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getLayerMetadata

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

Retrieves a piece of metadata for a logical layer that is found at a specified edge and logical layer.

Parameters:

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

layer - The zero-based number of the layer for which metadata is requested. Uses a depth computation to identify the location of the layer or layer member; 0 is the outer-most layer on the edge. The value for this parameter can be obtained by calling getMemberLogicalLayer.

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

Returns:

The requested metadata.

Throws:

EdgeOutOfRangeException - If edge is too large.

LayerOutOfRangeException - If layer is negative or too large.

See Also:

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

getMemberExtent

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.

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

getMemberStartSlice

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. Presentation beans pass the same parameter values to this method and to getMemberExtent.

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:

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

getMemberMetadata

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

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

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 (such as METADATA_LONGLABEL or METADATA_VALUE) are defined in MetadataMap. Example: If type is specified as MetadataMap.METADATA_DRILLSTATE, then this method returns one of the drill state constants that are found in DataDirector. Note: The caller should have intialized the appropriate MetadataMap object with any types of metadata that the caller intends to use.

Returns:

The requested metadata.

Throws:

LayerOutOfRangeException - If layer is negative or too large.

SliceOutOfRangeException - If slice is negative or too large.

EdgeOutOfRangeException

See Also:

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

getMemberDepth

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

Retrieves the size of a member at the specified layer, slice, and edge. The size is expressed as the number of logical layers that the member covers. 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.

In outline mode, this method should return value from getLayerCount.

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

getLayerCount(int), getMemberStartLayer(int, int, int), DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getMemberStartLayer

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

Retrieves the starting layer at which a member at the specified edge, layer, and slice location begins. Presentation beans use this method in conjunction with getMemberDepth to retrieve the following information depending on the edge:

• For a member on a column edge, the vertical height and starting position.
• For a member on a row edge, the horizontal width and starting position.

The sum of the values that are returned for a member by this method, getMemberStartLayer, and getMemberDepth should not exceed the value that is returned by getLayerCount for an edge.

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

Parameters:

edge - A constant that represents the edge in which to look for layer and slice. The constants end with _EDGE in DataDirector.

layer - The zero-based number of the physical layer in which to look for the slice.

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

Returns:

The starting layer of the member within the specified edge.

Throws:

EdgeOutOfRangeException - If the edge parameter is not valid.

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

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

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE