|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.dss.util.DataAccessAdapter
oracle.dss.dataView.LocalXMLDataSource
public class LocalXMLDataSource
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.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. |
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 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. |
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 |
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. |
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). |
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. |
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. |
void |
removeDataDirectorListener(DataDirectorListener l) Removes a listener from the data source. |
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.CDFDataAccess |
---|
getEdgeSymmetric, getMemberStartLayer |
Field Detail |
---|
protected javax.swing.event.EventListenerList m_listenerList
protected DataMap m_dataMap
protected MetadataMap m_metadataMap
protected int m_columnCount
protected int m_rowCount
protected int m_pageCount
protected java.lang.Object[] m_columnLabels
protected java.lang.Object[] m_rowLabels
protected java.lang.Object[][] m_data
Constructor Detail |
---|
public LocalXMLDataSource(java.lang.Object[] columnLabels, java.lang.Object[] rowLabels, java.lang.Object[][] data)
Method Detail |
---|
public CubeDataDirector createCubeDataDirector()
createCubeDataDirector
in interface DataSource
public RelationalDataDirector createRelationalDataDirector()
createRelationalDataDirector
in interface DataSource
public void addDataDirectorListener(DataDirectorListener l)
addDataDirectorListener
in interface DataDirector
addDataDirectorListener
in class DataAccessAdapter
l
- The listener to add.public void removeDataDirectorListener(DataDirectorListener l)
removeDataDirectorListener
in interface DataDirector
removeDataDirectorListener
in class DataAccessAdapter
l
- The listener to remove.public DataDirector createDataDirector()
public DataAccess getDataAccess() throws DataDirectorException
DataDirector
BaseDataAccess
model of the data.getDataAccess
in interface DataDirector
getDataAccess
in class DataAccessAdapter
BaseDataAccess
DataDirectorException
public DataMap getDataMap()
getDataMap
in interface DataDirector
getDataMap
in class DataAccessAdapter
public int getEdgeCount()
getEdgeCount
in interface CDFDataAccess
getEdgeCount
in class DataAccessAdapter
public int getEdgeExtent(int edge) throws EdgeOutOfRangeException
getEdgeExtent
in interface CDFDataAccess
getEdgeExtent
in class DataAccessAdapter
edge
- A constant that represents the edge of interest. The constants end with _EDGE
in DataDirector
.EdgeOutOfRangeException
- If the edge
parameter is not valid.DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, *
public int getLayerCount(int edge) throws EdgeOutOfRangeException
getLayerCount
in interface CDFDataAccess
getLayerCount
in class DataAccessAdapter
edge
- A constant that represents the edge of interest. The constants end with _EDGE
in DataDirector
.layer
parameter in other API calls: the valid range is from zero to this return value minus one. This implementation returns zero.EdgeOutOfRangeException
- If edge
is out of range.DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
public java.lang.Object getLayerMetadata(int edge, int layer, java.lang.String type) throws EdgeOutOfRangeException, LayerOutOfRangeException
getLayerMetadata
in interface CDFDataAccess
getLayerMetadata
in class DataAccessAdapter
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 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
.EdgeOutOfRangeException
- If edge
is too large.LayerOutOfRangeException
- If layer
is negative or too large.LayerMetadataMap
, DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
public int getMemberDepth(int edge, int layer, int slice) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException
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 1 for the row and column edges.
getMemberDepth
in interface CDFDataAccess
getMemberDepth
in class DataAccessAdapter
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 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.EdgeOutOfRangeException
- If edge
is too large.LayerOutOfRangeException
- If layer
is negative or too large.SliceOutOfRangeException
- If slice
is negative or too large.DataAccessAdapter.getMemberStartLayer(int, int, int)
, DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
public int getMemberExtent(int edge, int layer, int slice) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException
getMemberExtent
in interface CDFDataAccess
getMemberExtent
in class DataAccessAdapter
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.EdgeOutOfRangeException
- If edge
is too large.LayerOutOfRangeException
- If layer
is negative or too largeSliceOutOfRangeException
- If slice
is negative or too largeDataAccessAdapter.getMemberStartSlice(int, int, int)
, DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
public java.lang.Object getMemberMetadata(int edge, int layer, int slice, java.lang.String type) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException
getMemberMetadata
in interface CDFDataAccess
getMemberMetadata
in class DataAccessAdapter
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.LayerOutOfRangeException
- If layer
is negative or too large.SliceOutOfRangeException
- If slice
is negative or too large.EdgeOutOfRangeException
MetadataMap
, DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
public int getMemberStartSlice(int edge, int layer, int slice) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException
getMemberStartSlice
in interface CDFDataAccess
getMemberStartSlice
in class DataAccessAdapter
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.EdgeOutOfRangeException
- If edge
is too large.LayerOutOfRangeException
- If layer
is negative or too large.SliceOutOfRangeException
- If slice
is negative or too large.DataAccessAdapter.getMemberExtent(int, int, int)
, DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
public MetadataMap getMetadataMap(int edge, int layer) throws EdgeOutOfRangeException, LayerOutOfRangeException
getMetadataMap
in interface DataDirector
getMetadataMap
in class DataAccessAdapter
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.layer
.EdgeOutOfRangeException
- if edge
is out of range.LayerOutOfRangeException
- If no layer exists at this location.DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
public java.lang.Object getSliceLabel(int edge, int slice, java.lang.String type) throws EdgeOutOfRangeException, SliceOutOfRangeException
getSliceLabel
in interface DataAccess
getSliceLabel
in class DataAccessAdapter
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.EdgeOutOfRangeException
- If edge
is out of range.SliceOutOfRangeException
- If slice
is negative or too large.DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
public int getSliceMemberCount(int edge, int slice) throws EdgeOutOfRangeException, SliceOutOfRangeException
getSliceMemberCount
in interface DataAccess
getSliceMemberCount
in class DataAccessAdapter
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.EdgeOutOfRangeException
- If edge
is out of range.SliceOutOfRangeException
- If slice
is negative or too large.DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
public java.lang.Object getValue(int row, int col, java.lang.String type) throws RowOutOfRangeException, ColumnOutOfRangeException
getValue
in interface DataAccess
getValue
in class DataAccessAdapter
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.RowOutOfRangeException
- If row
is negative or too large.ColumnOutOfRangeException
- If column
is negative or too large.DataMap
public QDR getValueQDR(int row, int column, int flags) throws RowOutOfRangeException, ColumnOutOfRangeException
QDR
object that represents the value at the specified row and column in the data area of the cursor.getValueQDR
in interface DataAccess
getValueQDR
in class DataAccessAdapter
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 identifies whether to include page edge information if the QDR
is not for the page edge. Valid constants are listed in the See Also section.QDR
object that refers to the data at the specified location.RowOutOfRangeException
- If the row
parameter is not valid.ColumnOutOfRangeException
- If the column
parameter is not valid.DataAccess.QDR_WITH_PAGE
, DataAccess.QDR_WITHOUT_PAGE
public QDR getSliceQDR(int edge, int slice, int flags) throws EdgeOutOfRangeException, SliceOutOfRangeException
QDR
object that represents the data value at the specified slice on the edge (that is, across all relevant logical layers of the slice).getSliceQDR
in interface DataAccess
getSliceQDR
in class DataAccessAdapter
edge
- A constant that represents the edge of in which to find the slice. The constants end with _EDGE
in DataDirector
.slice
- An absolute index (zero-based) that indicates the location of the slice along the specified edge.flags
- A constant that identifies whether to include page edge information if the QDR
is not for the page edge. Valid constants are listed in the See Also section.QDR
object that refers to the data at the specified location.EdgeOutOfRangeException
- If the edge
parameter is not valid.SliceOutOfRangeException
- If the slice
parameter is not valid.DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
, DataAccess.QDR_WITH_PAGE
, DataAccess.QDR_WITHOUT_PAGE
public QDR getMemberQDR(int edge, int layer, int slice, int flags) throws EdgeOutOfRangeException, LayerOutOfRangeException, SliceOutOfRangeException
QDR
object that represents the data value for the member at the specified edge, layer, and slice.getMemberQDR
in interface DataAccess
getMemberQDR
in class DataAccessAdapter
edge
- A constant that represents the edge of interest. The constants end with _EDGE
in DataDirector
.layer
- A zero-based index that represents the physical layer of the member for which the QDR
object is requested.slice
- An absolute index (zero-based) that indicates the location, along the specified edge, of a slice that belongs to the member for which the QDR
object is requested.flags
- A constant that identifies whether to include page edge information if the QDR
is not for the page edge. Valid constants are listed in the See Also section.QDR
object that refers to the data at the specified position.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
.DataDirector.COLUMN_EDGE
, DataDirector.PAGE_EDGE
, DataDirector.ROW_EDGE
, DataAccess.QDR_WITH_PAGE
, DataAccess.QDR_WITHOUT_PAGE
protected void fireDataAvailableEvent(DataAvailableEvent e)
public DataMap getSupportedDataMap()
DataAccessAdapter
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.getSupportedDataMap
in interface DataDirector
getSupportedDataMap
in class DataAccessAdapter
null
.DataMap
public MetadataMap getSupportedMetadataMap()
DataAccessAdapter
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.getSupportedMetadataMap
in interface DataDirector
getSupportedMetadataMap
in class DataAccessAdapter
null
.MetadataMap
public LayerMetadataMap getSupportedLayerMetadataMap()
DataAccessAdapter
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.getSupportedLayerMetadataMap
in interface DataDirector
getSupportedLayerMetadataMap
in class DataAccessAdapter
null
.LayerMetadataMap
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |