oracle.adf.view.faces.bi.model
Class ActiveDataModelDecorator

java.lang.Object
  oracle.adf.view.faces.bi.model.DataModel
      oracle.adf.view.faces.bi.model.ActiveDataModelDecorator

All Implemented Interfaces:

ActiveDataModel, oracle.adfinternal.view.faces.bi.activedata.DVTEncoderContext

public abstract class ActiveDataModelDecorator
extends DataModel
implements ActiveDataModel, oracle.adfinternal.view.faces.bi.activedata.DVTEncoderContext

Since:

release specific (what release of product did this appear in) Users of this class are able to enable active data with the existing data models inside their JSF pages. This class will wrap the existing data model in the page and add additional active data functionality in the decorator itself. Users then replace the binding in the page to point to the decorator Example usage: original page:

replace with :

where activeModelDecorator is a managed bean subclassing the ActiveDataModelDecorator subclasses will look something like this: public class MyDecorator extends ActiveDataModelModelDecorator

{

public DataModel getModel()

{

return _dataModel;

}

public ActiveDataModel getActiveDataModel()

{

return _activeDataModel;

}

}

See Also:

getActiveDataModel()

Nested Class Summary

Nested classes/interfaces inherited from class oracle.adf.view.faces.bi.model.DataModel

DataModel.DataValueMap, DataModel.HeaderValueMap

Nested classes/interfaces inherited from interface oracle.adf.view.rich.model.ActiveDataModel

ActiveDataModel.ActiveDataPolicy

Field Summary

Fields inherited from class oracle.adf.view.faces.bi.model.DataModel

dataDirector, dataDirectorFactory, INITIAL_DATA_COLUMN, INITIAL_DATA_ROW, INITIAL_EDGE_SIZE, LOGGERCLASS, m_adsType, m_cellIndex, m_cellKey, m_dataAnnotationSupported, m_dataFormattedSupported, m_dataGroupsortSupported, m_dataIstotalSupported, m_dataNameSupported, m_dataRatioSupported, m_dataSupported, m_dataTypeSupported, m_dataUnformattedSupported, m_dataViewFormatSupported, m_dataViewStyleSupported, m_layerMetaCanpivotSupported, m_layerMetaCurdrillpathSupported, m_layerMetaCurdrilltargetSupported, m_layerMetaDisplaynameSupported, m_layermetaDrillPathsSupported, m_layerMetaDrillpathsSupported, m_layerMetaDrillstateSupported, m_layerMetaHierarchicalSupported, m_layerMetaLonglabelPluralSupported, m_layerMetaLongLabelSupported, m_layermetaMeasureSupported, m_layerMetaMediumLabelSupported, m_layerMetaNameSupported, m_layerMetaShortlabelPluralSupported, m_layerMetaShortLabelSupported, m_layermetaViewStyleSupported, m_layerMetaViewstyleSupported, m_metaBlockSupported, m_metaChildcountSupported, m_metaCurdrillpathSupported, m_metaCurdrilltargetSupported, m_metaDatatypeSupported, m_metaDatespanSupported, m_metaDateSpanSupported, m_metaDateSupported, m_metaDisplaynameSupported, m_metaDrillParentDatespanSupported, m_metaDrillParentDateSpanSupported, m_metaDrillParentDateSupported, m_metaDrillParentLonglabelSupported, m_metaDrillParentMediumlabelSupported, m_metaDrillParentShortlabelSupported, m_metaDrillPathsSupported, m_metaDrillSupported, m_metaFormatSupported, m_metaHierarchySupported, m_metaIndentSupported, m_metaIstotalSupported, m_metaIsTotalSupported, m_metaLevelLabelSupported, m_metaLevelNameSupported, m_metaLevelSupported, m_metaLongLabelSupported, m_metaMediumLabelSupported, m_metaParentSupported, m_metaPositionSupported, m_metaQueryparentSupported, m_metaRelhierinfoSupported, m_metaRelIndentSupported, m_metaShortLabelSupported, m_metaUniqueParentSupported, m_metaUniqueValueSupported, m_metaValueSupported, m_metaViewStyleSupported

Fields inherited from interface oracle.adfinternal.view.faces.bi.activedata.DVTEncoderContext

ADS_LOGGER_PROVIDER, CUBIC_MODEL_INFO_PROVIDER, MAP_MODEL_INFO_PROVIDER, MODEL_INFO_PROVIDER

Constructor Summary

ActiveDataModelDecorator()

Method Summary

abstract ActiveDataModel	getActiveDataModel() returns the ActiveDataModel implementation
ActiveDataModel.ActiveDataPolicy	getActiveDataPolicy() always return ActiveDataPolicy.ACTIVE
int	getADSType() Gets the type of ADS renderer to use when displaying a Flash graph/gauge.
java.lang.Object	getCellData() Gets the current cell value identified by the current cell index or key.
java.lang.Object	getCellData(CellIndex cellIndex) Gets the cell value identified by the specified cell index.
CellIndex	getCellIndex() Returns the cellIndex of the current cell, or null if currency has not been established.
CellKey	getCellKey() Returns the cellKey of the current cell, or null if currency has not been established.
CellKey	getCellKey(CellIndex cellIndex) Returns the cellKey corresponding to the specified CellIndex
int	getColumnCount()
int	getCurrentChangeCount() Returns the current monotonically increasing change count for this ActiveDataModel This change count is used by the UI components to maintain read consistency between model data fetches and the active data updates.
DataAccess	getDataAccess() Get the data access for this view.
DataDirector	getDataDirector() Retrieves the data director for this view.
DataMap	getDataMap()
DataSource	getDataSource() Retrieves the data source for this view.
java.util.Map<java.lang.String,java.lang.Object>	getEncoderEnvironment()
LayerMetadataMap	getLayerMetadataMap(int edge)
MetadataMap	getMetadataMap(int edge)
abstract DataModel	getModel() This method returns the wrapped DataModel.
int	getRowCount()
boolean	isCellAvailable()
boolean	isCellAvailable(CellIndex cellIndex)
boolean	isDataAnnotationSupported()
boolean	isDataFormattedSupported()
boolean	isDataGroupsortSupported()
boolean	isDataIstotalSupported()
boolean	isDataNameSupported()
boolean	isDataRatioSupported()
boolean	isDataTypeSupported()
boolean	isDataUnformattedSupported()
boolean	isDataViewFormatSupported()
boolean	isDataViewStyleSupported()
boolean	isLayerMetaCurdrillpathSupported()
boolean	isLayerMetaCurdrilltargetSupported()
boolean	isLayerMetaDisplaynameSupported()
boolean	isLayerMetaDrillPathsSupported()
boolean	isLayerMetaDrillstateSupported()
boolean	isLayerMetaHierarchicalLabelSupported()
boolean	isLayerMetaLongLabelSupported()
boolean	isLayerMetaMeasureSupported()
boolean	isLayerMetaMediumLabelSupported()
boolean	isLayerMetaNameCanpivotSupported()
boolean	isLayerMetaNameDrillpathsSupported()
boolean	isLayerMetaNameLonglabelPluralSupported()
boolean	isLayerMetaNameSupported()
boolean	isLayerMetaShortlabelPluralSupported()
boolean	isLayerMetaShortLabelSupported()
boolean	isLayerMetaViewstyleSupported()
boolean	isLayerMetaViewStyleSupported()
boolean	isMetadataBlockSupported()
boolean	isMetadataChildcountSupported()
boolean	isMetadataCurdrillpathSupported()
boolean	isMetadataCurdrilltargetSupported()
boolean	isMetadataDatatypeSupported()
boolean	isMetadataDatespanSupported()
boolean	isMetadataDateSpanSupported()
boolean	isMetadataDateSupported()
boolean	isMetadataDisplaynameSupported()
boolean	isMetadataDrillParentDatespanSupported()
boolean	isMetadataDrillParentDateSpanSupported()
boolean	isMetadataDrillParentDateSupported()
boolean	isMetadataDrillParentLonglabelSupported()
boolean	isMetadataDrillParentMediumlabelSupported()
boolean	isMetadataDrillParentShortlabelSupported()
boolean	isMetadataDrillPathsSupported()
boolean	isMetadataDrillSupported()
boolean	isMetadataFormatSupported()
boolean	isMetadataHierarchySupported()
boolean	isMetadataIndentSupported()
boolean	isMetadataIstotalSupported()
boolean	isMetadataIsTotalSupported()
boolean	isMetadataLevelLabelSupported()
boolean	isMetadataLevelNameSupported()
boolean	isMetadataLevelSupported()
boolean	isMetadataLongLabelSupported()
boolean	isMetadataMediumLabelSupported()
boolean	isMetadataParentSupported()
boolean	isMetadataPositionSupported()
boolean	isMetadataQueryparentSupported()
boolean	isMetadataRelhierinfoSupported()
boolean	isMetadataRelIndentSupported()
boolean	isMetadataShortLabelSupported()
boolean	isMetadataUniqueParentSupported()
boolean	isMetadataUniqueValueSupported()
boolean	isMetadataValueSupported()
boolean	isMetadataViewStyleSupported()
boolean	isRangeLocallyAvailable(DataCellIndex cellIndex, int rowCount, int columnCount) Check if a range is locally available starting from a row/column index
void	setADSType(int type) Sets the type of ADS renderer to use when displaying a Flash graph/gauge.
void	setCellIndex(CellIndex cellIndex)
void	setCellKey(CellKey cellKey)
void	setDataDirector(DataDirector dd) Specifies the data director for this view.
void	setDataSource(DataSource ds)
void	setLayerMetaCanpivotSupported(boolean supported)
void	setLayerMetaCurdrillpathSupported(boolean supported)
void	setLayerMetaCurdrilltargetSupported(boolean supported)
void	setLayerMetaDisplaynameSupported(boolean supported)
void	setLayerMetaDrillpathsSupported(boolean supported)
void	setLayerMetaDrillstateSupported(boolean supported)
void	setLayerMetaHierarchicalSupported(boolean supported)
void	setLayerMetaLonglabelPluralSupported(boolean supported)
void	setLayerMetaLongLabelSupported(boolean supported)
void	setLayerMetaMeasureSupported(boolean supported)
void	setLayerMetaMediumLabelSupported(boolean supported)
void	setLayerMetaNameSupported(boolean supported)
void	setLayerMetaShortlabelPluralSupported(boolean supported)
void	setLayerMetaShortLabelSupported(boolean supported)
void	setLayerMetaViewstyleSupported(boolean supported)
void	setLayerMetaViewStyleSupported(boolean supported)
void	setMetadataBlockSupported(boolean supported)
void	setMetadataChildcountSupported(boolean supported)
void	setMetadataCurdrillpathSupported(boolean supported)
void	setMetadataCurdrilltargetSupported(boolean supported)
void	setMetadataDatatypeSupported(boolean supported)
void	setMetadataDatespanSupported(boolean supported)
void	setMetadataDateSpanSupported(boolean supported)
void	setMetadataDateSupported(boolean supported)
void	setMetadataDisplaynameSupported(boolean supported)
void	setMetadataDrillParentDatespanSupported(boolean supported)
void	setMetadataDrillParentDateSpanSupported(boolean supported)
void	setMetadataDrillParentDateSupported(boolean supported)
void	setMetadataDrillParentLonglabelSupported(boolean supported)
void	setMetadataDrillParentMediumlabelSupported(boolean supported)
void	setMetadataDrillParentShortlabelSupported(boolean supported)
void	setMetadataDrillPathsSupported(boolean supported)
void	setMetadataDrillSupported(boolean supported)
void	setMetadataFormatSupported(boolean supported)
void	setMetadataHierarchySupported(boolean supported)
void	setMetadataIstotalSupported(boolean supported)
void	setMetadataIsTotalSupported(boolean supported)
void	setMetadataLevelLabelSupported(boolean supported)
void	setMetadataLevelNameSupported(boolean supported)
void	setMetadataLevelSupported(boolean supported)
void	setMetadataMediumLabelSupported(boolean supported)
void	setMetadataParentSupported(boolean supported)
void	setMetadataPositionSupported(boolean supported)
void	setMetadataQueryparentSupported(boolean supported)
void	setMetadataRelhierinfoSupported(boolean supported)
void	setMetadataRelIndentSupported(boolean supported)
void	setMetadataShortLabelSupported(boolean supported)
void	setMetadataUniqueParentSupported(boolean supported)
void	setMetadataUniqueValueSupported(boolean supported)
void	setMetadataViewStyleSupported(boolean supported)
void	startActiveData(java.util.Collection<java.lang.Object> rowKeys, int startChangeCount, oracle.adf.view.rich.event.ActiveDataListener listener) Called by the DataUpdateManager to notify the ActiveDataModel to start delivering change notifications
void	stopActiveData(java.util.Collection<java.lang.Object> rowKeys, oracle.adf.view.rich.event.ActiveDataListener listener) Called by the DataUpdateManager to notify the ActiveDataModel to stop delivering change notifications

Methods inherited from class oracle.adf.view.faces.bi.model.DataModel

createDefaultDataSource, setDataAnnotationSupported, setDataFormattedSupported, setDataGroupsortSupported, setDataIstotalSupported, setDataNameSupported, setDataRatioSupported, setDataTypeSupported, setDataUnformattedSupported, setDataViewFormatSupported, setDataViewStyleSupported, setLayerMetaDrillPathsSupported, setMetadataIndentSupported, setMetadataLongLabelSupported, setMetadataValueSupported, setSupportedDataLayerFlags

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveDataModelDecorator

public ActiveDataModelDecorator()

Method Detail

getModel

public abstract DataModel getModel()

This method returns the wrapped DataModel.

Returns:

the wrapped DataModel

getActiveDataModel

public abstract ActiveDataModel getActiveDataModel()

returns the ActiveDataModel implementation

Returns:

ActiveDataModel the ActiveDataModel implementation

getActiveDataPolicy

public ActiveDataModel.ActiveDataPolicy getActiveDataPolicy()

always return ActiveDataPolicy.ACTIVE

Specified by:

getActiveDataPolicy in interface ActiveDataModel

Returns:

the active data policy

See Also:

ActiveDataModel.ActiveDataPolicy

startActiveData

public void startActiveData(java.util.Collection<java.lang.Object> rowKeys,
                            int startChangeCount,
                            oracle.adf.view.rich.event.ActiveDataListener listener)

Called by the DataUpdateManager to notify the ActiveDataModel to start delivering change notifications

Specified by:

startActiveData in interface ActiveDataModel

Parameters:

rowKeys - Not used for DVT Graph. Change notifications should be delivered for all rows of the collection.

startChangeCount - Change count to start sending active data from.

listener - ActiveDataListener for the ActiveDataModel to use when notifying the DataUpdateManager of changes

Throws:

java.lang.IllegalStateException - if ActiveDataPolicy is STATIC

java.lang.IllegalArgumentException - if listener is null or the startChangeCount is greater than the current change count.

See Also:

stopActiveData(java.util.Collection, oracle.adf.view.rich.event.ActiveDataListener)

stopActiveData

public void stopActiveData(java.util.Collection<java.lang.Object> rowKeys,
                           oracle.adf.view.rich.event.ActiveDataListener listener)

Called by the DataUpdateManager to notify the ActiveDataModel to stop delivering change notifications

Specified by:

stopActiveData in interface ActiveDataModel

Parameters:

rowKeys - Not used for DVT Graph. Change notifications should be stopped for all rows of the collection

listener - the ActiveDataListener to be removed

Throws:

java.lang.IllegalStateException - If called on an ActiveDataModel that was never started by calling startActiveData

See Also:

startActiveData(java.util.Collection, int, oracle.adf.view.rich.event.ActiveDataListener)

getCurrentChangeCount

public int getCurrentChangeCount()

Returns the current monotonically increasing change count for this ActiveDataModel This change count is used by the UI components to maintain read consistency between model data fetches and the active data updates. Cares need to be taken to assure that larger change count means newer data

Specified by:

getCurrentChangeCount in interface ActiveDataModel

Returns:

The current change count

getEncoderEnvironment

public final java.util.Map<java.lang.String,java.lang.Object> getEncoderEnvironment()

Specified by:

getEncoderEnvironment in interface oracle.adfinternal.view.faces.bi.activedata.DVTEncoderContext

setDataSource

public void setDataSource(DataSource ds)

Overrides:

setDataSource in class DataModel

getDataSource

public DataSource getDataSource()

Description copied from class: DataModel

Retrieves the data source for this view.

Overrides:

getDataSource in class DataModel

Returns:

The data source for this view. Returns null if no data source has been specified for this view.

setDataDirector

public void setDataDirector(DataDirector dd)

Description copied from class: DataModel

Specifies the data director for this view. The data director is the part of the data source that manipulates the data. This method sets the maps in the data director.

Overrides:

setDataDirector in class DataModel

Parameters:

dd - A DataDirector implementation that has been initialized.

getDataDirector

public DataDirector getDataDirector()

Description copied from class: DataModel

Retrieves the data director for this view. The data director is the part of the data source that manipulates the data.

Overrides:

getDataDirector in class DataModel

Returns:

The data director for this view.

getDataAccess

public DataAccess getDataAccess()

Description copied from class: DataModel

Get the data access for this view. The data access is the part of the data source that feeds data to the view. It is, essentially, a cursor of data.

Overrides:

getDataAccess in class DataModel

Returns:

The DataAccess for this view. This method can return null if no data access has been specified for this view.

setMetadataMediumLabelSupported

public void setMetadataMediumLabelSupported(boolean supported)

Overrides:

setMetadataMediumLabelSupported in class DataModel

isMetadataMediumLabelSupported

public boolean isMetadataMediumLabelSupported()

Overrides:

isMetadataMediumLabelSupported in class DataModel

setMetadataShortLabelSupported

public void setMetadataShortLabelSupported(boolean supported)

Overrides:

setMetadataShortLabelSupported in class DataModel

isMetadataShortLabelSupported

public boolean isMetadataShortLabelSupported()

Overrides:

isMetadataShortLabelSupported in class DataModel

setMetadataViewStyleSupported

public void setMetadataViewStyleSupported(boolean supported)

Overrides:

setMetadataViewStyleSupported in class DataModel

isMetadataViewStyleSupported

public boolean isMetadataViewStyleSupported()

Overrides:

isMetadataViewStyleSupported in class DataModel

isMetadataLongLabelSupported

public boolean isMetadataLongLabelSupported()

Overrides:

isMetadataLongLabelSupported in class DataModel

isMetadataValueSupported

public boolean isMetadataValueSupported()

Overrides:

isMetadataValueSupported in class DataModel

Returns:

true if METADATA_VALUE is supported, else false

setMetadataDrillSupported

public void setMetadataDrillSupported(boolean supported)

Overrides:

setMetadataDrillSupported in class DataModel

isMetadataDrillSupported

public boolean isMetadataDrillSupported()

Overrides:

isMetadataDrillSupported in class DataModel

Returns:

true if METADATA_DRILLSTATE is supported, else false

setMetadataUniqueValueSupported

public void setMetadataUniqueValueSupported(boolean supported)

Overrides:

setMetadataUniqueValueSupported in class DataModel

isMetadataUniqueValueSupported

public boolean isMetadataUniqueValueSupported()

Overrides:

isMetadataUniqueValueSupported in class DataModel

Returns:

true if METADATA_UNIQUE_VALUE is supported, else false

setMetadataDisplaynameSupported

public void setMetadataDisplaynameSupported(boolean supported)

Overrides:

setMetadataDisplaynameSupported in class DataModel

isMetadataDisplaynameSupported

public boolean isMetadataDisplaynameSupported()

Overrides:

isMetadataDisplaynameSupported in class DataModel

Returns:

true if METADATA_DISPLAYNAME is supported, else false

setMetadataFormatSupported

public void setMetadataFormatSupported(boolean supported)

Overrides:

setMetadataFormatSupported in class DataModel

isMetadataFormatSupported

public boolean isMetadataFormatSupported()

Overrides:

isMetadataFormatSupported in class DataModel

Returns:

true if METADATA_FORMAT is supported, else false

setMetadataRelhierinfoSupported

public void setMetadataRelhierinfoSupported(boolean supported)

Overrides:

setMetadataRelhierinfoSupported in class DataModel

isMetadataRelhierinfoSupported

public boolean isMetadataRelhierinfoSupported()

Overrides:

isMetadataRelhierinfoSupported in class DataModel

Returns:

true if METADATA_RELHIERINFO is supported, else false

setMetadataPositionSupported

public void setMetadataPositionSupported(boolean supported)

Overrides:

setMetadataPositionSupported in class DataModel

isMetadataPositionSupported

public boolean isMetadataPositionSupported()

Overrides:

isMetadataPositionSupported in class DataModel

Returns:

true if METADATA_POSITION is supported, else false

setMetadataParentSupported

public void setMetadataParentSupported(boolean supported)

Overrides:

setMetadataParentSupported in class DataModel

isMetadataParentSupported

public boolean isMetadataParentSupported()

Overrides:

isMetadataParentSupported in class DataModel

Returns:

true if METADATA_PARENT is supported, else false

setMetadataUniqueParentSupported

public void setMetadataUniqueParentSupported(boolean supported)

Overrides:

setMetadataUniqueParentSupported in class DataModel

isMetadataUniqueParentSupported

public boolean isMetadataUniqueParentSupported()

Overrides:

isMetadataUniqueParentSupported in class DataModel

Returns:

true if METADATA_UNIQUE_PARENT is supported, else false

setMetadataDrillParentLonglabelSupported

public void setMetadataDrillParentLonglabelSupported(boolean supported)

Overrides:

setMetadataDrillParentLonglabelSupported in class DataModel

isMetadataDrillParentLonglabelSupported

public boolean isMetadataDrillParentLonglabelSupported()

Overrides:

isMetadataDrillParentLonglabelSupported in class DataModel

Returns:

true if METADATA_DRILL_PARENT_LONGLABEL is supported, else false

setMetadataDrillParentMediumlabelSupported

public void setMetadataDrillParentMediumlabelSupported(boolean supported)

Overrides:

setMetadataDrillParentMediumlabelSupported in class DataModel

isMetadataDrillParentMediumlabelSupported

public boolean isMetadataDrillParentMediumlabelSupported()

Overrides:

isMetadataDrillParentMediumlabelSupported in class DataModel

Returns:

true if METADATA_DRILL_PARENT_MEDIUMLABEL is supported, else false

setMetadataDrillParentShortlabelSupported

public void setMetadataDrillParentShortlabelSupported(boolean supported)

Overrides:

setMetadataDrillParentShortlabelSupported in class DataModel

isMetadataDrillParentShortlabelSupported

public boolean isMetadataDrillParentShortlabelSupported()

Overrides:

isMetadataDrillParentShortlabelSupported in class DataModel

Returns:

true if METADATA_DRILL_PARENT_SHORTLABEL is supported, else false

setMetadataDrillParentDatespanSupported

public void setMetadataDrillParentDatespanSupported(boolean supported)

Overrides:

setMetadataDrillParentDatespanSupported in class DataModel

isMetadataDrillParentDatespanSupported

public boolean isMetadataDrillParentDatespanSupported()

Overrides:

isMetadataDrillParentDatespanSupported in class DataModel

Returns:

true if METADATA_DRILL_PARENT_DATESPAN is supported, else false

setMetadataLevelSupported

public void setMetadataLevelSupported(boolean supported)

Overrides:

setMetadataLevelSupported in class DataModel

isMetadataLevelSupported

public boolean isMetadataLevelSupported()

Overrides:

isMetadataLevelSupported in class DataModel

Returns:

true if METADATA_LEVEL is supported, else false

setMetadataLevelLabelSupported

public void setMetadataLevelLabelSupported(boolean supported)

Overrides:

setMetadataLevelLabelSupported in class DataModel

isMetadataLevelLabelSupported

public boolean isMetadataLevelLabelSupported()

Overrides:

isMetadataLevelLabelSupported in class DataModel

Returns:

true if METADATA_LEVEL_LABEL is supported, else false

setMetadataLevelNameSupported

public void setMetadataLevelNameSupported(boolean supported)

Overrides:

setMetadataLevelNameSupported in class DataModel

isMetadataLevelNameSupported

public boolean isMetadataLevelNameSupported()

Overrides:

isMetadataLevelNameSupported in class DataModel

Returns:

true if METADATA_LEVEL_NAME is supported, else false

setMetadataDatespanSupported

public void setMetadataDatespanSupported(boolean supported)

Overrides:

setMetadataDatespanSupported in class DataModel

isMetadataDatespanSupported

public boolean isMetadataDatespanSupported()

Overrides:

isMetadataDatespanSupported in class DataModel

Returns:

true if METADATA_DATESPAN is supported, else false

setMetadataCurdrillpathSupported

public void setMetadataCurdrillpathSupported(boolean supported)

Overrides:

setMetadataCurdrillpathSupported in class DataModel

isMetadataCurdrillpathSupported

public boolean isMetadataCurdrillpathSupported()

Overrides:

isMetadataCurdrillpathSupported in class DataModel

Returns:

true if METADATA_CURDRILLPATH is supported, else false

setMetadataCurdrilltargetSupported

public void setMetadataCurdrilltargetSupported(boolean supported)

Overrides:

setMetadataCurdrilltargetSupported in class DataModel

isMetadataCurdrilltargetSupported

public boolean isMetadataCurdrilltargetSupported()

Overrides:

isMetadataCurdrilltargetSupported in class DataModel

Returns:

true if METADATA_CURDRILLTARGET is supported, else false

setMetadataDatatypeSupported

public void setMetadataDatatypeSupported(boolean supported)

Overrides:

setMetadataDatatypeSupported in class DataModel

isMetadataDatatypeSupported

public boolean isMetadataDatatypeSupported()

Overrides:

isMetadataDatatypeSupported in class DataModel

Returns:

true if METADATA_DATATYPE is supported, else false

setMetadataIstotalSupported

public void setMetadataIstotalSupported(boolean supported)

Overrides:

setMetadataIstotalSupported in class DataModel

isMetadataIstotalSupported

public boolean isMetadataIstotalSupported()

Overrides:

isMetadataIstotalSupported in class DataModel

Returns:

true if METADATA_ISTOTAL is supported, else false

setMetadataHierarchySupported

public void setMetadataHierarchySupported(boolean supported)

Overrides:

setMetadataHierarchySupported in class DataModel

isMetadataHierarchySupported

public boolean isMetadataHierarchySupported()

Overrides:

isMetadataHierarchySupported in class DataModel

Returns:

true if METADATA_HIERARCHY is supported, else false

setMetadataBlockSupported

public void setMetadataBlockSupported(boolean supported)

Overrides:

setMetadataBlockSupported in class DataModel

isMetadataBlockSupported

public boolean isMetadataBlockSupported()

Overrides:

isMetadataBlockSupported in class DataModel

Returns:

true if METADATA_BLOCK is supported, else false

setMetadataQueryparentSupported

public void setMetadataQueryparentSupported(boolean supported)

Overrides:

setMetadataQueryparentSupported in class DataModel

isMetadataQueryparentSupported

public boolean isMetadataQueryparentSupported()

Overrides:

isMetadataQueryparentSupported in class DataModel

Returns:

true if METADATA_QUERYPARENT is supported, else false

setMetadataChildcountSupported

public void setMetadataChildcountSupported(boolean supported)

Overrides:

setMetadataChildcountSupported in class DataModel

isMetadataChildcountSupported

public boolean isMetadataChildcountSupported()

Overrides:

isMetadataChildcountSupported in class DataModel

Returns:

true if METADATA_CHILDCOUNT is supported, else false

setLayerMetaLongLabelSupported

public void setLayerMetaLongLabelSupported(boolean supported)

Overrides:

setLayerMetaLongLabelSupported in class DataModel

isLayerMetaLongLabelSupported

public boolean isLayerMetaLongLabelSupported()

Overrides:

isLayerMetaLongLabelSupported in class DataModel

setLayerMetaMediumLabelSupported

public void setLayerMetaMediumLabelSupported(boolean supported)

Overrides:

setLayerMetaMediumLabelSupported in class DataModel

isLayerMetaMediumLabelSupported

public boolean isLayerMetaMediumLabelSupported()

Overrides:

isLayerMetaMediumLabelSupported in class DataModel

setLayerMetaShortLabelSupported

public void setLayerMetaShortLabelSupported(boolean supported)

Overrides:

setLayerMetaShortLabelSupported in class DataModel

isLayerMetaShortLabelSupported

public boolean isLayerMetaShortLabelSupported()

Overrides:

isLayerMetaShortLabelSupported in class DataModel

setLayerMetaNameSupported

public void setLayerMetaNameSupported(boolean supported)

Overrides:

setLayerMetaNameSupported in class DataModel

isLayerMetaNameSupported

public boolean isLayerMetaNameSupported()

Overrides:

isLayerMetaNameSupported in class DataModel

isDataGroupsortSupported

public boolean isDataGroupsortSupported()

Overrides:

isDataGroupsortSupported in class DataModel

isDataUnformattedSupported

public boolean isDataUnformattedSupported()

Overrides:

isDataUnformattedSupported in class DataModel

isDataFormattedSupported

public boolean isDataFormattedSupported()

Overrides:

isDataFormattedSupported in class DataModel

Returns:

true if DATA_FORMATTED is supported, else false

isDataTypeSupported

public boolean isDataTypeSupported()

Overrides:

isDataTypeSupported in class DataModel

Returns:

true if DATA_TYPE is supported, else false

isDataRatioSupported

public boolean isDataRatioSupported()

Overrides:

isDataRatioSupported in class DataModel

Returns:

true if DATA_RATIO is supported, else false

isDataViewStyleSupported

public boolean isDataViewStyleSupported()

Overrides:

isDataViewStyleSupported in class DataModel

Returns:

true if DATA_VIEWSTYLE is supported, else false

isDataViewFormatSupported

public boolean isDataViewFormatSupported()

Overrides:

isDataViewFormatSupported in class DataModel

Returns:

true if DATA_VIEWFORMAT is supported, else false

isDataAnnotationSupported

public boolean isDataAnnotationSupported()

Overrides:

isDataAnnotationSupported in class DataModel

Returns:

true if DATA_ANNOTATION is supported, else false

isDataNameSupported

public boolean isDataNameSupported()

Overrides:

isDataNameSupported in class DataModel

Returns:

true if DATA_NAME is supported, else false

isDataIstotalSupported

public boolean isDataIstotalSupported()

Overrides:

isDataIstotalSupported in class DataModel

Returns:

true if DATA_ISTOTAL is supported, else false

setMetadataRelIndentSupported

public void setMetadataRelIndentSupported(boolean supported)

Overrides:

setMetadataRelIndentSupported in class DataModel

isMetadataRelIndentSupported

public boolean isMetadataRelIndentSupported()

Overrides:

isMetadataRelIndentSupported in class DataModel

setMetadataDrillParentDateSupported

public void setMetadataDrillParentDateSupported(boolean supported)

Overrides:

setMetadataDrillParentDateSupported in class DataModel

isMetadataDrillParentDateSupported

public boolean isMetadataDrillParentDateSupported()

Overrides:

isMetadataDrillParentDateSupported in class DataModel

setMetadataDrillParentDateSpanSupported

public void setMetadataDrillParentDateSpanSupported(boolean supported)

Overrides:

setMetadataDrillParentDateSpanSupported in class DataModel

isMetadataDrillParentDateSpanSupported

public boolean isMetadataDrillParentDateSpanSupported()

Overrides:

isMetadataDrillParentDateSpanSupported in class DataModel

setMetadataIsTotalSupported

public void setMetadataIsTotalSupported(boolean supported)

Overrides:

setMetadataIsTotalSupported in class DataModel

Parameters:

supported - true if METADATA_ISTOTAL is supported, false otherwise

isMetadataIsTotalSupported

public boolean isMetadataIsTotalSupported()

Overrides:

isMetadataIsTotalSupported in class DataModel

Returns:

true if METADATA_ISTOTAL is supported, false otherwise

setMetadataDrillPathsSupported

public void setMetadataDrillPathsSupported(boolean supported)

Overrides:

setMetadataDrillPathsSupported in class DataModel

isMetadataDrillPathsSupported

public boolean isMetadataDrillPathsSupported()

Overrides:

isMetadataDrillPathsSupported in class DataModel

Returns:

true if METADATA_DRILLPATHS is supported, false otherwise

setLayerMetaMeasureSupported

public void setLayerMetaMeasureSupported(boolean supported)

Overrides:

setLayerMetaMeasureSupported in class DataModel

isLayerMetaMeasureSupported

public boolean isLayerMetaMeasureSupported()

Overrides:

isLayerMetaMeasureSupported in class DataModel

isLayerMetaDrillPathsSupported

public boolean isLayerMetaDrillPathsSupported()

Overrides:

isLayerMetaDrillPathsSupported in class DataModel

setLayerMetaDisplaynameSupported

public void setLayerMetaDisplaynameSupported(boolean supported)

Overrides:

setLayerMetaDisplaynameSupported in class DataModel

isLayerMetaDisplaynameSupported

public boolean isLayerMetaDisplaynameSupported()

Overrides:

isLayerMetaDisplaynameSupported in class DataModel

setLayerMetaHierarchicalSupported

public void setLayerMetaHierarchicalSupported(boolean supported)

Overrides:

setLayerMetaHierarchicalSupported in class DataModel

isLayerMetaHierarchicalLabelSupported

public boolean isLayerMetaHierarchicalLabelSupported()

Overrides:

isLayerMetaHierarchicalLabelSupported in class DataModel

setLayerMetaCanpivotSupported

public void setLayerMetaCanpivotSupported(boolean supported)

Overrides:

setLayerMetaCanpivotSupported in class DataModel

isLayerMetaNameCanpivotSupported

public boolean isLayerMetaNameCanpivotSupported()

Overrides:

isLayerMetaNameCanpivotSupported in class DataModel

setLayerMetaLonglabelPluralSupported

public void setLayerMetaLonglabelPluralSupported(boolean supported)

Overrides:

setLayerMetaLonglabelPluralSupported in class DataModel

isLayerMetaNameLonglabelPluralSupported

public boolean isLayerMetaNameLonglabelPluralSupported()

Overrides:

isLayerMetaNameLonglabelPluralSupported in class DataModel

setLayerMetaShortlabelPluralSupported

public void setLayerMetaShortlabelPluralSupported(boolean supported)

Overrides:

setLayerMetaShortlabelPluralSupported in class DataModel

isLayerMetaShortlabelPluralSupported

public boolean isLayerMetaShortlabelPluralSupported()

Overrides:

isLayerMetaShortlabelPluralSupported in class DataModel

setLayerMetaDrillpathsSupported

public void setLayerMetaDrillpathsSupported(boolean supported)

Overrides:

setLayerMetaDrillpathsSupported in class DataModel

isLayerMetaNameDrillpathsSupported

public boolean isLayerMetaNameDrillpathsSupported()

Overrides:

isLayerMetaNameDrillpathsSupported in class DataModel

setLayerMetaCurdrillpathSupported

public void setLayerMetaCurdrillpathSupported(boolean supported)

Overrides:

setLayerMetaCurdrillpathSupported in class DataModel

isLayerMetaCurdrillpathSupported

public boolean isLayerMetaCurdrillpathSupported()

Overrides:

isLayerMetaCurdrillpathSupported in class DataModel

setLayerMetaCurdrilltargetSupported

public void setLayerMetaCurdrilltargetSupported(boolean supported)

Overrides:

setLayerMetaCurdrilltargetSupported in class DataModel

isLayerMetaCurdrilltargetSupported

public boolean isLayerMetaCurdrilltargetSupported()

Overrides:

isLayerMetaCurdrilltargetSupported in class DataModel

setLayerMetaDrillstateSupported

public void setLayerMetaDrillstateSupported(boolean supported)

Overrides:

setLayerMetaDrillstateSupported in class DataModel

isLayerMetaDrillstateSupported

public boolean isLayerMetaDrillstateSupported()

Overrides:

isLayerMetaDrillstateSupported in class DataModel

setLayerMetaViewstyleSupported

public void setLayerMetaViewstyleSupported(boolean supported)

Overrides:

setLayerMetaViewstyleSupported in class DataModel

isLayerMetaViewstyleSupported

public boolean isLayerMetaViewstyleSupported()

Overrides:

isLayerMetaViewstyleSupported in class DataModel

setMetadataDateSupported

public void setMetadataDateSupported(boolean supported)

Overrides:

setMetadataDateSupported in class DataModel

isMetadataDateSupported

public boolean isMetadataDateSupported()

Overrides:

isMetadataDateSupported in class DataModel

setMetadataDateSpanSupported

public void setMetadataDateSpanSupported(boolean supported)

Overrides:

setMetadataDateSpanSupported in class DataModel

isMetadataDateSpanSupported

public boolean isMetadataDateSpanSupported()

Overrides:

isMetadataDateSpanSupported in class DataModel

isMetadataIndentSupported

public boolean isMetadataIndentSupported()

Overrides:

isMetadataIndentSupported in class DataModel

Returns:

true if METADATA_INDENT is supported, else false

setLayerMetaViewStyleSupported

public void setLayerMetaViewStyleSupported(boolean supported)

Overrides:

setLayerMetaViewStyleSupported in class DataModel

isLayerMetaViewStyleSupported

public boolean isLayerMetaViewStyleSupported()

Overrides:

isLayerMetaViewStyleSupported in class DataModel

getDataMap

public DataMap getDataMap()

Specified by:

getDataMap in class DataModel

Returns:

The DataMap.

getMetadataMap

public MetadataMap getMetadataMap(int edge)

Specified by:

getMetadataMap in class DataModel

Parameters:

edge - The edge for which the MetadataMap is needed.

Returns:

The MetadatMap.

getLayerMetadataMap

public LayerMetadataMap getLayerMetadataMap(int edge)

Specified by:

getLayerMetadataMap in class DataModel

Parameters:

edge - The edge for which the LayerMetadataMap is needed.

Returns:

The LayerMetadataMap.

getCellData

public java.lang.Object getCellData()

Description copied from class: DataModel

Gets the current cell value identified by the current cell index or key. The returned value is typically evaluated by EL when the component using this model supports stamping.

Overrides:

getCellData in class DataModel

Returns:

the current cell value

getCellData

public java.lang.Object getCellData(CellIndex cellIndex)

Description copied from class: DataModel

Gets the cell value identified by the specified cell index. The returned value is typically evaluated by EL when the component using this model supports stamping.

Overrides:

getCellData in class DataModel

Parameters:

cellIndex - the cellIndex whose value is desired

Returns:

the current cell value

getRowCount

public int getRowCount()

Overrides:

getRowCount in class DataModel

getColumnCount

public int getColumnCount()

Overrides:

getColumnCount in class DataModel

isCellAvailable

public boolean isCellAvailable()

Overrides:

isCellAvailable in class DataModel

isCellAvailable

public boolean isCellAvailable(CellIndex cellIndex)

Overrides:

isCellAvailable in class DataModel

getCellKey

public CellKey getCellKey(CellIndex cellIndex)

Description copied from class: DataModel

Returns the cellKey corresponding to the specified CellIndex

Overrides:

getCellKey in class DataModel

Parameters:

cellIndex - the cellIndex whose CellKey is desired

Returns:

the cellKey corresponding to the specified CellIndex

getCellKey

public CellKey getCellKey()

Description copied from class: DataModel

Returns the cellKey of the current cell, or null if currency has not been established. CellKeys are safer to use than cellIndexes because cellKeys are unaffected by mutations to the data.

Overrides:

getCellKey in class DataModel

Returns:

the cellKey of the current cell

setCellKey

public void setCellKey(CellKey cellKey)

Overrides:

setCellKey in class DataModel

getCellIndex

public CellIndex getCellIndex()

Description copied from class: DataModel

Returns the cellIndex of the current cell, or null if currency has not been established.

Overrides:

getCellIndex in class DataModel

Returns:

the cellIndex of the current cell

setCellIndex

public void setCellIndex(CellIndex cellIndex)

Overrides:

setCellIndex in class DataModel

getADSType

public int getADSType()

Description copied from class: DataModel

Gets the type of ADS renderer to use when displaying a Flash graph/gauge.

Overrides:

getADSType in class DataModel

Returns:

setADSType

public void setADSType(int type)

Description copied from class: DataModel

Sets the type of ADS renderer to use when displaying a Flash graph/gauge.

Overrides:

setADSType in class DataModel

isRangeLocallyAvailable

public boolean isRangeLocallyAvailable(DataCellIndex cellIndex,
                                       int rowCount,
                                       int columnCount)

Description copied from class: DataModel

Check if a range is locally available starting from a row/column index

Overrides:

isRangeLocallyAvailable in class DataModel

rowCount - number of rows in the range

columnCount - number of rows in the range

Returns:

true if range is locally available