public class SimpleTableInfo
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMMAND
String constant for COMMAND subscription mode.
|
static java.lang.String |
DISTINCT
String constant for DISTINCT subscription mode.
|
static java.lang.String |
MERGE
String constant for MERGE subscription mode.
|
static java.lang.String |
RAW
String constant for RAW subscription mode.
|
Constructor and Description |
---|
SimpleTableInfo(java.lang.String group,
java.lang.String schema,
java.lang.String mode)
Constructs a table specification with basic table attributes.
|
Modifier and Type | Method and Description |
---|---|
int |
getBuffSize()
Recalls the requested buffer size for this table.
|
java.lang.String |
getDataAdapter()
Recalls the name of the Data Adapter (for the Adapter Set used
by the current session) which supplies all the items in the Group.
|
int |
getDistinctSnapshotLength()
Recalls the requested length of the snapshot for this table
(for DISTINCT subscriptions only).
|
int |
getEndRange()
Recalls the 1-based index of the last item in the group that has to be subscribed.
|
java.lang.String |
getGroup()
Recalls the group name of the items for this table.
|
java.lang.String |
getMode()
Recalls the subscription mode for this table.
|
double |
getRequestedMaxFrequency()
Recalls the requested max frequency for this table.
|
java.lang.String |
getSchema()
Recalls the schema for this table.
|
java.lang.String |
getSelector()
Recalls the required selector for this table, if configured.
|
int |
getStartRange()
Recalls the 1-based index of the first item in the group that has to be subscribed.
|
boolean |
isSnapshotRequired()
Recalls whether or not a snapshot is required for this table.
|
boolean |
isUnfilteredMaxFreq()
Recalls whether or not unfiltered dispatching is requested for this table.
|
boolean |
isUnlimitedBufferSize()
Recalls whether or not an unlimited buffer size is requested for this table.
|
boolean |
isUnlimitedMaxFreq()
Recalls whether or not unlimited max frequency is requested for this table.
|
void |
setDataAdapter(java.lang.String dataAdapter)
Specifies the name of the Data Adapter (within the Adapter Set used
by the current session) that supplies all the items in the Group.
|
void |
setDistinctSnapshotLength(int snapshotLength)
Setter method that sets the snapshot length requested to be requested to
Lightstreamer Server for all the items in the table (though the length
of the received snapshot may be less than requested, because of insufficient data or server side limits).
|
void |
setItemsRange(int start,
int end)
Setter method that sets a range of items within the specified group.
|
void |
setRequestedBufferSize(int bufferSize)
Setter method that sets the length of Lightstreamer Server's buffer for
the internal queueing of updates for each item in the data table.
|
void |
setRequestedMaxFrequency(double maxFrequency)
Setter method that sets the maximum update frequency to be requested to
Lightstreamer Server for all the items in the table.
|
void |
setSelector(java.lang.String selector)
Specifies a selector to be applied by the Server to the updates pertaining to all the Items in the Group.
|
void |
setSnaspshotRequired(boolean required)
Setter method that enables/disables snapshot delivery request for the items in the data table.
|
void |
setUnfilteredMaxFrequency()
Setter method that can be used to request unfiltered dispatching for the items in the table.
|
void |
setUnlimitedBufferSize()
Setter method that sets to unlimited the length of the internal queueing
buffers to be requested to Lightstreamer Server
for the items in the data table.
|
void |
setUnlimitedMaxFrequency()
Setter method that can be used to remove settings of
setRequestedMaxFrequency(double) and setUnfilteredMaxFrequency()
This way the maximum frequency is decided by the Server. |
java.lang.String |
toString()
Returns a string representation of the table.
|
public static final java.lang.String MERGE
public static final java.lang.String DISTINCT
public static final java.lang.String RAW
public static final java.lang.String COMMAND
public SimpleTableInfo(java.lang.String group, java.lang.String schema, java.lang.String mode)
group
- Name of the Group of items in the table. It will be interpreted by the Metadata Adapter.schema
- Name of the Schema for all items in the table. It will be interpreted by the Metadata Adapter.mode
- Subscription mode for all items in the table. Can be one of the following:public void setSelector(java.lang.String selector)
selector
- name of a Selector. It will be interpreted by the Metadata Adapter.public void setDataAdapter(java.lang.String dataAdapter)
dataAdapter
- the name of the Data Adapter. A null value is
equivalent to the "DEFAULT" name.ConnectionInfo.setAdapter(java.lang.String)
public void setRequestedBufferSize(int bufferSize)
setUnlimitedBufferSize()
.bufferSize
- the size requested for the ItemEventBuffers; it should
be greater than 0.setUnlimitedBufferSize()
,
setRequestedMaxFrequency(double)
public void setUnlimitedBufferSize()
setRequestedBufferSize(int)
.public void setRequestedMaxFrequency(double maxFrequency)
setUnlimitedMaxFrequency()
and setUnfilteredMaxFrequency()
.maxFrequency
- the frequency requested for the items; it should
be greater than 0.setUnlimitedMaxFrequency()
,
setUnfilteredMaxFrequency()
public void setUnfilteredMaxFrequency()
setUnlimitedMaxFrequency()
and setRequestedMaxFrequency(double)
.public void setUnlimitedMaxFrequency()
setRequestedMaxFrequency(double)
and setUnfilteredMaxFrequency()
This way the maximum frequency is decided by the Server.public void setSnaspshotRequired(boolean required)
setDistinctSnapshotLength(int)
to specify the requested length of the snapshot.required
- true/false to request/not request snapshot delivery.
If false this method will also override setDistinctSnapshotLength settings.public void setDistinctSnapshotLength(int snapshotLength)
setSnaspshotRequired(boolean)
to true.snapshotLength
- the requested length of the snapshot; it should
be greater than 0.public void setItemsRange(int start, int end)
start
- 1-based index of the first item in the group that has to be subscribed.end
- 1-based index of the last item in the group that has to be subscribed.public java.lang.String getMode()
public java.lang.String getGroup()
public java.lang.String getSchema()
public boolean isSnapshotRequired()
setSnaspshotRequired(boolean)
,
setDistinctSnapshotLength(int)
public int getDistinctSnapshotLength()
setSnaspshotRequired(boolean)
,
setDistinctSnapshotLength(int)
public double getRequestedMaxFrequency()
setRequestedMaxFrequency(double)
,
setUnfilteredMaxFrequency()
,
setUnlimitedMaxFrequency()
public boolean isUnfilteredMaxFreq()
setRequestedMaxFrequency(double)
,
setUnfilteredMaxFrequency()
,
setUnlimitedMaxFrequency()
public boolean isUnlimitedMaxFreq()
setRequestedMaxFrequency(double)
,
setUnfilteredMaxFrequency()
,
setUnlimitedMaxFrequency()
public int getBuffSize()
setRequestedBufferSize(int)
,
setUnlimitedBufferSize()
public boolean isUnlimitedBufferSize()
setRequestedBufferSize(int)
,
setUnlimitedBufferSize()
public java.lang.String getSelector()
setSelector(String)
public java.lang.String getDataAdapter()
public int getStartRange()
public int getEndRange()
public java.lang.String toString()
toString
in class java.lang.Object