oracle.adf.view.rich.activedata

Class NullDataUpdateManager

java.lang.Object

oracle.adf.view.rich.activedata.DataUpdateManager

oracle.adf.view.rich.activedata.NullDataUpdateManager

public final class NullDataUpdateManager
extends DataUpdateManager

DataUpdateManager subclass that does nothing.

Method Summary

Modifier and Type	Method and Description
Iterator<ActiveDataEvent>	getEventCache(String clientId) Returns all ActiveDataEvents cached for the given UIComponent (registered using registerComponentForPPRAndCacheEvents )
static DataUpdateManager	getInstance()
Iterator<String>	getPartialTargets(javax.faces.context.FacesContext context) Check if the given component is partial target
Set<String>	getRegisteredPPRComponentIds() Returns the set of registered automatic PPR components' id.
Set<ActiveDataModel.ActiveDataPolicy>	getSupportedPolicies() Returns the Set of ActiveDataPolicies supported by this DataUpdateManager.
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.
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.
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.
void	registerSubtrees(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Collection<Object> rowKeys) Register component with the collections identified by the rowKeys.
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.
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.
void	unregisterComponent(javax.faces.context.FacesContext context, String clientId) Unregister the component from the DataUpdateManager
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 oracle.adf.view.rich.activedata.DataUpdateManager

getModelList, getRegisteredEncoder, suspendComponent

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DataUpdateManager getInstance()

getSupportedPolicies

public 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.

Specified by:

getSupportedPolicies in class DataUpdateManager

Returns:

the Set of ActiveDataPolicies supported by this DataUpdateManager.

registerComponentForPPR

public 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.

Specified by:

registerComponentForPPR in class DataUpdateManager

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.

registerComponent

public 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.

Specified by:

registerComponent in class DataUpdateManager

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

See Also:

ActiveDataEncoder

registerSubtrees

public 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

Specified by:

registerSubtrees in class DataUpdateManager

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 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.

Specified by:

startActiveData in class DataUpdateManager

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 void unregisterComponent(javax.faces.context.FacesContext context,
                                String clientId)

Unregister the component from the DataUpdateManager

Specified by:

unregisterComponent in class DataUpdateManager

Parameters:

context - current FacesContext

clientId - UI Component to unregister

Throws:

IllegalArgumentException - if rowKeys is null

unregisterSubtrees

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

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

Specified by:

unregisterSubtrees in class DataUpdateManager

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 Iterator<String> getPartialTargets(javax.faces.context.FacesContext context)

Check if the given component is partial target

Specified by:

getPartialTargets in class DataUpdateManager

Parameters:

context - current FacesContext

Returns:

true if the component is partial target; Otherwise return false

getEventCache

public Iterator<ActiveDataEvent> getEventCache(String clientId)

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

Specified by:

getEventCache in class DataUpdateManager

Parameters:

clientId - of the UIComponent to cache events for

Returns:

ActiveDataEvent cache

registerComponentForPPRAndCacheEvents

public 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.

Specified by:

registerComponentForPPRAndCacheEvents in class DataUpdateManager

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.

reregisterComponentForPPR

public 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.

Specified by:

reregisterComponentForPPR in class DataUpdateManager

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.

getRegisteredPPRComponentIds

public Set<String> getRegisteredPPRComponentIds()

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

Specified by:

getRegisteredPPRComponentIds in class DataUpdateManager

Returns:

The set of registered components' id.