org.springframework.cassandra.core.keyspace

Class CreateIndexSpecification

java.lang.Object

org.springframework.cassandra.core.keyspace.IndexNameSpecification<CreateIndexSpecification>

org.springframework.cassandra.core.keyspace.CreateIndexSpecification

All Implemented Interfaces:

IndexDescriptor

public class CreateIndexSpecification
extends IndexNameSpecification<CreateIndexSpecification>
implements IndexDescriptor

Builder class to construct a CREATE INDEX specification.

Author:

Matthew T. Adams, David Webb

Constructor Summary

Constructors

Constructor and Description
CreateIndexSpecification()

Method Summary

Modifier and Type	Method and Description
CreateIndexSpecification	columnName(CqlIdentifier columnName)
CreateIndexSpecification	columnName(String columnName)
static CreateIndexSpecification	createIndex() Entry point into the CreateIndexSpecification's fluent API to create a index.
static CreateIndexSpecification	createIndex(CqlIdentifier name) Entry point into the CreateIndexSpecification's fluent API to create a index.
static CreateIndexSpecification	createIndex(String name) Entry point into the CreateIndexSpecification's fluent API to create a index.
CqlIdentifier	getColumnName()
boolean	getIfNotExists()
CqlIdentifier	getTableName() Returns the table name for the index
String	getUsing()
CreateIndexSpecification	ifNotExists() Causes the inclusion of an IF NOT EXISTS clause.
CreateIndexSpecification	ifNotExists(boolean ifNotExists) Toggles the inclusion of an IF NOT EXISTS clause.
boolean	isCustom()
CreateIndexSpecification	tableName(CqlIdentifier tableName)
CreateIndexSpecification	tableName(String tableName) Sets the table name.
CreateIndexSpecification	using(String className)

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

getName, name, name

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.IndexDescriptor

getName

Constructor Detail

CreateIndexSpecification

public CreateIndexSpecification()

Method Detail

createIndex

public static CreateIndexSpecification createIndex()

Entry point into the CreateIndexSpecification's fluent API to create a index. Convenient if imported statically.

createIndex

public static CreateIndexSpecification createIndex(CqlIdentifier name)

Entry point into the CreateIndexSpecification's fluent API to create a index. Convenient if imported statically.

createIndex

public static CreateIndexSpecification createIndex(String name)

Entry point into the CreateIndexSpecification's fluent API to create a index. Convenient if imported statically.

ifNotExists

public CreateIndexSpecification ifNotExists()

Causes the inclusion of an IF NOT EXISTS clause.

Returns:

this

ifNotExists

public CreateIndexSpecification ifNotExists(boolean ifNotExists)

Toggles the inclusion of an IF NOT EXISTS clause.

Returns:

this

getIfNotExists

public boolean getIfNotExists()

isCustom

public boolean isCustom()

Specified by:

isCustom in interface IndexDescriptor

using

public CreateIndexSpecification using(String className)

getUsing

public String getUsing()

Specified by:

getUsing in interface IndexDescriptor

getColumnName

public CqlIdentifier getColumnName()

Specified by:

getColumnName in interface IndexDescriptor

tableName

public CreateIndexSpecification tableName(String tableName)

Sets the table name.

Returns:

this

tableName

public CreateIndexSpecification tableName(CqlIdentifier tableName)

getTableName

public CqlIdentifier getTableName()

Description copied from interface: IndexDescriptor

Returns the table name for the index

Specified by:

getTableName in interface IndexDescriptor

columnName

public CreateIndexSpecification columnName(String columnName)

columnName

public CreateIndexSpecification columnName(CqlIdentifier columnName)