org.springframework.cassandra.core.keyspace

Class TableSpecification<T>

java.lang.Object

org.springframework.cassandra.core.keyspace.TableNameSpecification<TableOptionsSpecification<T>>

org.springframework.cassandra.core.keyspace.TableOptionsSpecification<TableSpecification<T>>

org.springframework.cassandra.core.keyspace.TableSpecification<T>

All Implemented Interfaces:

TableDescriptor

Direct Known Subclasses:

CreateTableSpecification, DefaultTableDescriptor

public class TableSpecification<T>
extends TableOptionsSpecification<TableSpecification<T>>
implements TableDescriptor

Builder class to support the construction of table specifications that have columns. This class can also be used as a standalone TableDescriptor, independent of CreateTableSpecification.

Author:

Matthew T. Adams, Alex Shvid

Field Summary

Fields inherited from class org.springframework.cassandra.core.keyspace.TableOptionsSpecification

options

Constructor Summary

Constructors

Constructor and Description
TableSpecification()

Method Summary

Methods

Modifier and Type	Method and Description
T	clusteredKeyColumn(CqlIdentifier name, com.datastax.driver.core.DataType type)
T	clusteredKeyColumn(CqlIdentifier name, com.datastax.driver.core.DataType type, Ordering ordering)
T	clusteredKeyColumn(String name, com.datastax.driver.core.DataType type) Adds the given primary key column to the table with ascending ordering.
T	clusteredKeyColumn(String name, com.datastax.driver.core.DataType type, Ordering ordering) Adds the given primary key column to the table with the given ordering (null meaning ascending).
T	column(CqlIdentifier name, com.datastax.driver.core.DataType type)
protected T	column(CqlIdentifier name, com.datastax.driver.core.DataType type, PrimaryKeyType keyType, Ordering ordering)
T	column(String name, com.datastax.driver.core.DataType type) Adds the given non-key column to the table.
protected T	column(String name, com.datastax.driver.core.DataType type, PrimaryKeyType keyType, Ordering ordering) Adds the given info as a new column to the table.
List<ColumnSpecification>	getClusteredKeyColumns() Returns an unmodifiable list of all primary key columns that are not also partition key columns.
List<ColumnSpecification>	getColumns() Returns an unmodifiable list of all columns.
List<ColumnSpecification>	getNonKeyColumns() Returns an unmodifiable list of all non-key columns.
List<ColumnSpecification>	getPartitionKeyColumns() Returns an unmodifiable list of all partition key columns.
List<ColumnSpecification>	getPrimaryKeyColumns() Returns an unmodifiable list of all primary key columns that are not also partition key columns.
T	partitionKeyColumn(CqlIdentifier name, com.datastax.driver.core.DataType type)
T	partitionKeyColumn(String name, com.datastax.driver.core.DataType type) Adds the given partition key column to the table.

Methods inherited from class org.springframework.cassandra.core.keyspace.TableOptionsSpecification

getOptions, name, name, with, with, with

Methods inherited from class org.springframework.cassandra.core.keyspace.TableNameSpecification

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cassandra.core.keyspace.TableDescriptor

getName, getOptions

Constructor Detail

TableSpecification

public TableSpecification()

Method Detail

column

public T column(String name,
       com.datastax.driver.core.DataType type)

Adds the given non-key column to the table. Must be specified after all primary key columns.

Parameters:

name - The column name; must be a valid unquoted or quoted identifier without the surrounding double quotes.

type - The data type of the column.

column

public T column(CqlIdentifier name,
       com.datastax.driver.core.DataType type)

partitionKeyColumn

public T partitionKeyColumn(String name,
                   com.datastax.driver.core.DataType type)

Adds the given partition key column to the table. Must be specified before any other columns.

Parameters:

name - The column name; must be a valid unquoted or quoted identifier without the surrounding double quotes.

type - The data type of the column.

Returns:

this

partitionKeyColumn

public T partitionKeyColumn(CqlIdentifier name,
                   com.datastax.driver.core.DataType type)

clusteredKeyColumn

public T clusteredKeyColumn(String name,
                   com.datastax.driver.core.DataType type)

Adds the given primary key column to the table with ascending ordering. Must be specified after all partition key columns and before any non-key columns.

Parameters:

name - The column name; must be a valid unquoted or quoted identifier without the surrounding double quotes.

type - The data type of the column.

Returns:

this

clusteredKeyColumn

public T clusteredKeyColumn(CqlIdentifier name,
                   com.datastax.driver.core.DataType type)

clusteredKeyColumn

public T clusteredKeyColumn(String name,
                   com.datastax.driver.core.DataType type,
                   Ordering ordering)

Adds the given primary key column to the table with the given ordering (null meaning ascending). Must be specified after all partition key columns and before any non-key columns.

Parameters:

name - The column name; must be a valid unquoted or quoted identifier without the surrounding double quotes.

type - The data type of the column.

Returns:

this

clusteredKeyColumn

public T clusteredKeyColumn(CqlIdentifier name,
                   com.datastax.driver.core.DataType type,
                   Ordering ordering)

column

protected T column(String name,
       com.datastax.driver.core.DataType type,
       PrimaryKeyType keyType,
       Ordering ordering)

Adds the given info as a new column to the table. Partition key columns must precede primary key columns, which must precede non-key columns.

Parameters:

name - The column name; must be a valid unquoted or quoted identifier without the surrounding double quotes.

type - The data type of the column.

keyType - Indicates key type. Null means that the column is not a key column.

ordering - If the given PrimaryKeyType is PrimaryKeyType.CLUSTERED, then the given ordering is used, else ignored.

Returns:

this

column

protected T column(CqlIdentifier name,
       com.datastax.driver.core.DataType type,
       PrimaryKeyType keyType,
       Ordering ordering)

getColumns

public List<ColumnSpecification> getColumns()

Returns an unmodifiable list of all columns.

Specified by:

getColumns in interface TableDescriptor

getPartitionKeyColumns

public List<ColumnSpecification> getPartitionKeyColumns()

Returns an unmodifiable list of all partition key columns.

Specified by:

getPartitionKeyColumns in interface TableDescriptor

getClusteredKeyColumns

public List<ColumnSpecification> getClusteredKeyColumns()

Returns an unmodifiable list of all primary key columns that are not also partition key columns.

Specified by:

getClusteredKeyColumns in interface TableDescriptor

getPrimaryKeyColumns

public List<ColumnSpecification> getPrimaryKeyColumns()

Returns an unmodifiable list of all primary key columns that are not also partition key columns.

Specified by:

getPrimaryKeyColumns in interface TableDescriptor

getNonKeyColumns

public List<ColumnSpecification> getNonKeyColumns()

Returns an unmodifiable list of all non-key columns.

Specified by:

getNonKeyColumns in interface TableDescriptor