Oracle Business Intelligence Beans Java API Reference: Class BaseCachedDataSource

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle™ Business Intelligence Beans Java API Reference
Release 10g (9.0.4)
Part number B12159_01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.dss.util.datacache
Class BaseCachedDataSource

java.lang.Object
  |
  +--oracle.dss.util.DataAccessAdapter
        |
        +--oracle.dss.util.datacache.BaseCachedDataSource

All Implemented Interfaces:: DataDirector, DataSource, Persistable, StringXMLizable

Direct Known Subclasses:: CachedDataSource, RelationalCachedDataSource

public abstract class BaseCachedDataSource
extends DataAccessAdapter
implements DataSource, Persistable

Base class for the relational and multidimensional data cache implementations

See Also:: CachedDataSource, RelationalCachedDataSource

Field Summary
`static java.lang.String`	`COLUMN_EDGE`
`static java.lang.String`	`DATAMAP`
`static java.lang.String`	`LAYERMETADATAMAP`
`static java.lang.String`	`METADATAMAP`
`static java.lang.String`	`PAGE_EDGE`
`static java.lang.String`	`ROW_EDGE`

Fields inherited from interface oracle.dss.util.DataDirector

DATA_ELEMENT_EDGE, DRILL_REPLACE, DRILLSTATE_DRILLABLE, DRILLSTATE_IS_DRILLED, DRILLSTATE_NOT_DRILLABLE, GROUPSORT_END, GROUPSORT_MIDDLE, GROUPSORT_NONE, GROUPSORT_START, max_edge, NA_SUPPRESSION, NA_ZERO_SUPPRESSION, NO_SUPPRESSION, PIVOT_EDGES, PIVOT_MOVE_AFTER, PIVOT_MOVE_BEFORE, PIVOT_MOVE_TO, PIVOT_SWAP, ZERO_SUPPRESSION

Constructor Summary
`BaseCachedDataSource()` Constructor

Method Summary
`void`	`addDataDirectorListener(DataDirectorListener l)` Registers a listener to the data source for changes.
`void`	`copyDataSource(DataAccess da, DataDirector dd)` Initializes the instance with data from existing DataAccess and DataDirector
`CubeDataDirector`	`createCubeDataDirector()` Creates a DataDirector for cube-based (OLAP) views
`RelationalDataDirector`	`createRelationalDataDirector()` Creates a DataDirector for relational views.
`int`	`getEdgeCount()` Retrieves the total number of edges in the cursor.
`int[]`	`getEdgeCurrentHPos(int edge)` Retrieves, for the specified edge, the hierarchical address of the location that is defined by the implementor as the "current" location.
`int`	`getEdgeCurrentSlice(int edge)` Retrieves the zero-based index of the slice that is defined by the implementor as the current slice.
`int`	`getEdgeExtent(int edge)` Retrieves the total number of slices that are available on the specified edge.
`DataMap`	`getExpectedDataMap()` Returns expected data map
`LayerMetadataMap`	`getExpectedLayerMetadataMap()` Returns expected layer metadata map
`MetadataMap`	`getExpectedMetadataMap()` Returns expected metadata map
`int[]`	`getFirstHPos(int edge)` Retrieves the hPos array that identifies the members at each physical layer of slice 0 on the specified edge.
`int[]`	`getLastHPos(int edge)` Retrieves the hPos array that identifies the members at each physical layer in the last slice on the specified edge.
`int`	`getLayerCount(int edge)` Retrieves the total number of layers on the specified edge.
`java.lang.Object`	`getLayerMetadata(int edge, int layer, java.lang.String type)` Retrieves the specified type of metadata for a member at the specified location.
`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.
`int`	`getMemberSiblingCount(int edge, int[] hPos, int memberLayer)` Retrieves the count of all the sibling members at a specified logical layer based on a series of relative indexes for each logical layer down to the specified logical layer.
`int`	`getMemberStartLayer(int edge, int layer, int slice)` Retrieves the starting layer at which a member at the specified edge, layer, and slice location begins.
`int`	`getMemberStartSlice(int edge, int layer, int slice)` Retrieves the absolute number of the first slice that a member spans.
`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.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.
`DataMap`	`getSupportedDataMap()` Return a `DataMap` that contains all of the types that this `DataAccessAdapter` can support.
`LayerMetadataMap`	`getSupportedLayerMetadataMap()` Return a `LayerMetadataMap` that contains all of the types that this `DataAccessAdapter` can support.
`MetadataMap`	`getSupportedMetadataMap()` Retrieves a `MetadataMap` that contains all of the types that this `DataAccessAdapter` can support.
`java.lang.Object`	`getValue(int row, int col, java.lang.String type)` Retrieves a data value for the specified row and column intersection.
`java.lang.String`	`getXML()` Returns XML representation of the data source as a string
`void`	`readXML(java.io.InputStream stream)` Initializes data source from an XML stream
`void`	`setExpectedDataMap(DataMap map)` Specifies the data map to be used when data is copied from the existing data source.
`void`	`setExpectedLayerMetadataMap(LayerMetadataMap map)` Specifies the layer metadata map to be used when data is copied from the existing data source.
`void`	`setExpectedMetadataMap(MetadataMap map)` Specifies the metadata map to be used when data is copied from the existing data source.
`void`	`setXML(java.lang.String xml)` Initializes data source from an XML string
`void`	`writeXML(java.io.OutputStream stream)` Writes XML representation of the data source into a stream

Methods inherited from class oracle.dss.util.DataAccessAdapter

cancel, changeEdgeCurrentHPos, changeEdgeCurrentSlice, deleteMemberCalc, deleteValueCalc, drill, drill, drillOK, drillOK, dropChanges, endGroupEdit, findMember, forceFetch, getDataMap, getLayerQDR, getMemberLogicalLayer, getMemberQDR, getMemberQDR, getMetadataMap, getQDRoverrideCollection, getSliceOutlineLayer, getSliceQDR, getValueQDR, insertMemberCalc, insertValueCalc, isAutoSubmit, isCancelable, isFetched, isOutline, pivot, pivotOK, redoEdit, refresh, release, removeDataDirectorListener, reorder, revalidate, setAutoSubmit, setDataMap, setManualUpdate, setMetadataMap, setOutline, setValue, startGroupEdit, submitChanges, undoEdit, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.util.persistence.Persistable

getPersistableAttributes, getPersistableComponents, initialize, setPersistableAttributes, setPersistableComponents

Methods inherited from interface oracle.dss.util.persistence.StringXMLizable

getXMLAsString, setXMLAsString

Field Detail

COLUMN_EDGE

public static final java.lang.String COLUMN_EDGE

ROW_EDGE

public static final java.lang.String ROW_EDGE

PAGE_EDGE

public static final java.lang.String PAGE_EDGE

DATAMAP

public static final java.lang.String DATAMAP

METADATAMAP

public static final java.lang.String METADATAMAP

LAYERMETADATAMAP

public static final java.lang.String LAYERMETADATAMAP

Constructor Detail

BaseCachedDataSource

public BaseCachedDataSource()

Constructor

Method Detail

copyDataSource

public void copyDataSource(DataAccess da,
DataDirector dd)

Initializes the instance with data from existing DataAccess and DataDirector

Parameters:: 1 - source DataAccess; 2 - source DataDirector

getEdgeCount

public int getEdgeCount()

Description copied from class: DataAccessAdapter

Retrieves the total number of edges in the cursor. Views assume the following:

Edge 0 is the column edge.
Edge 1 is the row edge.
All other edges are page edges; if the cursor has more than three edges, the view account for the extra edges.

This implementation returns 1.

Overrides:: getEdgeCount in class DataAccessAdapter

See Also:: DataAccess.getEdgeCount()

getLayerMetadata

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

Description copied from class: DataAccessAdapter

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

This implementation returns null.

Overrides:: getLayerMetadata in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.
See Also:: DataAccess.getLayerMetadata(int, int, java.lang.String)

getMemberSiblingCount

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

Description copied from class: DataAccessAdapter

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. This count is 3 (for NY, Boston, and LA). The hPos and memberLayer parameters for this example are as follows:

hPos, an array of relative indexes, holds an entry for July, Tents, and any one of the siblings that are to be counted. A valid hPos in this example must contain indexes for at least layers 0, 1, and 2. Valid arrays for this example could be any of the following: {1,0,0} or {1,0,1} or {1,0,2).
memberLayer, which identifies the layer at which to count the siblings, must be 2.

Note: The value that is returned by this method provides the upper limit to the hIndex that a caller passes in getMemberMetadata.

This implementation returns 0.

Overrides:: getMemberSiblingCount in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getMemberSiblingCount(int, int[], int)

getMemberMetadata

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

Description copied from class: DataAccessAdapter

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

Overrides:: getMemberMetadata in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getMemberMetadata(int, int, int, java.lang.String)

getLayerCount

public int getLayerCount(int edge)
                  throws EdgeOutOfRangeException

Description copied from class: DataAccessAdapter

Retrieves the total number of layers on the specified edge.

Overrides:: getLayerCount in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.
See Also:: DataAccess.getLayerCount(int)

getEdgeExtent

public int getEdgeExtent(int edge)
                  throws EdgeOutOfRangeException

Description copied from class: DataAccessAdapter

Retrieves the total number of slices that are available on the specified edge. The implementation returns 0.

Overrides:: getEdgeExtent in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.
See Also:: DataAccess.getEdgeExtent(int)

getSliceMemberCount

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

Description copied from class: DataAccessAdapter

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.

This implementation returns 0.

Overrides:: getSliceMemberCount in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getSliceMemberCount(int, int)

getMemberDepth

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

Description copied from class: DataAccessAdapter

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.

This implementation returns 0.

Overrides:: getMemberDepth in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getMemberDepth(int, int, int)

getMemberStartLayer

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

Description copied from class: DataAccessAdapter

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.

Overrides:: getMemberStartLayer in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getMemberStartLayer(int, int, int)

getMemberExtent

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

Description copied from class: DataAccessAdapter

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.

This implementation returns 0.

Overrides:: getMemberExtent in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getMemberExtent(int, int, int)

getMemberStartSlice

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

Description copied from class: DataAccessAdapter

Retrieves the absolute number of 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.

This implementation returns 0.

Overrides:: getMemberStartSlice in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getMemberStartSlice(int, int, int)

getMemberMetadata

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

Description copied from class: DataAccessAdapter

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

Overrides:: getMemberMetadata in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getMemberMetadata(int, int, int, java.lang.String)

getMemberHPos

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

Description copied from class: DataAccessAdapter

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.

Overrides:: getMemberHPos in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getMemberHPos(int, int, int)

getSliceLabel

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

Description copied from class: DataAccessAdapter

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.

Overrides:: getSliceLabel in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getSliceLabel(int, int, java.lang.String)

getFirstHPos

public int[] getFirstHPos(int edge)
                   throws EdgeOutOfRangeException

Description copied from class: DataAccessAdapter

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.

Overrides:: getFirstHPos in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.
See Also:: DataAccess.getFirstHPos(int)

getLastHPos

public int[] getLastHPos(int edge)
                  throws EdgeOutOfRangeException

Description copied from class: DataAccessAdapter

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.

Overrides:: getLastHPos in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.
See Also:: DataAccess.getLastHPos(int)

getNextHPos

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

Description copied from class: DataAccessAdapter

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.

Overrides:: getNextHPos in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getNextHPos(int, int[])

getPrevHPos

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

Description copied from class: DataAccessAdapter

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.

Overrides:: getPrevHPos in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.; LayerOutOfRangeException - if an error occurs.; SliceOutOfRangeException - if an error occurs.
See Also:: DataAccess.getPrevHPos(int, int[])

getEdgeCurrentSlice

public int getEdgeCurrentSlice(int edge)
                        throws EdgeOutOfRangeException

Description copied from class: DataAccessAdapter

Retrieves the zero-based index 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.

Overrides:: getEdgeCurrentSlice in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.
See Also:: DataAccess.getEdgeCurrentSlice(int)

getEdgeCurrentHPos

public int[] getEdgeCurrentHPos(int edge)
                         throws EdgeOutOfRangeException

Description copied from class: DataAccessAdapter

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.

Overrides:: getEdgeCurrentHPos in class DataAccessAdapter

Throws:: EdgeOutOfRangeException - if an error occurs.
See Also:: DataAccess.getEdgeCurrentHPos(int)

getValue

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

Description copied from class: DataAccessAdapter

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

This implementation returns null.

Overrides:: getValue in class DataAccessAdapter

Throws:: RowOutOfRangeException - if an error occurs.; ColumnOutOfRangeException - if an error occurs.
See Also:: DataAccess.getValue(int, int, java.lang.String)

setExpectedDataMap

public void setExpectedDataMap(DataMap map)

Specifies the data map to be used when data is copied from the existing data source. The data source resulting from a copy will have a data map only with types present in both this data map a the one returned by getSupportedDataMap() on the existing data source

Parameters:: 1 - data map

getExpectedDataMap

public DataMap getExpectedDataMap()

Returns expected data map

Returns:: data map
See Also:: setExpectedDataMap(oracle.dss.util.DataMap)

setExpectedMetadataMap

public void setExpectedMetadataMap(MetadataMap map)

Specifies the metadata map to be used when data is copied from the existing data source. The data source resulting from a copy will have a metadata map only with types present in both this metadata map a the one returned by getSupportedMetadataMap() on the existing data source

Parameters:: 1 - metadata map

getExpectedMetadataMap

public MetadataMap getExpectedMetadataMap()

Returns expected metadata map

Returns:: metadata map
See Also:: setExpectedMetadataMap(oracle.dss.util.MetadataMap)

setExpectedLayerMetadataMap

public void setExpectedLayerMetadataMap(LayerMetadataMap map)

Specifies the layer metadata map to be used when data is copied from the existing data source. The data source resulting from a copy will have a layer metadata map only with types present in both this layer metadata map a the one returned by getSupportedLayerMetadataMap() on the existing data source

Parameters:: 1 - layer metadata map

getExpectedLayerMetadataMap

public LayerMetadataMap getExpectedLayerMetadataMap()

Returns expected layer metadata map

Returns:: layer metadata map
See Also:: setExpectedLayerMetadataMap(oracle.dss.util.LayerMetadataMap)

getSupportedMetadataMap

public MetadataMap getSupportedMetadataMap()

Description copied from class: DataAccessAdapter

Retrieves a MetadataMap that contains all of the types that this DataAccessAdapter can support. Some types of metadata might not be available in some types of queries.

Overrides:: getSupportedMetadataMap in class DataAccessAdapter

See Also:: DataDirector.getSupportedMetadataMap()

getSupportedLayerMetadataMap

public LayerMetadataMap getSupportedLayerMetadataMap()

Description copied from class: DataAccessAdapter

Return a LayerMetadataMap that contains all of the types that this DataAccessAdapter can support. Some types of layer metadata might not be available in some types of queries.

Overrides:: getSupportedLayerMetadataMap in class DataAccessAdapter

See Also:: DataDirector.getSupportedLayerMetadataMap()

getSupportedDataMap

public DataMap getSupportedDataMap()

Description copied from class: DataAccessAdapter

Return a DataMap that contains all of the types that this DataAccessAdapter can support. Some types of data might not be available in some types of queries.

Overrides:: getSupportedDataMap in class DataAccessAdapter

See Also:: DataDirector.getSupportedDataMap()

addDataDirectorListener

public void addDataDirectorListener(DataDirectorListener l)

Description copied from class: DataAccessAdapter

Registers a listener to the data source for changes. The DataDirector implementor is expected to fire a DataAvailableEvent in this routine when data is available and to provide an implementation of the DataAccess interface when data is ready.

This implementation does nothing.

Overrides:: addDataDirectorListener in class DataAccessAdapter

See Also:: DataDirector.addDataDirectorListener(oracle.dss.util.DataDirectorListener)

createCubeDataDirector

public CubeDataDirector createCubeDataDirector()

Description copied from interface: DataSource

Creates a DataDirector for cube-based (OLAP) views

Specified by:: createCubeDataDirector in interface DataSource

Following copied from interface: oracle.dss.util.DataSource

Returns:: An implementation of the CubeDataDirector interface.

createRelationalDataDirector

public RelationalDataDirector createRelationalDataDirector()

Description copied from interface: DataSource

Creates a DataDirector for relational views.

Specified by:: createRelationalDataDirector in interface DataSource

Following copied from interface: oracle.dss.util.DataSource

Returns:: An implementation of the RelationalDataDirector interface.

writeXML

public void writeXML(java.io.OutputStream stream)
              throws BIIOException

Writes XML representation of the data source into a stream

Parameters:: 1 - stream
Throws:: BIOException - if an error occurs.

getXML

public java.lang.String getXML()
                        throws BIIOException

Returns XML representation of the data source as a string

Returns:: XML string
Throws:: BIOException - if an error occurs.

readXML

public void readXML(java.io.InputStream stream)
             throws BIIOException,
BIParseException,
BISAXException

Initializes data source from an XML stream

Parameters:: 1 - stream
Throws:: BIIOException - if an error occurs.; BIParseException - if an error occurs.; BISAXException - if an error occurs.

setXML

public void setXML(java.lang.String xml)
            throws BIParseException,
BISAXException,
BIIOException

Initializes data source from an XML string

Parameters:: 1 - XML string
Throws:: BIIOException - if an error occurs.; BIParseException - if an error occurs.; BISAXException - if an error occurs.

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle™ Business Intelligence Beans Java API Reference
Release 10g (9.0.4)
Part number B12159_01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.dss.util.datacache Class BaseCachedDataSource

COLUMN_EDGE

ROW_EDGE

PAGE_EDGE

DATAMAP

METADATAMAP

LAYERMETADATAMAP

BaseCachedDataSource

copyDataSource

getEdgeCount

getLayerMetadata

getMemberSiblingCount

getMemberMetadata

getLayerCount

getEdgeExtent

getSliceMemberCount

getMemberDepth

getMemberStartLayer

getMemberExtent

getMemberStartSlice

getMemberMetadata

getMemberHPos

getSliceLabel

getFirstHPos

getLastHPos

getNextHPos

getPrevHPos

getEdgeCurrentSlice

getEdgeCurrentHPos

getValue

setExpectedDataMap

getExpectedDataMap

setExpectedMetadataMap

getExpectedMetadataMap

setExpectedLayerMetadataMap

getExpectedLayerMetadataMap

getSupportedMetadataMap

getSupportedLayerMetadataMap

getSupportedDataMap

addDataDirectorListener

createCubeDataDirector

createRelationalDataDirector

writeXML

getXML

readXML

setXML

oracle.dss.util.datacache
Class BaseCachedDataSource