com.lightstreamer.interfaces.metadata
Class TableInfo

java.lang.Object
  com.lightstreamer.interfaces.metadata.TableInfo

public class TableInfo
extends java.lang.Object

Used to provide value objects to the calls to methods notifyNewTables and notifyTablesClose of MetadataProvider. The attributes of every Table to be added or removed to a Session has to be written to a TableInfo instance.

Constructor Summary

TableInfo(int winIndex, Mode mode, java.lang.String id, java.lang.String schema, int min, int max, java.lang.String selector)
Creates a TableInfo instance, collecting the various attributes of a Table.

Method Summary

java.lang.String	getId() Returns the name of the Group to which the Table's Items belong.
int	getMax() Returns the index of the last Item in the Group to be considered in the Table.
int	getMin() Returns the index of the first Item in the Group to be considered in the Table.
Mode	getMode() Returns the publishing Mode for the Items in the Table (it must be the same across all the Table).
java.lang.String	getSchema() Returns the name of the Schema used for the Table's Items.
java.lang.String	getSelector() Returns the name of the optional Selector associated to the Table.
int	getWinIndex() Returns the identifier of the Window to which the Table belongs.

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 id,
                 java.lang.String schema,
                 int min,
                 int max,
                 java.lang.String selector)

Creates a TableInfo instance, collecting the various attributes of a Table.

Parameters:

winIndex - Identifier of the Window to which the Table belongs.

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

id - The name of the Group to which the Table's Items belong.

schema - The name of the Schema used for the Table's Items.

selector - The name of the optional Selector associated to the table.

min - The 1-based index of the first Item in the Group to be considered in the Table.

max - The 1-based index of the last Item in the Group to be considered in the Table.

Method Detail

getWinIndex

public int getWinIndex()

Returns the identifier of the Window to which the Table belongs.

Returns:

a Window identifier.

getMode

public Mode getMode()

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

Returns:

a publishing Mode.

getId

public java.lang.String getId()

Returns the name of the Group to which the Table's Items belong.

Returns:

a Group name.

getSchema

public java.lang.String getSchema()

Returns the name of the Schema used for the Table's Items.

Returns:

a Schema name.

getSelector

public java.lang.String getSelector()

Returns the name of the optional Selector associated to the Table.

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.

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.

Returns:

a 1-based index.