Class TableInfo
java.lang.Object
com.lightstreamer.adapters.remote.TableInfo
public class TableInfo
extends java.lang.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
-
Method Summary
Modifier and Type Method Description java.lang.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.java.lang.String
getSchema()
Gets the name of the Field Schema (or specification of the Field List) used for the subscribed Items.java.lang.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 Details
-
TableInfo
public TableInfo(int winIndex, @Nonnull Mode mode, @Nonnull java.lang.String group, @Nonnull java.lang.String schema, int min, int max, @Nullable 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 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 Details
-
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
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 java.lang.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 java.lang.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 java.lang.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
-