oracle.dss.dataView
Class LocalXMLDataSource

java.lang.Object
  oracle.dss.util.DataAccessAdapter
      oracle.dss.dataView.LocalXMLDataSource

All Implemented Interfaces:

CDFDataAccess, CubeDataAccess, CubeDataDirector, DataAccess, DataDirector, DataSource, RelationalDataAccess, RelationalDataDirector

public class LocalXMLDataSource
extends DataAccessAdapter
implements CubeDataDirector, CubeDataAccess, RelationalDataDirector, RelationalDataAccess, DataSource

Field Summary

protected int	m_columnCount
protected java.lang.Object[]	m_columnLabels
protected java.lang.Object[][]	m_data
protected DataMap	m_dataMap
protected javax.swing.event.EventListenerList	m_listenerList
protected MetadataMap	m_metadataMap
protected int	m_pageCount
protected int	m_rowCount
protected java.lang.Object[]	m_rowLabels

Fields inherited from interface oracle.dss.util.DataDirector

COLUMN_EDGE, DATA_ELEMENT_EDGE, DRILL_BACK, DRILL_COLLAPSE, DRILL_MEMBERS_ABOVE, DRILL_MEMBERS_BELOW, DRILL_REPLACE, DRILL_TO_PARENT, DRILL_TO_PARENT_AND_SIBLINGS, DRILLSTATE_DRILLABLE, DRILLSTATE_IS_DRILLED, DRILLSTATE_NOT_DRILLABLE, FORCE_FETCH_DATA, FORCE_FETCH_RELATIVE_INDENT, FORCE_FETCH_SPANS, GRAND_TOTAL_LAYER, GROUPSORT_END, GROUPSORT_MIDDLE, GROUPSORT_NONE, GROUPSORT_START, HIDDEN_EDGE, max_edge, NA_SUPPRESSION, NA_ZERO_SUPPRESSION, NO_SUPPRESSION, NO_TOTALS, PAGE_EDGE, PIVOT_CHECK_OK, PIVOT_CHECK_UNKNOWN, PIVOT_EDGES, PIVOT_MOVE_AFTER, PIVOT_MOVE_BEFORE, PIVOT_MOVE_TO, PIVOT_SWAP, PROP_ASYNCHRONOUS, PROP_AUTO_FIRE_EVENTS, PROP_CACHE_LIMIT, PROP_COLUMN_FETCH_SIZE, PROP_COLUMN_SORTS_SUPPORTED, PROP_DD2_DRILL_SUPPORTED, PROP_DD2_VARIABLE_DRILLPATHS, PROP_DEFAULT_DRILL_TYPE, PROP_EDGE_EXTENT_AVAILABLE, PROP_HIDDEN_EDGE_SUPPORTED, PROP_IS_COLUMN_OUTLINE_SUPPORTED, PROP_IS_OUTLINE_SUPPORTED, PROP_IS_ROW_OUTLINE_SUPPORTED, PROP_PAGE_SORTS_SUPPORTED, PROP_REL_INDENT_SCAN_LIMIT, PROP_ROW_FETCH_SIZE, PROP_SORTS_SUPPORTED, PROP_SUPPORTED_DRILL_TYPES, PROP_TABULAR, PROP_TOTALS_ALLOWED, PROP_TOTALS_VISIBLE, PROP_UNIQUE_MEMBERS_SCAN_LIMIT, ROW_EDGE, SECTION_EDGE, SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING, SORT_TYPE_GROUPSORT, SORT_TYPE_GROUPSORT_PAGEBREAK, SORT_TYPE_NORMAL, TOTAL_ALL_LAYERS, TOTAL_AVERAGE, TOTAL_MAXIMUM, TOTAL_MINIMUM, TOTAL_SUM, ZERO_SUPPRESSION

Fields inherited from interface oracle.dss.util.DataAccess

DATATYPE_BOOLEAN, DATATYPE_DATE, DATATYPE_DOUBLE, DATATYPE_FLOAT, DATATYPE_INTEGER, DATATYPE_LONG, DATATYPE_SHORT, DATATYPE_STRING, FIND_CASE_INSENSITIVE, FIND_CONTAINS, FIND_ENDS_WITH, FIND_EXACT, FIND_PRIOR, FIND_STARTS_WITH, QDR_WITH_PAGE, QDR_WITHOUT_PAGE

Constructor Summary

LocalXMLDataSource(java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data)
Constructor.

Method Summary

void	addDataDirectorListener(DataDirectorListener l) Registers a listener to the data source for changes.
CubeDataDirector	createCubeDataDirector() Creates a DataDirector for cube-based (OLAP) views
DataDirector	createDataDirector()
RelationalDataDirector	createRelationalDataDirector() Creates a DataDirector for relational views.
protected void	fireDataAvailableEvent(DataAvailableEvent e) Fire a DataAvailableEvent to all DataDirectorListeners.
DataAccess	getDataAccess() Called by the view to get a current BaseDataAccess model of the data.
DataMap	getDataMap() Retrieves the list of types of data that can be retrieved or set for each location in the data cursor.
int	getEdgeCount() Retrieves the total number of edges in the cursor.
int	getEdgeExtent(int edge) Retrieves the total number of members on the given edge.
int	getLayerCount(int edge) Retrieves the number of layers on the specified edge.
int	getMemberExtent(int edge, int layer, int slice) Retrieves the number of slices that a member spans.
java.lang.Object	getMemberMetadata(int edge, int layer, int slice, java.lang.String type) Retrieves a piece of metadata for a dimension member.
int	getMemberStartSlice(int edge, int layer, int slice) Retrieves the first slice that a member spans.
MetadataMap	getMetadataMap(int edge, int layer) Retrieves the list of available types of metadata.
java.lang.Object	getSliceLabel(int edge, int slice, java.lang.String type) Retrieves the label for the specified slice.
int	getSliceMemberCount(int edge, int slice) Retrieves the number of logical layers at the specified location on the specified 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.
void	removeDataDirectorListener(DataDirectorListener l) Removes a listener from the data source.

Methods inherited from class oracle.dss.util.DataAccessAdapter

allSlicesFetched, cancel, changeEdgeCurrentHPos, changeEdgeCurrentSlice, deleteMemberCalc, deleteValueCalc, drill, drill, drill, drill, drillOK, drillOK, drillOK, drillOK, dropChanges, endGroupEdit, findMember, fireEvents, forceFetch, getColumnSorts, getCompatibleDataItemMetadata, getCorrespondingMemberMetadata, getCorrespondingMemberMetadata, getDimensionSorts, getEdgeCurrentHPos, getEdgeCurrentSlice, getEdgeSymmetric, getExpressions, getFirstHPos, getLastHPos, getLayerMetadata, getLayerQDR, getMemberDepth, getMemberHPos, getMemberLogicalLayer, getMemberMetadata, getMemberQDR, getMemberQDR, getMemberSiblingCount, getMemberSorts, getMemberStartLayer, getNextHPos, getPrevHPos, getProperty, getQDRoverrideCollection, getSliceOutlineLayer, getSliceQDR, getSlicesFromQDR, getSorts, getStatus, getUniqueMemberMetadata, getUniqueMemberMetadata, getValueQDR, insertMemberCalc, insertValueCalc, isAutoSubmit, isCancelable, isFetched, isMemberExtentComplete, isOutline, pivot, pivotCheck, pivotOK, redoEdit, refresh, release, reorder, revalidate, setAutoSubmit, setColumnSorts, setDataMap, setDimensionSorts, setExpressions, setLayerMetadata, setManualUpdate, setMemberSorts, setMetadataMap, setOutline, setProperty, setSorts, setValue, startExecution, startGroupEdit, submitChanges, undoEdit, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.util.DataDirector

cancel, changeEdgeCurrentHPos, changeEdgeCurrentSlice, deleteMemberCalc, deleteValueCalc, drill, drill, drill, drill, drillOK, drillOK, drillOK, drillOK, fireEvents, getColumnSorts, getCompatibleDataItemMetadata, getDimensionSorts, getExpressions, getMemberSorts, getProperty, getSorts, getStatus, insertMemberCalc, insertValueCalc, isCancelable, isOutline, pivot, pivotCheck, pivotOK, refresh, release, reorder, revalidate, setColumnSorts, setDataMap, setDimensionSorts, setExpressions, setLayerMetadata, setManualUpdate, setMemberSorts, setMetadataMap, setOutline, setProperty, setSorts, startExecution, update

Methods inherited from interface oracle.dss.util.DataAccess

allSlicesFetched, dropChanges, endGroupEdit, findMember, forceFetch, getCorrespondingMemberMetadata, getCorrespondingMemberMetadata, getEdgeCurrentHPos, getEdgeCurrentSlice, getFirstHPos, getLastHPos, getLayerQDR, getMemberHPos, getMemberLogicalLayer, getMemberMetadata, getMemberQDR, getMemberQDR, getMemberSiblingCount, getNextHPos, getPrevHPos, getQDRoverrideCollection, getSliceOutlineLayer, getSliceQDR, getSlicesFromQDR, getUniqueMemberMetadata, getUniqueMemberMetadata, getValueQDR, isAutoSubmit, isFetched, isMemberExtentComplete, redoEdit, release, setAutoSubmit, setValue, startGroupEdit, submitChanges, undoEdit

Methods inherited from interface oracle.dss.util.CDFDataAccess

getEdgeSymmetric, getLayerMetadata, getMemberDepth, getMemberStartLayer

Field Detail

m_listenerList

protected javax.swing.event.EventListenerList m_listenerList

m_dataMap

protected DataMap m_dataMap

m_metadataMap

protected MetadataMap m_metadataMap

m_columnCount

protected int m_columnCount

m_rowCount

protected int m_rowCount

m_pageCount

protected int m_pageCount

m_columnLabels

protected java.lang.Object[] m_columnLabels

m_rowLabels

protected java.lang.Object[] m_rowLabels

m_data

protected java.lang.Object[][] m_data

Constructor Detail

LocalXMLDataSource

public LocalXMLDataSource(java.lang.Object[] columnLabels,
                          java.lang.Object[] rowLabels,
                          java.lang.Object[][] data)

Constructor.

Method Detail

createCubeDataDirector

public CubeDataDirector createCubeDataDirector()

Creates a DataDirector for cube-based (OLAP) views

Specified by:

createCubeDataDirector in interface DataSource

Returns:

An implementation of the CubeDataDirector interface.

createRelationalDataDirector

public RelationalDataDirector createRelationalDataDirector()

Creates a DataDirector for relational views.

Specified by:

createRelationalDataDirector in interface DataSource

Returns:

An implementation of the RelationalDataDirector interface.

addDataDirectorListener

public void addDataDirectorListener(DataDirectorListener l)

Registers a listener to the data source for changes.

Specified by:

addDataDirectorListener in interface DataDirector

Overrides:

addDataDirectorListener in class DataAccessAdapter

Parameters:

l - The listener to add.

removeDataDirectorListener

public void removeDataDirectorListener(DataDirectorListener l)

Removes a listener from the data source.

Specified by:

removeDataDirectorListener in interface DataDirector

Overrides:

removeDataDirectorListener in class DataAccessAdapter

Parameters:

l - The listener to remove.

createDataDirector

public DataDirector createDataDirector()

getDataAccess

public DataAccess getDataAccess()
                         throws DataDirectorException

Description copied from interface: DataDirector

Called by the view to get a current BaseDataAccess model of the data.

Specified by:

getDataAccess in interface DataDirector

Overrides:

getDataAccess in class DataAccessAdapter

Returns:

current model of data implemented via BaseDataAccess

Throws:

DataDirectorException

getDataMap

public DataMap getDataMap()

Retrieves the list of types of data that can be retrieved or set for each location in the data cursor. This list includes the types of data that have been specified in data maps by any views that use this data provider.

Specified by:

getDataMap in interface DataDirector

Overrides:

getDataMap in class DataAccessAdapter

Returns:

The map of available types of data.

getEdgeCount

public int getEdgeCount()

Retrieves the total number of edges in the cursor.

Specified by:

getEdgeCount in interface CDFDataAccess

Overrides:

getEdgeCount in class DataAccessAdapter

Returns:

The total number of edges in the cursor.

getEdgeExtent

public int getEdgeExtent(int edge)
                  throws EdgeOutOfRangeException

Retrieves the total number of members on the given edge.

Specified by:

getEdgeExtent in interface CDFDataAccess

Overrides:

getEdgeExtent in class DataAccessAdapter

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. This implementation returns zero.

Throws:

EdgeOutOfRangeException - If the edge parameter is not valid.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, *

getLayerCount

public int getLayerCount(int edge)
                  throws EdgeOutOfRangeException

Retrieves the number of layers on the specified edge.

Specified by:

getLayerCount in interface CDFDataAccess

Overrides:

getLayerCount in class DataAccessAdapter

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. This implementation returns zero.

Throws:

EdgeOutOfRangeException - If edge is out of range.

See Also:

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 number of slices that a member spans.

Specified by:

getMemberExtent in interface CDFDataAccess

Overrides:

getMemberExtent in class DataAccessAdapter

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 index 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. This implementation returns zero.

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:

DataAccessAdapter.getMemberStartSlice(int, int, int), 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,
                                          LayerOutOfRangeException,
                                          SliceOutOfRangeException

Retrieves a piece of metadata for a dimension member.

Specified by:

getMemberMetadata in interface CDFDataAccess

Overrides:

getMemberMetadata in class DataAccessAdapter

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 the caller intends to use.

Returns:

The requested metadata. This implementation returns null.

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

getMemberStartSlice

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

Retrieves the first slice that a member spans.

Specified by:

getMemberStartSlice in interface CDFDataAccess

Overrides:

getMemberStartSlice in class DataAccessAdapter

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 index 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. This implementation returns zero.

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:

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

getMetadataMap

public MetadataMap getMetadataMap(int edge,
                                  int layer)
                           throws EdgeOutOfRangeException,
                                  LayerOutOfRangeException

Retrieves the list of available types of metadata.

Specified by:

getMetadataMap in interface DataDirector

Overrides:

getMetadataMap in class DataAccessAdapter

Parameters:

edge - A constant that indicates the edge that contains the logical layer. Valid constants end with _EDGE in this interface. A value of -1 is a request for the default MetadataMap.

layer - A zero-based index for the logical layer for which to retrieve the metadata map. The outermost layer on the specified edge is zero. A layer value of -1 indicates all of the layers on the specified edge.

Returns:

The map that contains all of the types of metadata that are to be retrieved into the cursors for the layer.

Throws:

EdgeOutOfRangeException - if edge is out of range.

LayerOutOfRangeException - If no layer exists at this location.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getSliceLabel

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

Retrieves the label for the specified slice.

Specified by:

getSliceLabel in interface DataAccess

Overrides:

getSliceLabel in class DataAccessAdapter

Parameters:

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

slice - An absolute index (zero-based) along the specified edge that indicates the slice for which concatenated metadata is desired.

type - A constant that specifies the kind of metadata that the caller wants to have returned. Valid type values are defined in the class MetadataMap class.

Returns:

The label (or metadata) for the location on the specified edge. This implementation returns null.

Throws:

EdgeOutOfRangeException - If edge is out of range.

SliceOutOfRangeException - If slice is negative or too large.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

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.

Specified by:

getSliceMemberCount in interface DataAccess

Overrides:

getSliceMemberCount in class DataAccessAdapter

Parameters:

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

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

Returns:

The total number of unique logical layers for the specified slice and edge. This implementation returns zero.

Throws:

EdgeOutOfRangeException - If edge is out of range.

SliceOutOfRangeException - If slice is negative or 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 DataAccessAdapter

Parameters:

row - The row to get.

col - The column to get.

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

Returns:

The specified type of information for the specified row and column location. This implementation returns null.

Throws:

RowOutOfRangeException - If row is negative or too large.

ColumnOutOfRangeException - If column is negative or too large.

See Also:

DataMap

fireDataAvailableEvent

protected void fireDataAvailableEvent(DataAvailableEvent e)

Fire a DataAvailableEvent to all DataDirectorListeners.

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.

Specified by:

getSupportedDataMap in interface DataDirector

Overrides:

getSupportedDataMap in class DataAccessAdapter

Returns:

null.

See Also:

DataMap

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.

Specified by:

getSupportedMetadataMap in interface DataDirector

Overrides:

getSupportedMetadataMap in class DataAccessAdapter

Returns:

null.

See Also:

MetadataMap

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.

Specified by:

getSupportedLayerMetadataMap in interface DataDirector

Overrides:

getSupportedLayerMetadataMap in class DataAccessAdapter

Returns:

null.

See Also:

LayerMetadataMap