HTML Client 5.0.1

Class Table

Object
   |
   +--Table
Direct Known Subclasses:
NonVisualTable, VisualTable

class Table


The base class for the hierarchy of the data-table classes. It contains the subscription details and the event handlers needed to process the real-time data. A specialized (derived) object, rather than a Table object, should be created and used. After the creation, a data-table object is in the "inactive" state. When a data-table object is added to a PushPage object, through the PushPage.addTable() method, its state becomes "running". This means that the Engine activates a subscription to the required items through Lightstreamer Server and the data-table object begins to receive real-time events.
The class constructor, its prototype and any other properties should never be used directly; actually, Table is not even defined as a global name.
Defined in lspushpage.js


Constructor Summary
Table (<GroupDescriptor> tGroup, <SchemaDescriptor> tSchema, <String> tSubscriptionMode)
            Used by specialized data table objects to inherit the support for the properties and event handlers common to all data tables management.
 
Method Summary
 String getClassName()
           Inquiry method that returns the name of the class of this instance.
 GroupDescriptor getGroup()
           Inquiry method that returns the GroupDescriptor associated to the data table.
 String getId()
           Inquiry method that returns the identifier associated to the data table, provided that the data table is currently in "running" state.
 SchemaDescriptor getSchema()
           Inquiry method that returns the SchemaDescriptor associated to the data table.
 void onEndOfSnapshot(<Number> itemPos, <String> itemName)
           Event handler that is called by Lightstreamer to notify that all snapshot events for an item in the data table have been received, so that real time events are now going to be received.
 void onItemUpdate(<Number> itemPos, <UpdateItemInfo> updateInfo, <String> itemName)
           Event handler that is called by Lightstreamer each time an update pertaining to an item in the data table has been received from the Server.
 void onLostUpdates(<Number> itemPos, <Number> lostUpdates, <String> itemName, <String> refKey)
           Event handler that is called by Lightstreamer to notify that, due to internal resource limitations, Lightstreamer Server dropped one or more updates for an item in the data table.
 void onStart()
           Event handler that is called by Lightstreamer to notify that a data table has been successfully subscribed to through the Server.
 void setDataAdapter(<String> dataAdapter)
           Setter method that sets the name of the Data Adapter (within the Adapter Set used by the current session) that supplies all the items in the Group.
 void setItemsRange(<Number> start, <Number> end)
           Setter method that sets a range of items within the specified group.
 void setRequestedBufferSize(<Number> size)
           Setter method that sets the length to be requested to Lightstreamer Server for the internal queueing buffers for the items in the data table.
 void setRequestedMaxFrequency(<Number> freq)
           Setter method that sets the maximum update frequency to be requested to Lightstreamer Server for all the items in the data table.
 void setSelector(<String> selector)
           Setter method that sets the selector name for all the items in the data table.
 void setSnapshotRequired(<boolean> required)
           Setter method that enables/disables snapshot delivery request for the items in the data table.

Constructor Detail

Table

Table(<GroupDescriptor> tGroup, <SchemaDescriptor> tSchema, <String> tSubscriptionMode)

Method Detail

getClassName

String getClassName()

getGroup

GroupDescriptor getGroup()

getId

String getId()

getSchema

SchemaDescriptor getSchema()

onEndOfSnapshot

void onEndOfSnapshot(<Number> itemPos, <String> itemName)

onItemUpdate

void onItemUpdate(<Number> itemPos, <UpdateItemInfo> updateInfo, <String> itemName)

onLostUpdates

void onLostUpdates(<Number> itemPos, <Number> lostUpdates, <String> itemName, <String> refKey)

onStart

void onStart()

setDataAdapter

void setDataAdapter(<String> dataAdapter)

setItemsRange

void setItemsRange(<Number> start, <Number> end)

setRequestedBufferSize

void setRequestedBufferSize(<Number> size)

setRequestedMaxFrequency

void setRequestedMaxFrequency(<Number> freq)

setSelector

void setSelector(<String> selector)

setSnapshotRequired

void setSnapshotRequired(<boolean> required)

HTML Client 5.0.1

Lightstreamer HTML Client API
Documentation generated by JSDoc on Tue May 22 11:46:54 2012