Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.3.0)

E17492-04


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

java.lang.Object
  extended by javax.faces.model.DataModel
      extended by org.apache.myfaces.trinidad.model.CollectionModel
          extended by oracle.adf.view.faces.bi.model.GeoMapDataModel
              extended by oracle.adf.view.faces.bi.model.ActiveGeoMapDataModelDecorator

All Implemented Interfaces:
java.lang.Iterable, ActiveDataModel, oracle.adfinternal.view.faces.bi.activedata.DVTEncoderContext, org.apache.myfaces.trinidad.model.LocalRowKeyIndex, org.apache.myfaces.trinidad.model.RowKeyIndex

public abstract class ActiveGeoMapDataModelDecorator
extends GeoMapDataModel
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:

<dvt:mapPointTheme value="#{the.original.geoMapDataModel}"></dvt:mapPointTheme>

replace with :

<dvt:mapPointTheme value="#{activeModelDecorator}"></dvt:mapPointTheme>

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

{

public GeoMapDataModel getModel()

{

return _geoMapDataModel;

}

public ActiveDataModel getActiveDataModel()

{

return _activeDataModel;

}

}

See Also:
getActiveDataModel()

Nested Class Summary

 

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

 

Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex
org.apache.myfaces.trinidad.model.LocalRowKeyIndex.Confidence, org.apache.myfaces.trinidad.model.LocalRowKeyIndex.LocalCachingStrategy

 

Field Summary

 

Fields inherited from class oracle.adf.view.faces.bi.model.GeoMapDataModel
m_arrList, MATCHMODE_EXACT, MATCHMODE_RELAX

 

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
ActiveGeoMapDataModelDecorator()
           

 

Method Summary
 void calculateMinMaxValues()
           
abstract  ActiveDataModel getActiveDataModel()
          returns the ActiveDataModel implementation
 ActiveDataModel.ActiveDataPolicy getActiveDataPolicy()
          always return ActiveDataPolicy.ACTIVE
 int getAddressMatchMode()
           
 java.util.ArrayList getArrayList()
           
 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.
 java.util.Map<java.lang.String,java.lang.Object> getEncoderEnvironment()
           
 java.lang.String getJoinColumns()
           
 double[] getMaxValues()
           
 double[] getMinValues()
           
abstract  GeoMapDataModel getModel()
          This method returns the wrapped GeoMapDataModel.
 int getRowCount()
           
 java.lang.Object getRowData()
           
 int getRowIndex()
           
 java.lang.Object getRowKey()
           
 java.lang.Object getWrappedData()
           
 boolean isRowAvailable()
           
 void setAddressMatchMode(int mode)
           
 void setJoinColumns(java.lang.String joinColumns)
           
 void setMaxValues(double[] maxValues)
           
 void setMinValues(double[] minValues)
           
 void setRowIndex(int i)
           
 void setRowKey(java.lang.Object object)
           
 void setWrappedData(java.lang.Object object)
           
 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 org.apache.myfaces.trinidad.model.CollectionModel
addRowKeyChangeListener, areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, fireRowKeyChange, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowData, getRowData, getSortCriteria, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, removeRowKeyChangeListener, setSortCriteria

 

Methods inherited from class javax.faces.model.DataModel
addDataModelListener, getDataModelListeners, iterator, removeDataModelListener

 

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

 

Constructor Detail

ActiveGeoMapDataModelDecorator

public ActiveGeoMapDataModelDecorator()

Method Detail

getModel

public abstract GeoMapDataModel getModel()
This method returns the wrapped GeoMapDataModel.
Returns:
the wrapped GeoMapDataModel

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 GeoMap. 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<java.lang.Object>, 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 GeoMap. 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<java.lang.Object>, 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

getRowKey

public java.lang.Object getRowKey()
Specified by:
getRowKey in interface org.apache.myfaces.trinidad.model.RowKeyIndex
Overrides:
getRowKey in class GeoMapDataModel

setRowKey

public void setRowKey(java.lang.Object object)
Specified by:
setRowKey in interface org.apache.myfaces.trinidad.model.RowKeyIndex
Overrides:
setRowKey in class GeoMapDataModel

isRowAvailable

public boolean isRowAvailable()
Specified by:
isRowAvailable in interface org.apache.myfaces.trinidad.model.RowKeyIndex
Overrides:
isRowAvailable in class GeoMapDataModel

getRowCount

public int getRowCount()
Specified by:
getRowCount in interface org.apache.myfaces.trinidad.model.RowKeyIndex
Overrides:
getRowCount in class GeoMapDataModel

getRowData

public java.lang.Object getRowData()
Specified by:
getRowData in interface org.apache.myfaces.trinidad.model.RowKeyIndex
Overrides:
getRowData in class GeoMapDataModel

getRowIndex

public int getRowIndex()
Specified by:
getRowIndex in interface org.apache.myfaces.trinidad.model.RowKeyIndex
Overrides:
getRowIndex in class GeoMapDataModel

setRowIndex

public void setRowIndex(int i)
Specified by:
setRowIndex in interface org.apache.myfaces.trinidad.model.RowKeyIndex
Overrides:
setRowIndex in class GeoMapDataModel

getWrappedData

public java.lang.Object getWrappedData()
Overrides:
getWrappedData in class GeoMapDataModel

getArrayList

public java.util.ArrayList getArrayList()
Overrides:
getArrayList in class GeoMapDataModel

setWrappedData

public void setWrappedData(java.lang.Object object)
Overrides:
setWrappedData in class GeoMapDataModel

setAddressMatchMode

public void setAddressMatchMode(int mode)
Overrides:
setAddressMatchMode in class GeoMapDataModel

getAddressMatchMode

public int getAddressMatchMode()
Overrides:
getAddressMatchMode in class GeoMapDataModel

setMaxValues

public void setMaxValues(double[] maxValues)
Overrides:
setMaxValues in class GeoMapDataModel

getMaxValues

public double[] getMaxValues()
Overrides:
getMaxValues in class GeoMapDataModel

setMinValues

public void setMinValues(double[] minValues)
Overrides:
setMinValues in class GeoMapDataModel

getMinValues

public double[] getMinValues()
Overrides:
getMinValues in class GeoMapDataModel

getJoinColumns

public java.lang.String getJoinColumns()
Overrides:
getJoinColumns in class GeoMapDataModel

setJoinColumns

public void setJoinColumns(java.lang.String joinColumns)
Overrides:
setJoinColumns in class GeoMapDataModel

calculateMinMaxValues

public void calculateMinMaxValues()
Overrides:
calculateMinMaxValues in class GeoMapDataModel

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.3.0)

E17492-04


Copyright © 1997, 2012, Oracle. All rights reserved.