com.basho.riak.client.core.query.timeseries

Class TableDefinition

java.lang.Object

com.basho.riak.client.core.query.timeseries.TableDefinition

public class TableDefinition
extends Object

Holds a definition for a Table in Time Series Riak. Immutable once created.

Since:

2.0.4

Author:

Alex Moore

Constructor Summary

Constructors

Constructor and Description
TableDefinition(String tableName, Iterable<FullColumnDescription> fullColumnDescriptions) Create a new Table Definition

Method Summary

Modifier and Type	Method and Description
FullColumnDescription	getDescriptionByColumnName(String columnName) Look up a FullColumnDescription in this TableDefinition by it's column name.
Collection<FullColumnDescription>	getFullColumnDescriptions() Get the ordered list of full column descriptions for this definition.
Collection<FullColumnDescription>	getLocalKeyColumnDescriptions() Get the collection of Local Key FullColumnDescriptions, in order.
Collection<FullColumnDescription>	getPartitionKeyColumnDescriptions() Get the collection of Partition Key FullColumnDescriptions, in order.
FullColumnDescription	getQuantumDescription() Get the FullColumnDescription for a quantum field, if any.
String	getTableName() Get the table name for this definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableDefinition

public TableDefinition(String tableName,
                       Iterable<FullColumnDescription> fullColumnDescriptions)

Create a new Table Definition

Parameters:

tableName - a Table Name, required.

fullColumnDescriptions - a list of FullColumnDescription that represents the columns in the table.

Method Detail

getTableName

public String getTableName()

Get the table name for this definition.

Returns:

a String table name.

getFullColumnDescriptions

public Collection<FullColumnDescription> getFullColumnDescriptions()

Get the ordered list of full column descriptions for this definition.

Returns:

a List of the FullColumnDescription in this definition.

getDescriptionByColumnName

public FullColumnDescription getDescriptionByColumnName(String columnName)

Look up a FullColumnDescription in this TableDefinition by it's column name.

Parameters:

columnName - the column name to look up.

Returns:

the matching FullColumnDescription. Returns null if no column with that name exists.

getPartitionKeyColumnDescriptions

public Collection<FullColumnDescription> getPartitionKeyColumnDescriptions()

Get the collection of Partition Key FullColumnDescriptions, in order.

Returns:

an iterable collection.

getQuantumDescription

public FullColumnDescription getQuantumDescription()

Get the FullColumnDescription for a quantum field, if any.

Returns:

null if there is no quantum information

getLocalKeyColumnDescriptions

public Collection<FullColumnDescription> getLocalKeyColumnDescriptions()

Get the collection of Local Key FullColumnDescriptions, in order.

Returns:

an iterable collection.