com.lightstreamer.adapters.remote

Class TableInfo

java.lang.Object

com.lightstreamer.adapters.remote.TableInfo

public class TableInfo
extends Object

Used by MetadataProvider to provide value objects to the calls to methods NotifyNewTables and NotifyTablesClose. 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, String group, String schema, int min, int max, 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
String	getId() Gets the name of the Item Group (or specification of the Item List) to which the subscribed Items belong.
int	getMax() Gets the index of the last Item in the Group to be considered in the Table (i.e.
int	getMin() Gets the index of the first Item in the Group to be considered in the Table (i.e.
Mode	getMode() Gets the publishing Mode for the Items in the Table (i.e.
String	getSchema() Gets the name of the Field Schema (or specification of the Field List) used for the subscribed Items.
String	getSelector() Gets the name of the optional Selector associated to the Table (i.e.
int	getWinIndex() Gets the unique identifier of the client subscription request within the session.

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,
                 @Nonnull
                 Mode mode,
                 @Nonnull
                 String group,
                 @Nonnull
                 String schema,
                 int min,
                 int max,
                 @Nullable
                 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 within the session.

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.

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).

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

Method Detail

getWinIndex

public final int getWinIndex()

Gets the unique identifier of the client subscription request within the session. 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 through NotifyNewTables and NotifyTablesClose. 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:

the unique identifier of the client subscription request.

getMode

@Nonnull
public final Mode getMode()

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

Returns:

the publishing Mode for the Items in the Table

getId

@Nonnull
public final String getId()

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

Returns:

the name of the Item Group (or specification of the Item List)

getSchema

@Nonnull
public final String getSchema()

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

Returns:

the name of the Field Schema (or specification of the Field List)

getMin

public final int getMin()

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

Returns:

the index of the first Item in the Group

getMax

public final int getMax()

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

Returns:

the index of the last Item in the Group

getSelector

@Nullable
public final String getSelector()

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

Returns:

the name of the optional Selector associated to the Table