com.lightstreamer.javameclient.midp
Interface SimpleTableListener


public interface SimpleTableListener

A fast, though basic, listener interface, which receives notification of data updates and other messages related to a subscribed table.
Only notifications of changed field values received from the Server are available. Unchanged fields are just reported through the UNCHANGED constant. Specific items and fields are only identified by positional information.


Field Summary
static java.lang.String UNCHANGED
          Constant that represents unchanged fields.
 
Method Summary
 void onControlError(java.lang.String error)
          Notification that the Server has refused a Subscription request because of the constraints imposed by the Metadata Adapter or by Server configuration.
 void onEndOfSnapshot(int item)
          Notification that no more snapshot events are coming for an item.
 void onRawUpdatesLost(int item, int lostUpdates)
          Notification of one or more updates that were suppressed in the Server because of internal memory limitations.
 void onUnsubscribe()
          Notification of the unsubscription of all the items in the table.
 void onUpdate(int item, SimpleItemUpdate update)
          Notification of an update of the values for an item in the associated table.
 

Field Detail

UNCHANGED

static final java.lang.String UNCHANGED
Constant that represents unchanged fields. Object identity rather than object equality must be tested; a string value of "UNCHANGED" may be a legal value coming from the Data Adapter.

Method Detail

onUpdate

void onUpdate(int item,
              SimpleItemUpdate update)
Notification of an update of the values for an item in the associated table.

Parameters:
item - 1-based index of the item in the Group of items in the table.
update - Object that carries values received from the Server. The values are reported in the same order as the fields in the Schema of the table.
See Also:
SimpleItemUpdate, ReusableSimpleItemUpdate

onEndOfSnapshot

void onEndOfSnapshot(int item)
Notification that no more snapshot events are coming for an item. This notification is always received once, when the item is subscribed in DISTINCT or COMMAND mode and the snapshot is requested.

Parameters:
item - 1-based index of the item in the Group of items in the table.

onRawUpdatesLost

void onRawUpdatesLost(int item,
                      int lostUpdates)
Notification of one or more updates that were suppressed in the Server because of internal memory limitations. The notification can be sent if the subscription mode is RAW or COMMAND. It can also be sent if the subscription mode is MERGE or DISTINCT and unfiltered dispatching has been requested. In all these cases, an update loss may be unacceptable for the client (in filtered COMMAND mode, this applies to ADD and DELETE events only).

Parameters:
item - item 1-based index of the item in the Group of items in the table.
lostUpdates - Number of consecutive lost updates for the item.

onControlError

void onControlError(java.lang.String error)
Notification that the Server has refused a Subscription request because of the constraints imposed by the Metadata Adapter or by Server configuration. No data for this table will be received.
Note: if single connection mode is used, this handler is never called; a subscription error would rather cause the ConnectionListener.onServerError(java.lang.String) notification to be issued and the whole session request to fail.

Parameters:
error - A string representing the error sent by the server; the string message is prefixed by a Server originated error code, to be disaggregated in a future release of the library.
See Also:
LSClient.useSingleConnection(boolean), HandyTableListener.onControlError(int, java.lang.String)

onUnsubscribe

void onUnsubscribe()
Notification of the unsubscription of all the items in the table. The unsubscription may be subsequent to an unsubscribeTable call or to the closure of the connection.