public class TableInfo
extends java.lang.Object
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.
The object also provides useful queries and operations that can be performed
on its specific Table (i.e.: Subscription).Constructor and Description |
---|
TableInfo(int winIndex,
Mode mode,
java.lang.String group,
java.lang.String dataAdapter,
java.lang.String schema,
int min,
int max,
java.lang.String selector,
java.lang.String[] itemNames,
SubscriptionStatistics[] itemSubscrStats)
Used by Lightstreamer to create a TableInfo instance,
collecting the various attributes of a Table (i.e.: Subscription).
|
Modifier and Type | Method and Description |
---|---|
java.util.concurrent.CompletionStage<java.lang.Void> |
forceUnsubscription()
Enforces the unsubscription of this Table (i.e.: Subscription).
|
java.lang.String |
getDataAdapter()
Returns the name of the Data Adapter to which the Table
(i.e.: Subscription) refers.
|
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).
|
java.lang.String[] |
getSubscribedItems()
Returns the array of the Item names involved in this Table
(i.e.: Subscription).
|
SubscriptionStatistics[] |
getSubscriptionStatistics()
Returns an array that contains the statistics related with the activity
of all items involved in this Table (i.e.: Subscription).
|
int |
getWinIndex()
Returns a unique identifier of the client subscription request.
|
public TableInfo(int winIndex, Mode mode, java.lang.String group, java.lang.String dataAdapter, java.lang.String schema, int min, int max, java.lang.String selector, java.lang.String[] itemNames, SubscriptionStatistics[] itemSubscrStats)
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.dataAdapter
- The name of the Data Adapter to which the Table
(i.e.: Subscription) refers.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).itemNames
- The array of Item names involved in this Table
(i.e.: Subscription).itemSubscrStats
- An optional array that contains the statistics
related with the activity of this subscription.public int getWinIndex()
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.public Mode getMode()
public java.lang.String getId()
public java.lang.String getDataAdapter()
public java.lang.String getSchema()
public java.lang.String getSelector()
public int getMin()
public int getMax()
public java.lang.String[] getSubscribedItems()
MetadataProvider.getItems(String, String, String)
when decoding of the group name, but restricted, in case a first and/or last
Item was specified in the client request (see getMin()
and getMax()
).public SubscriptionStatistics[] getSubscriptionStatistics()
getSubscribedItems()
.
These statistics are available only on the objects supplied by calls
to MetadataProvider.notifyTablesClose(java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[])
,
so that the statistics will refer to the whole life of the subscription.public java.util.concurrent.CompletionStage<java.lang.Void> forceUnsubscription()
MetadataProvider.notifyTablesClose(java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[])
.
MetadataProvider.notifyNewTables(java.lang.String, java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[])
is pointless; however, the request will be held, then carried out
after the underlying subscription attempt has finished.
MetadataProvider.notifyNewTables(java.lang.String, java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[])
which has provided an array of TableInfo with a single element (this one);
otherwise it will do nothing. However, the case of arrays with multiple
elements is only possible when extremely old client SDKs are in use.MetadataProvider.notifyNewTables(java.lang.String, java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[])
,
hence they are expected to execute fast.