com.lightstreamer.ls_client

Class ExtendedTableInfo

java.lang.Object

com.lightstreamer.ls_client.SimpleTableInfo

com.lightstreamer.ls_client.ExtendedTableInfo

All Implemented Interfaces:

java.lang.Cloneable

public class ExtendedTableInfo
extends SimpleTableInfo

Contains the specification of a table to be subscribed to Lightstreamer Server. All the items and fields in the table are supplied. Group and Schema names to be sent to the Server are made by space separated concatenations of item and field names. This name convention is suitable for a Metadata Adapter derived from LiteralBasedProvider or equivalent to it.

Field Summary

Fields inherited from class com.lightstreamer.ls_client.SimpleTableInfo

COMMAND, DISTINCT, MERGE, RAW

Constructor Summary

Constructors

Constructor and Description
ExtendedTableInfo(java.lang.String[] items, java.lang.String mode, java.lang.String[] fields, boolean snapshot) Constructs a table specification with basic table attributes.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
java.lang.String[]	getFields() Recalls the fields contained in this table.
java.lang.String	getGroup() Gets the name of the Group of items contained in this table, as specified to the Server.
java.lang.String[]	getItems() Recalls the items contained in this table.
java.lang.String	getSchema() Gets the name of the Schema of fields used in this table, as specified to the Server.
void	setRange(int start, int end) Inherited from SimpleTableInfo, but ignored in this case.

Methods inherited from class com.lightstreamer.ls_client.SimpleTableInfo

getAdapterSet, getBufferSize, getDataAdapter, getDistinctSnapshotLength, getEnd, getMode, getRequestedMaxFrequency, getSelector, getStart, isSnapshot, isUnfilteredDispatching, requestUnfilteredDispatching, setDataAdapter, setRequestedBufferSize, setRequestedDistinctSnapshotLength, setRequestedMaxFrequency, setSelector

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedTableInfo

public ExtendedTableInfo(java.lang.String[] items,
                         java.lang.String mode,
                         java.lang.String[] fields,
                         boolean snapshot)
                  throws SubscrException

Constructs a table specification with basic table attributes. The details of the items and fields used are specified. This requires that a LiteralBasedProvider or equivalent Metadata Adapter is configured on the Server. As a consequence, the item and field names specified cannot be empty or null and cannot contain spaces.

Parameters:

items - Array of names of the items in the table; it cannot be empty. A copy of the array is stored internally.

mode - Subscription mode for all items in the table. It should be equal to one of the constants defined in the class.

fields - Array of names of the fields for all items in the table; it cannot be empty. A copy of the array is stored internally.

snapshot - If true, requires the snapshot for all items in the table. The snapshot can be requested only for MERGE, DISTINCT and COMMAND Items mode. However, the flag is ignored if requestUnfilteredDispatching() is also called, as snapshot management is currently not supported for unfiltered COMMAND mode.

Throws:

SubscrException - Thrown if the snapshot request is not compatible with the supplied subscription mode or any of the item or field names in the given arrays contains a space or it is empty or null.

Method Detail

getItems

public java.lang.String[] getItems()

Recalls the items contained in this table.

Returns:

an array of item names. A copy of the stored array is returned.

getFields

public java.lang.String[] getFields()

Recalls the fields contained in this table.

Returns:

an array of field names. A copy of the stored array is returned.

getGroup

public java.lang.String getGroup()

Gets the name of the Group of items contained in this table, as specified to the Server.

Overrides:

getGroup in class SimpleTableInfo

Returns:

a Group name made of a space separated list of the specified item names.

getSchema

public java.lang.String getSchema()

Gets the name of the Schema of fields used in this table, as specified to the Server.

Overrides:

getSchema in class SimpleTableInfo

Returns:

a Schema name made of a space separated list of the specified field names.

setRange

public void setRange(int start,
                     int end)

Inherited from SimpleTableInfo, but ignored in this case. Specifying a subrange of the specified Group of items to be requested is only meaningful when Group names must be used, so that an explicit specification for the needed subrange as a Group may not be available.

Overrides:

setRange in class SimpleTableInfo

Parameters:

start - ignored.

end - ignored.

clone

public java.lang.Object clone()

Overrides:

clone in class SimpleTableInfo