oracle.adf.view.rich.activedata

Class DataUpdateManager

java.lang.Object

oracle.adf.view.rich.activedata.DataUpdateManager

Direct Known Subclasses:

NullDataUpdateManager

public abstract class DataUpdateManager
extends Object

The DataUpdateManager class controls the registration and deregistration of components for both automatic PPR update and for active data

Constructor Summary

Constructors

Constructor and Description
DataUpdateManager()

Method Summary

Modifier and Type	Method and Description
abstract Iterator<ActiveDataEvent>	getEventCache(String clientId) Returns all ActiveDataEvents cached for the given UIComponent (registered using registerComponentForPPRAndCacheEvents )
List<ActiveDataModel>	getModelList() Returns the list of ActiveDataModel intances registered.
abstract Iterator<String>	getPartialTargets(javax.faces.context.FacesContext context) Returns the current set of partial targets needing to be rerendered.
ActiveDataEncoder	getRegisteredEncoder(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model)
abstract Set<String>	getRegisteredPPRComponentIds() Returns the set of registered automatic PPR components' id.
abstract Set<ActiveDataModel.ActiveDataPolicy>	getSupportedPolicies() Returns the Set of ActiveDataPolicies supported by this DataUpdateManager.
abstract void	registerComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model, ActiveDataEncoder encoder) Register active or PPR coomponent's model and encoder.
abstract void	registerComponentForPPR(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model, AutoPPRFilter filter) Registers a component as interested in being automatically re-rendered in the next render phase in response to changes on an ActiveDataModel.
abstract void	registerComponentForPPRAndCacheEvents(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ActiveDataModel model) Registers a component as interested in being automatically re-rendered in the next render phase in response to changes on an ActiveDataModel.
abstract void	registerSubtrees(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Collection<Object> rowKeys) Register component with the collections identified by the rowKeys.
abstract void	reregisterComponentForPPR(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Re-registers a previously registered component for being automatically re-rendered in the next render phase in response to changes on an ActiveDataModel.
abstract void	startActiveData(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, int startChangeCount) Called when a previously registered component is ready to being receiving active data starting from a specified startChangeCount.
boolean	suspendComponent(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, boolean suspend) Suspend Active Data updates for the given component.
abstract void	unregisterComponent(javax.faces.context.FacesContext context, String clientId) Unregister the component from the DataUpdateManager
abstract void	unregisterSubtrees(javax.faces.context.FacesContext context, String clientId, Collection<Object> rowKeys) Unregister component from the collections of the containers identified by the rowKeys

Methods inherited from class java.lang.Object

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

Constructor Detail

DataUpdateManager

public DataUpdateManager()

Method Detail

getSupportedPolicies

public abstract Set<ActiveDataModel.ActiveDataPolicy> getSupportedPolicies()

Returns the Set of ActiveDataPolicies supported by this DataUpdateManager. Components can use this information to determine whether to bother calling any of the other methods of the DataUpdateManager.

Returns:

the Set of ActiveDataPolicies supported by this DataUpdateManager.

registerComponentForPPR

public abstract void registerComponentForPPR(javax.faces.context.FacesContext context,
                                             javax.faces.component.UIComponent component,
                                             ActiveDataModel model,
                                             AutoPPRFilter filter)

Registers a component as interested in being automatically re-rendered in the next render phase in response to changes on an ActiveDataModel.

Parameters:

context - current FacesContext

component - Component interested in being automatically PPR'ed in response to model changes.

model - ActiveDataModel to listen for ActiveDataEvents on

filter - AutoPPRFilter used to determine if ActiveDataEvents generated by the ActiveDataModel should cause the component to be rerendered in the next rendering phase.

reregisterComponentForPPR

public abstract void reregisterComponentForPPR(javax.faces.context.FacesContext context,
                                               javax.faces.component.UIComponent component)

Re-registers a previously registered component for being automatically re-rendered in the next render phase in response to changes on an ActiveDataModel. This method is called to make sure that the component will be registered when it gets validation error.

Parameters:

context - current FacesContext

component - Component previously registered for being automatically PPR'ed in response to model changes.

Throws:

IllegalStateException - if the component has not been previously registered for being automatically re-rendered.

registerComponent

public abstract void registerComponent(javax.faces.context.FacesContext context,
                                       javax.faces.component.UIComponent component,
                                       ActiveDataModel model,
                                       ActiveDataEncoder encoder)

Register active or PPR coomponent's model and encoder.

Parameters:

context - current FacesContext

component - the UI component to be registered

encoder - the ActiveDataEncoder used for encoding the active data generated for the UI component. If this value is null, the component will be registered as PPR component. Otherwise, the component will be registered as active component.

model - Active Data model which will generate active events

Throws:

IllegalStateException - if the component is re-registered with different model

See Also:

ActiveDataEncoder

registerComponentForPPRAndCacheEvents

public abstract void registerComponentForPPRAndCacheEvents(javax.faces.context.FacesContext context,
                                                           javax.faces.component.UIComponent component,
                                                           ActiveDataModel model)

Registers a component as interested in being automatically re-rendered in the next render phase in response to changes on an ActiveDataModel. Also caches any ActiveDataEvents fired by the model. Cached events are typically used by a renderer to only update the portions of the user interface affected by model changes. Cached events are cleared by the renderer at the end of the rendering cycle.

Parameters:

context - current FacesContext

component - Component interested in being automatically PPR'ed in response to model changes.

model - ActiveDataModel to listen for ActiveDataEvents on ActiveDataModel should cause the component to be rerendered in the next rendering phase.

getRegisteredEncoder

public ActiveDataEncoder getRegisteredEncoder(javax.faces.context.FacesContext context,
                                              javax.faces.component.UIComponent component,
                                              ActiveDataModel model)

getEventCache

public abstract Iterator<ActiveDataEvent> getEventCache(String clientId)

Returns all ActiveDataEvents cached for the given UIComponent (registered using registerComponentForPPRAndCacheEvents )

Parameters:

clientId - of the UIComponent to cache events for

Returns:

ActiveDataEvent cache

registerSubtrees

public abstract void registerSubtrees(javax.faces.context.FacesContext context,
                                      javax.faces.component.UIComponent component,
                                      Collection<Object> rowKeys)

Register component with the collections identified by the rowKeys. This method must be called after the component is registered with its model and encoder by using registerComponent

Parameters:

context - current FacesContext

component - the UI component to be registered

rowKeys - the container row keys of collections from which the component is to receive active data events

Throws:

IllegalArgumentException - if rowKeys is null

IllegalStateException - if the component is not registered for its model and encoder

startActiveData

public abstract void startActiveData(javax.faces.context.FacesContext context,
                                     javax.faces.component.UIComponent component,
                                     int startChangeCount)

Called when a previously registered component is ready to being receiving active data starting from a specified startChangeCount. In order to handle error cases, the startChangeCount may be earlier than the changeCount of the most recent events delivered by the ActiveDataModel, however the startChangeCount should never be later than the most recent received changeCount.

Parameters:

context - current FacesContext

component - the UI component to beging receiving active data

startChangeCount - Event change count to start sending active data from.

Throws:

IllegalStateException - if the component is already started or the eventId is later than the most recently delivered eventId

unregisterComponent

public abstract void unregisterComponent(javax.faces.context.FacesContext context,
                                         String clientId)

Unregister the component from the DataUpdateManager

Parameters:

context - current FacesContext

clientId - UI Component to unregister

unregisterSubtrees

public abstract void unregisterSubtrees(javax.faces.context.FacesContext context,
                                        String clientId,
                                        Collection<Object> rowKeys)

Unregister component from the collections of the containers identified by the rowKeys

Parameters:

context - current FacesContext

clientId - UI Component to unregister

rowKeys - the container row keys of collections from which the component has regsitered to receive active data events

Throws:

IllegalArgumentException - if rowKeys is null

getPartialTargets

public abstract Iterator<String> getPartialTargets(javax.faces.context.FacesContext context)

Returns the current set of partial targets needing to be rerendered.

Parameters:

context - current FacesContext

Returns:

An iterator of the partial targets

getModelList

public List<ActiveDataModel> getModelList()

Returns the list of ActiveDataModel intances registered. This is used by FacesBindingRewiringListener to rewire registered ActiveDataModel instances to a new binding object is the current bound one is released.

Returns:

The list of ActiveDataModel intances registered.

getRegisteredPPRComponentIds

public abstract Set<String> getRegisteredPPRComponentIds()

Returns the set of registered automatic PPR components' id. This method should always return a non-null value.

Returns:

The set of registered components' id.

suspendComponent

public boolean suspendComponent(javax.faces.context.FacesContext context,
                                javax.faces.component.UIComponent component,
                                boolean suspend)

Suspend Active Data updates for the given component.

Parameters:

context - current FacesContext

component - the UI component to be suspended

suspend - true to suspend; false to resume normal processing.

Returns:

true if updates are still suspended for this component; false otherwise

Throws:

IllegalStateException - if suspend is false and the component is not currently suspended.