Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1)

E12063-03


oracle.dss.util
Class DataAccessAdapter

java.lang.Object
  extended by oracle.dss.util.DataAccessAdapter

All Implemented Interfaces:
CDFDataAccess, DataAccess, DataDirector
Direct Known Subclasses:
LocalDataSource, LocalXMLDataSource, SampleDataSource

public class DataAccessAdapter
extends java.lang.Object
implements DataAccess, DataDirector

Null implementation of DataAccess and DataDirector interface. Data providers can extend this class and override methods to provide a real implementation of the two interfaces.


Field Summary

 

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

 

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

 

Constructor Summary
DataAccessAdapter()
           

 

Method Summary
 void addDataDirectorListener(DataDirectorListener l)
          Registers a listener to the data source for changes.
 boolean allSlicesFetched(int edge)
          Returns true if all slices the entire given edge have been fetched and are available.
 boolean cancel()
          Cancels the current long-running operation, if possible.
 boolean changeEdgeCurrentHPos(int edge, int[] hPos, int maxLayerSpecified)
          Changes the slice of data, on the specified edge, that is designated as the current slice by using hierarchical addressing.
 boolean changeEdgeCurrentSlice(int edge, int slice)
          Changes the slice, on the specified edge, that is designated as the current slice of data.
 boolean deleteMemberCalc(int edge, int layer, int slice)
          Deletes a calculation from the display based on a member that is located at the specified edge, layer, and slice.
 boolean deleteValueCalc(int row, int column)
          Deletes a calculation at the specified row and column of the body of a data for a view.
 boolean drill(int edge, int layer, int[] slice, int flags)
          Drills in data based on multiple selected members.
 boolean drill(int edge, int layer, int[] slice, java.lang.String pathID, java.lang.String targetID, int flags)
          Drills in the data for multiple members.
 boolean drill(int edge, int layer, int slice, int flags)
          Drills in the data for a single member.
 boolean drill(int edge, int layer, int slice, java.lang.String pathID, java.lang.String targetID, int flags)
          Drills in the data for a single member.
 boolean drillOK(int edge, int layer, int[] slice, int flags)
          Indicates whether the specified drill operation from multiple selected members would be a valid drill.
 boolean drillOK(int edge, int layer, int[] slice, java.lang.String pathID, java.lang.String targetID, int flags)
          Indicates whether the specified drill operation from multiple selected members would be a valid drill.
 boolean drillOK(int edge, int layer, int slice, int flags)
          Indicates whether a drill operation from a single selected member would be legal.
 boolean drillOK(int edge, int layer, int slice, java.lang.String pathID, java.lang.String targetID, int flags)
          Indicates whether a drill operation from a single selected member would be legal.
 boolean dropChanges()
          Clears the QDR overrides in the writeback collection.
 void endGroupEdit()
          Indicates the end of a group of setValue calls.
 int findMember(int edge, int[] hPos, int memberLayer, java.lang.String s, java.lang.String type, int flags)
          Searches a set of child members for the specified value starting at a specified offset.
 int[] findMembers(int edge, int[] hPos, int memberLayer, java.lang.String s, java.lang.String type, int flags)
          Searches a set of child members for the specified value starting at a specified offset, and returns all instances found as an array of slices.
 void fireEvents()
          Fire any pending events to all listeners.
 boolean forceFetch(int[] startSlice, int[] endSlice, int flag)
          Ensures that a block of data has been fetched or computed locally.
 ColumnSortInfo[] getColumnSorts()
          Retrieves sorting information for given layers on a table-style view.
 java.lang.Object[][] getCompatibleDataItemMetadata(java.lang.String[] types, java.lang.String[] idList)
          Return sets of metadata for a list of data items that can be referenced by the underlying query for use in building conditional formatting expressions, etc.
 java.util.List getCorrespondingMemberMetadata(int edge, int layer, java.lang.String[] values, java.lang.String[] types, boolean inDataAccess)
          Returns a List of Object arrays of member metadata corresponding to the given MetadataMap.METADATA_VALUE strings specified in the values parameter.
 java.util.List getCorrespondingMemberMetadata(java.lang.String layerName, java.lang.String[] values, java.lang.String[] types, boolean inDataAccess)
          Returns a List of Object arrays of member metadata corresponding to the given MetadataMap.METADATA_VALUE strings specified in the values parameter.
 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.
 DimensionSortInfo[] getDimensionSorts()
          Retrieves sorting information for given dimensions.
 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.
 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.
 java.lang.Object[] getExpressions()
          Return the entire set of expression tree structures set on this query.
 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.
 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.
 int getMemberLogicalLayer(int edge, int layer, int slice)
          Retrieves the logical layer to which the member at the specified edge, physical layer, and slice location belongs.
 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.
 MemberSortInfo[] getMemberSorts()
          Retrieves the set of member sort information.
 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.
 MetadataMap getMetadataMap(int edge, int layer)
          Retrieves the list of all the types of metadata that callers have requested to be included in the cursors for the specified logical layer.
 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 getProperty(java.lang.String name)
          Gets a property from a DataDirector2 object.
 java.util.Vector getQDRoverrideCollection()
          Retrieves a read-only copy of the QDR overrides in the writeback collection.
 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.
 int getSliceOutlineLayer(int edge, int slice)
          Retrieves the starting logical layer of a specified slice in a specified edge when the Crosstab (along with the DataAccess implementor) is set to return data in outline mode.
 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).
 int[] getSlicesFromQDR(QDRInterface qdr, int[] startSlice, int[] endSlice)
          Returns an array of absolute slice positions in an edge-orderered array (column edge 0, row edge 1, etc.), given a QDR specifying a position in the current cursor.
 SortInfo[] getSorts()
          Retrieves sorting information for given layers on a crosstab-style view.
 StatusInfo getStatus()
          Returns an object that contains progress information (if supported) and contains an enumerated status constant, and a return value if the call has completed successfully and the call returns a value.
 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.util.List getUniqueMemberMetadata(int edge, int layer, java.lang.String[] types, int start, int count)
          Returns an unordered List of Object arrays representing metadata for unique member values across a layer on an edge.
 java.util.List getUniqueMemberMetadata(java.lang.String layerName, java.lang.String[] types, int start, int count)
          Returns an unordered List of Object arrays representing metadata for unique member values across a layer on an edge.
 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.
 boolean insertMemberCalc(int edge, int layer, int slice, int flags, java.lang.Object calc)
          Inserts a calculation into a display based on the member at the specified edge, layer, and slice.
 boolean insertValueCalc(int row, int column, int flags, java.lang.Object calc)
          Inserts a calculation at a specified row and column in the body of a view's data.
 boolean isAutoSubmit()
          Indicates whether automatic submission is set for cell editing.
 boolean isCancelable()
          Indicates whether this DataDirector implementor allows views to cancel an operation that takes a long time.
 boolean isFetched(int[] startSlice, int[] endSlice, int flag)
          Indicates whether a block of data has been fully computed or processed locally.
 boolean isMemberExtentComplete(int edge, int layer, int slice)
          Determines if 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), has been completely calculated.
 boolean isOutline()
          Indicates whether data is provided in outline form or inline form.
 boolean pivot(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags)
          Pivots or swaps data.
 int pivotCheck(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags)
          Indicates whether the specified pivot operation would be valid for the current data layout.
 boolean pivotOK(int fromEdge, int toEdge, int fromLayer, int toLayer, int flags)
          Indicates whether the specified pivot operation would be valid for the current data layout.
 boolean redoEdit()
          Performs a redo of the latest undo action.
 boolean refresh()
          Refreshes data and fires a DataChangedEvent to all registered listeners.
 void release()
          Informs the implementor that the caller no longer needs this DataAccess reference.
 void removeDataDirectorListener(DataDirectorListener l)
          Removes a listener from the data source.
 boolean reorder(int edge, int fromLayer, int toLayer, int flags)
          Reorders the layers (that is, columns) of a Table object.
 boolean revalidate()
          Rebuilds (that is, reruns) a query, refreshes the data cache, and fires a DataChangedEvent.
 void setAutoSubmit(boolean bValue)
          Specifies that the QDR override in the writeback collection for a cell will be submitted automatically as soon as it is entered.
 boolean setColumnSorts(ColumnSortInfo[] sortInfo)
          Allows sorting by dimension items on a table-style view.
 void setDataMap(DataMap map, int sizeRow, int sizeColumn)
          Specifies the types of data to provide in a data cursor.
 boolean setDimensionSorts(DimensionSortInfo[] dimensionSortInfo)
          Allows sorting by N dimensions, with each dimension optionally sorted by a series of criteria including measure, name, attribute, hierarchy, etc.
 java.lang.String[] setExpressions(java.lang.Object[] expressions)
          Set the entire set of Boolean expressions this query should assign DataMap constants for and be able to evaluate for the session.
 void setLayerMetadata(int edge, int layer, java.lang.String type, java.lang.Object value)
          Sets a piece of metadata for a logical layer that is found at a specified edge, logical layer and LayerMetadataMap type.
 void setManualUpdate()
          Batches DataDirector operations.
 boolean setMemberSorts(MemberSortInfo[] memberSortInfo)
          Specifies a set of member sorts for N dimensions.
 void setMetadataMap(int edge, int layer, MetadataMap map, int size)
          Specifies the types of metadata to provide in the cursors for the specified logical layer.
 void setOutline(boolean outline)
          Specifies whether data is provided to a view in outline form.
 void setProperty(java.lang.String name, java.lang.Object value)
          Sets a property on a DataDirector2 object.
 boolean setSorts(SortInfo[] sortInfo)
          Allows sorting by N dimension items on a crosstab-style view, with each item optionally sorted by its own measure fact/dimension item combinations or by the item text.
 boolean setValue(java.lang.Object data, int row, int col, java.lang.String type)
          Specifies a data value for the specified row and column intersection.
 StatusInfo startExecution()
          Must be called to begin execution on an asynchronous query.
 void startGroupEdit()
          Indicates the start of a group of setValue calls.
 boolean submitChanges()
          Writes the current group of QDR overrides in the writeback collection to the database and flushes the entries in the writeback collection.
 boolean undoEdit()
          Performs an undo of the latest setValue operation.
 void update()
          Processes batched DataDirector operations.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

DataAccessAdapter

public DataAccessAdapter()

Method Detail

getEdgeExtent

public int getEdgeExtent(int edge)
                  throws EdgeOutOfRangeException
Retrieves the total number of slices that are available on the specified edge. The implementation returns 0.
Specified by:
getEdgeExtent in interface CDFDataAccess
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, *

getEdgeSymmetric

public boolean getEdgeSymmetric(int edge)
                         throws EdgeOutOfRangeException
Description copied from interface: CDFDataAccess
Returns true if the edge is completely symmetric (every parent tuple has the same set of children at each layer), or false if not.
Specified by:
getEdgeSymmetric in interface CDFDataAccess
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

getEdgeCount

public int getEdgeCount()
Retrieves the total number of edges in the cursor. Views assume the following: