public class RangeChangeEvent extends AMXEvent
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 and Description |
---|
RangeChangeEvent() |
RangeChangeEvent(String eventSourceId,
Object lastLoadedRowKey,
int fetchSize,
String providerKey,
String keyAttribute,
boolean dataExhausted) |
Modifier and Type | Method and Description |
---|---|
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) |
public RangeChangeEvent()
public RangeChangeEvent(String eventSourceId, Object lastLoadedRowKey, int fetchSize, String providerKey, String keyAttribute, boolean dataExhausted)
public String getEventSourceId()
public void setEventSourceId(String eventSourceId)
eventSourceId
- the source ID of the eventpublic String getContextFreeValue()
public void setContextFreeValue(String contextFreeValue)
contextFreeValue
- the context-free value used by the source of the eventpublic Object getLastLoadedRowKey()
public void setLastLoadedRowKey(Object lastLoadedRowKey)
lastLoadedRowKey
- the row key of the last row loaded before the requested rangepublic int getFetchSize()
public void setFetchSize(int fetchSize)
fetchSize
- the number of new objects to fetchpublic String getProviderKey()
public void setProviderKey(String providerKey)
providerKey
- the name the framework uses to locate the DataControl node on
which to add the providerspublic String getKeyAttribute()
public void setKeyAttribute(String keyAttribute)
keyAttribute
- the name of the provider attribute that acts as the key, if one is
defined. Can be null.public boolean isDataExhausted()
public void setDataExhausted(boolean dataExhausted)
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.