com.lightstreamer.interfaces.metadata

Class TableInfo

java.lang.Object

com.lightstreamer.interfaces.metadata.TableInfo

public class TableInfo
extends java.lang.Object

Used by Lightstreamer to provide value objects to the calls to methods MetadataProvider.notifyNewTables(java.lang.String, java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[]) and MetadataProvider.notifyTablesClose(java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[]). The attributes of every Table (i.e.: Subscription) to be added or removed to a Session have to be written to a TableInfo instance.

Constructor Summary

Constructors

Constructor and Description
TableInfo(int winIndex, Mode mode, java.lang.String group, java.lang.String schema, int min, int max, java.lang.String selector) Used by Lightstreamer to create a TableInfo instance, collecting the various attributes of a Table (i.e.: Subscription).

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the name of the Item Group (or specification of the Item List) to which the subscribed Items belong.
int	getMax() Returns the index of the last Item in the Group to be considered in the Table (i.e.: Subscription).
int	getMin() Returns the index of the first Item in the Group to be considered in the Table (i.e.: Subscription).
Mode	getMode() Returns the publishing Mode for the Items in the Table (i.e.: Subscription) (it must be the same across all the Table).
java.lang.String	getSchema() Returns the name of the Field Schema (or specification of the Field List) used for the subscribed Items.
java.lang.String	getSelector() Returns the name of the optional Selector associated to the Table (i.e.: Subscription).
int	getWinIndex() Returns a unique identifier of the client subscription request.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableInfo

public TableInfo(int winIndex,
                 Mode mode,
                 java.lang.String group,
                 java.lang.String schema,
                 int min,
                 int max,
                 java.lang.String selector)

Used by Lightstreamer to create a TableInfo instance, collecting the various attributes of a Table (i.e.: Subscription).

Parameters:

winIndex - Unique identifier of the client subscription request.

mode - Publishing Mode for the Items in the Table (i.e.: Subscription) (it must be the same across all the Table).

group - The name of the Item Group (or specification of the Item List) to which the subscribed Items belong.

schema - The name of the Field Schema (or specification of the Field List) used for the subscribed Items.

selector - The name of the optional Selector associated to the table (i.e.: Subscription).

min - The 1-based index of the first Item in the Group to be considered in the Table (i.e.: Subscription).

max - The 1-based index of the last Item in the Group to be considered in the Table (i.e.: Subscription).

Method Detail

getWinIndex

public int getWinIndex()

Returns a unique identifier of the client subscription request. This allows for matching the corresponding subscription and unsubscription requests. Note that, for clients based on a very old version of a client library or text protocol, subscription requests may involve multiple Tables (i.e.: Subscriptions), hence multiple objects of this type can be supplied in a single array by MetadataProvider.notifyNewTables(java.lang.String, java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[]) and MetadataProvider.notifyTablesClose(java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[]). In this case, the value returned is the same for all these objects and the single Tables (i.e.: Subscriptions) can be identified by their relative position in the array.

Returns:

a Window identifier.

getMode

public Mode getMode()

Returns the publishing Mode for the Items in the Table (i.e.: Subscription) (it must be the same across all the Table).

Returns:

a publishing Mode.

getId

public java.lang.String getId()

Returns the name of the Item Group (or specification of the Item List) to which the subscribed Items belong.

Returns:

an Item Group name (or Item List specification).

getSchema

public java.lang.String getSchema()

Returns the name of the Field Schema (or specification of the Field List) used for the subscribed Items.

Returns:

a Field Schema name (or Field List specification).

getSelector

public java.lang.String getSelector()

Returns the name of the optional Selector associated to the Table (i.e.: Subscription).

Returns:

a Selector name, or null if no Selector was associated to the Table.

getMin

public int getMin()

Returns the index of the first Item in the Group to be considered in the Table (i.e.: Subscription).

Returns:

a 1-based index.

getMax

public int getMax()

Returns the index of the last Item in the Group to be considered in the Table (i.e.: Subscription).

Returns:

a 1-based index.