public interface Table
Modifier and Type | Field and Description |
---|---|
static String |
CAPABILITIES_FIELD |
static EnumSet<LiveViewTableCapability> |
DEFAULT_CAPABILITIES |
static String |
DESCRIPTION_FIELD |
static String |
FIELDLIST_FIELD |
static String |
GROUP_FIELD |
static String |
INDICES |
static String |
IS_ENABLED_FIELD |
static String |
KEY_FIELDS_CSV |
static EnumSet<LiveViewQueryLanguage> |
LIVEVIEW_LANGUAGE_ONLY |
static String |
NAME_FIELD |
static String |
QUERY_LANGUAGES_FIELD |
static String |
REQUIRED_CLIENT_CAPABILITIES |
static String |
SHORT_DESCRIPTION_FIELD |
static String |
SYS_TABLES_GROUP |
static String |
TABLE_SCHEMA_FIELD |
static String |
TABLE_SPACE_FIELD |
static String |
TABLES_TABLE_NAME
A special group used to identify system tables in LiveView.
|
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
A description of the table
|
List<Schema.Field> |
getFields()
Returns the fields describing the table columns.
|
List<Schema.Field> |
getFields(boolean includeInternal)
Returns the fields describing the table columns.
|
String |
getGroup()
A table can be assigned to a logical group.
|
List<List<String>> |
getIndices()
Returns all the indices for the table.
|
List<Schema.Field> |
getKeyFields()
Returns the schema which describes the key for the records in this table.
|
String |
getName()
The name of the table.
|
EnumSet<LiveViewQueryLanguage> |
getQueryLanguages()
Returns the languages that can be used for queries against this table.
|
String |
getShortDescription()
A short description of the table
|
EnumSet<LiveViewTableCapability> |
getTableCapabilities()
Returns the capabilities that this Table supports.
|
TablePublisher |
getTablePublisher(String publisherName)
Retrieve a publisher instance allowing a client to publish data to this table with the default buffer size
TablePublisher.PUBLISH_BUFFER_SIZE_DEFAULT and
flush interval TablePublisher.PUBLISH_INTERVAL_DEFAULT . |
TablePublisher |
getTablePublisher(String publisherName,
int bufferSize,
long flushInterval,
TimeUnit flushIntervalTimeUnit)
Retrieve a publisher instance allowing the client to publish data to the table.
|
Collection<String> |
getUnmetClientCapabilities()
Every table might have requiredClientCapabilities which
|
boolean |
isEnabled()
Sometimes Tables will be disabled, because the Container that they are in has been shut down.
|
static final String TABLES_TABLE_NAME
static final String NAME_FIELD
static final String GROUP_FIELD
static final String TABLE_SPACE_FIELD
static final String DESCRIPTION_FIELD
static final String SHORT_DESCRIPTION_FIELD
static final String QUERY_LANGUAGES_FIELD
static final String CAPABILITIES_FIELD
static final String IS_ENABLED_FIELD
static final String FIELDLIST_FIELD
static final String TABLE_SCHEMA_FIELD
static final String KEY_FIELDS_CSV
static final String REQUIRED_CLIENT_CAPABILITIES
static final String INDICES
static final String SYS_TABLES_GROUP
static final EnumSet<LiveViewQueryLanguage> LIVEVIEW_LANGUAGE_ONLY
static final EnumSet<LiveViewTableCapability> DEFAULT_CAPABILITIES
String getName()
String getGroup()
String getShortDescription()
String getDescription()
List<Schema.Field> getFields()
List<Schema.Field> getFields(boolean includeInternal)
includeInternal
- specifies whether to include system internal fields in the listList<Schema.Field> getKeyFields()
EnumSet<LiveViewQueryLanguage> getQueryLanguages()
LiveViewQueryLanguage
EnumSet<LiveViewTableCapability> getTableCapabilities()
LiveViewTableCapability
TablePublisher getTablePublisher(String publisherName)
TablePublisher.PUBLISH_BUFFER_SIZE_DEFAULT
and
flush interval TablePublisher.PUBLISH_INTERVAL_DEFAULT
.publisherName
- assigns a name to the publisher. Data published will include the publisher
name for tracking and recoverability purposes.TablePublisher getTablePublisher(String publisherName, int bufferSize, long flushInterval, TimeUnit flushIntervalTimeUnit)
publisherName
- assigns a name to the publisher. Data published will include the publisher
name for tracking and recoverability purposes.bufferSize
- number of tuples to buffer client side before sending to server. A higher number
produces better throughput but higher latency. Ignored for LowLatencyPublisherflushInterval
- The interval between flushing the buffered tuples if the buffer does not completely fill. If a flushInterval
of less than or equal to zero specified, a low latency TablePublisher implementation will be used to sends data to the server
on the client's thread. Note the LowLatencyPublisher ignores bufferSize.flushIntervalTimeUnit
- The time unit of the flush intervalboolean isEnabled()
Collection<String> getUnmetClientCapabilities()
List<List<String>> getIndices()