Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


oracle.adf.view.rich.activedata
Class BaseActiveDataModel

java.lang.Object
  extended by oracle.adf.view.rich.activedata.BaseActiveDataModel

All Implemented Interfaces:
ActiveDataModel

public abstract class BaseActiveDataModel
extends java.lang.Object
implements ActiveDataModel

This class takes care of the basic implementation of listener management for the ActiveDataModel interface. Subclassers can deliver events to the registered listeners by calling the fireActiveDataUpdate and fireActiveDataException methods.

See Also:
fireActiveDataUpdate(oracle.adf.view.rich.event.ActiveDataUpdateEvent), fireActiveDataException(oracle.adf.view.rich.event.ActiveDataExceptionEvent)

Nested Class Summary

 

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

 

Constructor Summary
BaseActiveDataModel()
           

 

Method Summary
protected  void fireActiveDataException(ActiveDataExceptionEvent dataExceptionEvent)
          Called by subclasses tp fire the ActiveDataExceptionEvent to all ActiveDataListeners registered on this ActiveDataModel
protected  void fireActiveDataUpdate(ActiveDataUpdateEvent dataUpdateEvent)
          Called by subclass to fire the ActiveDataUpdateEvent to all the ActiveDataListeners registered on this ActiveDataModel
 ActiveDataModel.ActiveDataPolicy getActiveDataPolicy()
          Return the active data policy of the model
abstract  int getCurrentChangeCount()
          Returns the current monotonically increasing change count for this ActiveDataModel
protected abstract  void startActiveData(java.util.Collection<java.lang.Object> rowKeys, int startChangeCount)
          Start active data for the specified rowKeys and from teh startChangeCount
 void startActiveData(java.util.Collection<java.lang.Object> rowKeys, int startChangeCount, ActiveDataListener listener)
          Called by the DataUpdateManager to notify the ActiveDataModel to start delivering change notifications for the collections of the containers identified by the rowKeys
protected abstract  void stopActiveData(java.util.Collection<java.lang.Object> rowKeys)
          Stop the active data for the specified rowKeys
 void stopActiveData(java.util.Collection<java.lang.Object> rowKeys, ActiveDataListener listener)
          Called by the DataUpdateManager to notify the ActiveDataModel to stop delivering change notifications for the collections of the container identified by the given rowKeys

 

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

 

Constructor Detail

BaseActiveDataModel

public BaseActiveDataModel()

Method Detail

getActiveDataPolicy

public ActiveDataModel.ActiveDataPolicy getActiveDataPolicy()
Return the active data policy of the model
Specified by:
getActiveDataPolicy in interface ActiveDataModel
Returns:
the active data policy of the model
See Also:
ActiveDataPolicy

startActiveData

public final void startActiveData(java.util.Collection<java.lang.Object> rowKeys,
                                  int startChangeCount,
                                  ActiveDataListener listener)
Called by the DataUpdateManager to notify the ActiveDataModel to start delivering change notifications for the collections of the containers identified by the rowKeys
Specified by:
startActiveData in interface ActiveDataModel
Parameters:
rowKeys - the container row keys of the collection, from which the ActiveDataListener receives active events. Pass null or empty collection for for root collection.
startChangeCount - Change count to start sending active data from.
listener - ActiveDataListener for the ActiceDataModel 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)

startActiveData

protected abstract void startActiveData(java.util.Collection<java.lang.Object> rowKeys,
                                        int startChangeCount)
Start active data for the specified rowKeys and from teh startChangeCount
Parameters:
rowKeys - the container row keys of the collections, from which the ActiveDataListener receives active events. Pass null or empty collection for for root collection.
startChangeCount - Change count to start sending active data from.

stopActiveData

public final void stopActiveData(java.util.Collection<java.lang.Object> rowKeys,
                                 ActiveDataListener listener)
Called by the DataUpdateManager to notify the ActiveDataModel to stop delivering change notifications for the collections of the container identified by the given rowKeys
Specified by:
stopActiveData in interface ActiveDataModel
Parameters:
rowKeys - the container row keys of the collections, from which the ActiveDataListener receives active events. Pass null or empty collection for for root collection.
listener - the ActiveDataListener to be removed ActiveDataListener receives active events. Pass null for root collection.
Throws:
java.lang.IllegalArgumentException - 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)

stopActiveData

protected abstract void stopActiveData(java.util.Collection<java.lang.Object> rowKeys)
Stop the active data for the specified rowKeys
Parameters:
rowKeys - the container row keys of the collections, from which the ActiveDataListener receives active events. Pass null or empty collection for for root collection.

getCurrentChangeCount

public abstract int getCurrentChangeCount()
Returns the current monotonically increasing change count for this ActiveDataModel
Specified by:
getCurrentChangeCount in interface ActiveDataModel
Returns:
The current change count

fireActiveDataUpdate

protected final void fireActiveDataUpdate(ActiveDataUpdateEvent dataUpdateEvent)
Called by subclass to fire the ActiveDataUpdateEvent to all the ActiveDataListeners registered on this ActiveDataModel
Parameters:
dataUpdateEvent - the event to be fired

fireActiveDataException

protected final void fireActiveDataException(ActiveDataExceptionEvent dataExceptionEvent)
Called by subclasses tp fire the ActiveDataExceptionEvent to all ActiveDataListeners registered on this ActiveDataModel
Parameters:
dataExceptionEvent - the exception event to be fired

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-06


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.