oracle.adfmf.amx.event
Class RangeChangeEvent

Object
  oracle.adfmf.amx.event.AMXEvent
      oracle.adfmf.amx.event.RangeChangeEvent

public class RangeChangeEvent
extends AMXEvent

A RangeChangeEvent is an object passed to RangeChangeListener.rangeChange(RangeChangeEvent), which occurs when a DataControl iterator is preparing to navigate to a new range of providers.

It defines properties that indicate whether or not new external data should be fetched, the amount of data to be fetched, and others necessary for rangeChange implementation.

Constructor Summary

RangeChangeEvent()

RangeChangeEvent(String eventSourceId, Object lastLoadedRowKey, int fetchSize, String providerKey, String keyAttribute, boolean dataExhausted)

Method Summary

String	getContextFreeValue() Returns the context-free value used by the source of the event.
String	getEventSourceId() Returns the the source ID of the event.
int	getFetchSize() Returns the number of new objects to fetch
String	getKeyAttribute() Returns the name of the provider attribute that acts as the key, if one is defined.
Object	getLastLoadedRowKey() Returns the row key of the last row loaded before the requested range.
String	getProviderKey() Returns the name the framework uses to locate the DataControl node on which to add the providers, which is a dot delimited string of accessor names, starting at the root DC (i.e.
boolean	isDataExhausted() Returns true if the loaded data model is at the last row, and more data should be fetched.
void	setContextFreeValue(String contextFreeValue) Specifies the context-free value used by the source of the event.
void	setDataExhausted(boolean dataExhausted)
void	setEventSourceId(String eventSourceId) Specifies the the source ID of the event.
void	setFetchSize(int fetchSize) Specifies the number of new objects to fetch.
void	setKeyAttribute(String keyAttribute)
void	setLastLoadedRowKey(Object lastLoadedRowKey) Specifies the row key of the last row loaded before the requested range.
void	setProviderKey(String providerKey)

Methods inherited from class Object

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

Constructor Detail

RangeChangeEvent

public RangeChangeEvent()

RangeChangeEvent

public RangeChangeEvent(String eventSourceId,
                        Object lastLoadedRowKey,
                        int fetchSize,
                        String providerKey,
                        String keyAttribute,
                        boolean dataExhausted)

Method Detail

getEventSourceId

public String getEventSourceId()

Returns the the source ID of the event. When fired from the data control framework, this will be the id of the iterator binding associated with the DataControl collection that is changing range.

setEventSourceId

public void setEventSourceId(String eventSourceId)

Specifies the the source ID of the event.

Parameters:

eventSourceId - the source ID of the event

getContextFreeValue

public String getContextFreeValue()

Returns the context-free value used by the source of the event. This value might be null if not available.

setContextFreeValue

public void setContextFreeValue(String contextFreeValue)

Specifies the context-free value used by the source of the event.

Parameters:

contextFreeValue - the context-free value used by the source of the event

getLastLoadedRowKey

public Object getLastLoadedRowKey()

Returns the row key of the last row loaded before the requested range. This value might be null if not available.

setLastLoadedRowKey

public void setLastLoadedRowKey(Object lastLoadedRowKey)

Specifies the row key of the last row loaded before the requested range.

Parameters:

lastLoadedRowKey - the row key of the last row loaded before the requested range

getFetchSize

public int getFetchSize()

Returns the number of new objects to fetch

setFetchSize

public void setFetchSize(int fetchSize)

Specifies the number of new objects to fetch.

Parameters:

fetchSize - the number of new objects to fetch

getProviderKey

public String getProviderKey()

Returns the name the framework uses to locate the DataControl node on which to add the providers, which is a dot delimited string of accessor names, starting at the root DC (i.e. "root.products.categories").

setProviderKey

public void setProviderKey(String providerKey)

Parameters:

providerKey - the name the framework uses to locate the DataControl node on which to add the providers

getKeyAttribute

public String getKeyAttribute()

Returns the name of the provider attribute that acts as the key, if one is defined. Can be null.

setKeyAttribute

public void setKeyAttribute(String keyAttribute)

Parameters:

keyAttribute - the name of the provider attribute that acts as the key, if one is defined. Can be null.

isDataExhausted

public boolean isDataExhausted()

Returns true if the loaded data model is at the last row, and more data should be fetched. Otherwise, the loaded model still has enough data loaded to navigate forward.

setDataExhausted

public void setDataExhausted(boolean dataExhausted)

Parameters:

dataExhausted - true if the loaded data model is at the last row, and more data should be fetched. Otherwise, the loaded model still has enough data loaded to navigate forward.