oracle.adfmf.java.beans

Class ProviderChangeSupport

Object

oracle.adfmf.java.beans.ProviderChangeSupport

public class ProviderChangeSupport
extends Object

This is a utility class that can be used by beans that support bound properties. You can use an instance of this class as a member field of your bean and delegate various work to it. Please note the convenience methods, but more importantly the absences of primitive types like; boolean, float, and double since those are not conducive to being good keys. Boolean due to the only T/F possible states, float and double because of their inherent precision idiosyncrasies (0.0001 vs 0.00011 vs 1.00E-3 vs 1.10E-3, ..)

Constructor Summary

Constructors

Constructor and Description
ProviderChangeSupport(Object source) Constructs a ProviderChangeSupport object.

Method Summary

Modifier and Type	Method and Description
ProviderChangeListener[]	accessDataChangeListeners() Intentionally not using 'get' semantics here, to prevent conflicts with the JSON serialization of this method.
void	addProviderChangeListener(ProviderChangeListener listener) Add a ProviderChangeListener to the listener list.
void	fireProviderChange(ProviderChangeEvent evt) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String providerKey, byte currentRowKey, Object newValue) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String providerKey, char currentRowKey, Object newValue) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String providerKey, int currentRowKey, Object newValue) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String providerKey, long currentRowKey, Object newValue) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String providerKey, Object currentRowKey, Object newValue) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String providerKey, short currentRowKey, Object newValue) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String operation, String providerKey, Object currentRowKey, Object newValue) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String operation, String providerKey, Object currentRowKey, Object newValue, long timestamp) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String operation, String providerKey, String columnAttributeName, String columnAttributeProperty, Object newValue) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderChange(String operation, String providerKey, String columnAttributeName, String columnAttributeProperty, Object newValue, long timestamp) Fire an existing ProviderChangeEvent to any registered listeners.
void	fireProviderCreate(String providerKey, byte newRowKey, Object newValue) Convenience method to notify registered provider listeners that a child element is being added from the provider.
void	fireProviderCreate(String providerKey, char newRowKey, Object newValue) Convenience method to notify registered provider listeners that a child element is being added from the provider.
void	fireProviderCreate(String providerKey, int newRowKey, Object newValue) Convenience method to notify registered provider listeners that a child element is being added from the provider.
void	fireProviderCreate(String providerKey, long newRowKey, Object newValue) Convenience method to notify registered provider listeners that a child element is being added from the provider.
void	fireProviderCreate(String providerKey, Object newRowKey, Object newValue) Convenience method to notify registered provider listeners that a child element is being added from the provider.
void	fireProviderCreate(String providerKey, short newRowKey, Object newValue) Convenience method to notify registered provider listeners that a child element is being added from the provider.
void	fireProviderDelete(String providerKey, byte oldRowKey) Convenience method to notify registered provider listeners that a child element is being removed from the provider.
void	fireProviderDelete(String providerKey, char oldRowKey) Convenience method to notify registered provider listeners that a child element is being removed from the provider.
void	fireProviderDelete(String providerKey, int oldRowKey) Convenience method to notify registered provider listeners that a child element is being removed from the provider.
void	fireProviderDelete(String providerKey, long oldRowKey) Convenience method to notify registered provider listeners that a child element is being removed from the provider.
void	fireProviderDelete(String providerKey, Object oldRowKey) Convenience method to notify registered provider listeners that a child element is being removed from the provider.
void	fireProviderDelete(String providerKey, short oldRowKey) Convenience method to notify registered provider listeners that a child element is being removed from the provider.
void	fireProviderRefresh(String providerKey) Convenience method to notify registered provider listeners that a the providers have changed enough that it would be best to simply purge the children from their caches and re-fetch on the query.
ProviderChangeListener[]	getProviderChangeListeners() Get the registered provider change listeners
boolean	hasListeners() Return true if there are any registered data change listeners
void	removeProviderChangeListener(ProviderChangeListener listener) Remove a ProviderChangeListener from the listener list.

Methods inherited from class Object

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

Constructor Detail

ProviderChangeSupport

public ProviderChangeSupport(Object source)

Constructs a ProviderChangeSupport object.

Parameters:

source - The collection to be given as the source for any events.

Method Detail

accessDataChangeListeners

public ProviderChangeListener[] accessDataChangeListeners()

Intentionally not using 'get' semantics here, to prevent conflicts with the JSON serialization of this method.

Returns:

the current data change listeners

addProviderChangeListener

public void addProviderChangeListener(ProviderChangeListener listener)

Add a ProviderChangeListener to the listener list. The listener is registered for all properties.

Parameters:

listener - The ProviderChangeListener to be added

fireProviderChange

public void fireProviderChange(ProviderChangeEvent evt)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

evt - The ProviderChangeEvent object.

fireProviderChange

public void fireProviderChange(String providerKey,
                               byte currentRowKey,
                               Object newValue)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

providerKey - The programmatic name of the provider that was changed.

currentRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderChange

public void fireProviderChange(String providerKey,
                               char currentRowKey,
                               Object newValue)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

providerKey - The programmatic name of the provider that was changed.

currentRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderChange

public void fireProviderChange(String providerKey,
                               int currentRowKey,
                               Object newValue)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

providerKey - The programmatic name of the provider that was changed.

currentRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderChange

public void fireProviderChange(String providerKey,
                               long currentRowKey,
                               Object newValue)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

providerKey - The programmatic name of the provider that was changed.

currentRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderChange

public void fireProviderChange(String providerKey,
                               Object currentRowKey,
                               Object newValue)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

providerKey - The programmatic name of the provider that was changed.

currentRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderChange

public void fireProviderChange(String providerKey,
                               short currentRowKey,
                               Object newValue)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

providerKey - The programmatic name of the provider that was changed.

currentRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderChange

public void fireProviderChange(String operation,
                               String providerKey,
                               Object currentRowKey,
                               Object newValue)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

operation - associated ProviderChangeEvent operation

providerKey - The programmatic name of the provider that was changed.

currentRowKey - The unique key to access the changed provider

newValue - The new value for the provider

See Also:

ProviderChangeEvent.OPERATION_CREATE, ProviderChangeEvent.OPERATION_DELETE, ProviderChangeEvent.OPERATION_UPDATE

fireProviderChange

public void fireProviderChange(String operation,
                               String providerKey,
                               Object currentRowKey,
                               Object newValue,
                               long timestamp)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

operation - associated ProviderChangeEvent operation

providerKey - The programmatic name of the provider that was changed.

currentRowKey - The unique key to access the changed provider

newValue - The new value for the provider

timestamp - The timestamp associated with the change

See Also:

ProviderChangeEvent.OPERATION_CREATE, ProviderChangeEvent.OPERATION_DELETE, ProviderChangeEvent.OPERATION_UPDATE

fireProviderChange

public void fireProviderChange(String operation,
                               String providerKey,
                               String columnAttributeName,
                               String columnAttributeProperty,
                               Object newValue)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

operation - associated ProviderChangeEvent operation

providerKey - The programmatic name of the provider that was changed.

columnAttributeName - The programmatic attribute name of the attribute that changed

columnAttributeProperty - The programmatic attribute property name of the attribute that changed

newValue - The new value for the provider

See Also:

ProviderChangeEvent.OPERATION_CREATE, ProviderChangeEvent.OPERATION_DELETE, ProviderChangeEvent.OPERATION_UPDATE

fireProviderChange

public void fireProviderChange(String operation,
                               String providerKey,
                               String columnAttributeName,
                               String columnAttributeProperty,
                               Object newValue,
                               long timestamp)

Fire an existing ProviderChangeEvent to any registered listeners. No event is fired if the given event's old and new values are equal and non-null. Please note this will _NOT_ automatically update the container's cache. The container will be notified of the change in one of two ways: 1. As part of the next response to a container-->Java request. 2. As part of the data change flush operation.

Parameters:

operation - associated ProviderChangeEvent operation

providerKey - The programmatic name of the provider that was changed.

columnAttributeName - The programmatic attribute name of the attribute that changed

columnAttributeProperty - The programmatic attribute property name of the attribute that changed

newValue - The new value for the provider

timestamp - The timestamp associated with the change

See Also:

ProviderChangeEvent.OPERATION_CREATE, ProviderChangeEvent.OPERATION_DELETE, ProviderChangeEvent.OPERATION_UPDATE

fireProviderCreate

public void fireProviderCreate(String providerKey,
                               byte newRowKey,
                               Object newValue)

Convenience method to notify registered provider listeners that a child element is being added from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

newRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderCreate

public void fireProviderCreate(String providerKey,
                               char newRowKey,
                               Object newValue)

Convenience method to notify registered provider listeners that a child element is being added from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

newRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderCreate

public void fireProviderCreate(String providerKey,
                               int newRowKey,
                               Object newValue)

Convenience method to notify registered provider listeners that a child element is being added from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

newRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderCreate

public void fireProviderCreate(String providerKey,
                               long newRowKey,
                               Object newValue)

Convenience method to notify registered provider listeners that a child element is being added from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

newRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderCreate

public void fireProviderCreate(String providerKey,
                               Object newRowKey,
                               Object newValue)

Convenience method to notify registered provider listeners that a child element is being added from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

newRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderCreate

public void fireProviderCreate(String providerKey,
                               short newRowKey,
                               Object newValue)

Convenience method to notify registered provider listeners that a child element is being added from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

newRowKey - The unique key to access the changed provider

newValue - The new value for the provider

fireProviderDelete

public void fireProviderDelete(String providerKey,
                               byte oldRowKey)

Convenience method to notify registered provider listeners that a child element is being removed from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

oldRowKey - The old value for the provider

fireProviderDelete

public void fireProviderDelete(String providerKey,
                               char oldRowKey)

Convenience method to notify registered provider listeners that a child element is being removed from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

oldRowKey - The old value for the provider

fireProviderDelete

public void fireProviderDelete(String providerKey,
                               int oldRowKey)

Convenience method to notify registered provider listeners that a child element is being removed from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

oldRowKey - The old value for the provider

fireProviderDelete

public void fireProviderDelete(String providerKey,
                               long oldRowKey)

Convenience method to notify registered provider listeners that a child element is being removed from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

oldRowKey - The old value for the provider

fireProviderDelete

public void fireProviderDelete(String providerKey,
                               Object oldRowKey)

Convenience method to notify registered provider listeners that a child element is being removed from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

oldRowKey - The old value for the provider

fireProviderDelete

public void fireProviderDelete(String providerKey,
                               short oldRowKey)

Convenience method to notify registered provider listeners that a child element is being removed from the provider.

Parameters:

providerKey - The programmatic name of the provider that was changed.

oldRowKey - The old value for the provider

fireProviderRefresh

public void fireProviderRefresh(String providerKey)

Convenience method to notify registered provider listeners that a the providers have changed enough that it would be best to simply purge the children from their caches and re-fetch on the query.

Parameters:

providerKey - The programmatic name of the provider that was changed.

getProviderChangeListeners

public ProviderChangeListener[] getProviderChangeListeners()

Get the registered provider change listeners

hasListeners

public boolean hasListeners()

Return true if there are any registered data change listeners

removeProviderChangeListener

public void removeProviderChangeListener(ProviderChangeListener listener)

Remove a ProviderChangeListener from the listener list. This removes a ProviderChangeListener that was registered for all properties.

Parameters:

listener - The ProviderChangeListener to be removed