Packagecom.lightstreamer.as_client
Interfacepublic interface Table
ImplementorsNonVisualTable, VisualTable

Table is an interface whose implementations contain the specification of a data table to subscribed to.


Public Methods
 MethodDefined by
  
setDataAdapter(adapter:String):void
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.
Table
  
setItemRange(start:uint, end:uint):void
Setter method that sets a range of items within the specified group.
Table
  
setRequestedBufferSize(bufferSize:*):void
Setter method that sets the length of Lightstreamer Server's buffer for the internal queueing of updates for each item in the data table.
Table
  
setRequestedMaxFrequency(maxFreq:*):void
Setter method that sets the maximum update frequency to be requested to Lightstreamer Server for all the items in the data table.
Table
  
setSelector(selector:String):void
Setter method that sets the selector name for all the items in the data table.
Table
  
setSnapshotRequired(snapshotRequired:*):void
Setter method that enables/disables snapshot delivery request for the items in the data table.
Table
Method detail
setDataAdapter()method
public function setDataAdapter(adapter:String):void

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. If not called, the "DEFAULT" name is used.
The Data Adapter name is configured on the server side through the "name" attribute of the "data_provider" element, in the "adapters.xml" file which defines the Adapter Set. Omitting the attribute configures the "DEFAULT" name.
Note: If more than one Data Adapter is needed to supply all the items in a set of items, then it is not possible to group all the items of the set in a single Table. Multiple tables have to be defined.

Parameters
adapter:String — the name of the Data Adapter. A null value is equivalent to the "DEFAULT" name.

See also

ConnectionInfo.setAdapter()
setItemRange()method 
public function setItemRange(start:uint, end:uint):void

Setter method that sets a range of items within the specified group. Items outside of this range are not subscribed to. The support for ranges allows the front-end to use generic group identifiers as group descriptors, yet being able to subscribe to subsets of such groups or even to single items from such groups, without the need to introduce more specific group identifiers.
Moreover, this method allows for continually resubscribing different item subsets without the need for creating different data table objects.

Parameters
start:uint — 1-based index of the first item in the group that has to be subscribed to.
 
end:uint — 1-based index of the last item in the group that has to be subscribed to.
setRequestedBufferSize()method 
public function setRequestedBufferSize(bufferSize:*):void

Setter method that sets the length of Lightstreamer Server's buffer for the internal queueing of updates for each item in the data table. A queueing buffer is used by the Server to accumulate a burst of updates for an item, so that they can all be sent to the Client, despite of bandwidth or frequency limits. It can be used only when the subscription mode is MERGE or DISTINCT and unfiltered dispatching has not been requested. Note that the Server may pose an upper limit on the size of its internal buffers.

Parameters
bufferSize:* — The length of the internal queueing buffers to be used in the Server. If a 0 value or the string "unlimited" is supplied, then the buffer length is decided by the Server.
setRequestedMaxFrequency()method 
public function setRequestedMaxFrequency(maxFreq:*):void

Setter method that sets the maximum update frequency to be requested to Lightstreamer Server for all the items in the data table. It can be used only if the subscription mode is MERGE, DISTINCT or COMMAND (in the latter case, the frequency limitation applies to the UPDATE events for each single key). Note that frequency limits on the items can also be set on the server side and this request can only be issued in order to further reduce the frequency, not to rise it beyond these limits.
This method can also be used to request unfiltered dispatching for the items in the data table. However, unfiltered dispatching requests may be refused if any frequency limit is posed on the server side for some item.
Edition Note: A further global frequency limit is also imposed by the Server, if it is running in Presto edition; this specific limit also applies to RAW mode and to unfiltered dispatching.
Edition Note: A further global frequency limit is also imposed by the Server, if it is running in Allegro edition; this specific limit also applies to RAW mode and to unfiltered dispatching.
Edition Note: A further global frequency limit is also imposed by the Server, if it is running in Moderato edition; this specific limit also applies to RAW mode and to unfiltered dispatching.

Parameters
maxFreq:*
setSelector()method 
public function setSelector(selector:String):void

Setter method that sets the selector name for all the items in the data table. The selector is a filter on the updates received. It is executed on the Server and implemented by the Metadata Adapter.

Parameters
selector:String — name of a selector, to be recognized by the Metadata Adapter, or null to unset the selector.
setSnapshotRequired()method 
public function setSnapshotRequired(snapshotRequired:*):void

Setter method that enables/disables snapshot delivery request for the items in the data table. The snapshot can be requested only if the subscription mode is MERGE, DISTINCT or COMMAND.

Parameters
snapshotRequired:* — true/false to request/not request snapshot delivery. If the subscription mode is DISTINCT, instead of true, it is also possible to supply a number, to specify the requested length (depth) of the snapshot (though the length of the received snapshot may be less than requested, because of insufficient data or server side limits); specifying true means that the snapshot length should be determined only by the Server.



Lightstreamer Flex client 1.1 API