Package com.terracottatech.store.indexing

Interface Index<T extends Comparable<T>>

Type Parameters:

T - data type being indexed

public interface Index<T extends Comparable<T>>

Representation of an index.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Index.Status	Status of an index.

Method Summary

Modifier and Type	Method	Description
IndexSettings	definition()	IndexSettings for this index.
CellDefinition<T>	on()	CellDefinition for the cells that are being indexed by this index.
Index.Status	status()	Index.Status for this index.

Method Details

on

CellDefinition<T> on()

CellDefinition for the cells that are being indexed by this index.

Returns:

indexed cell definition

definition

IndexSettings definition()

IndexSettings for this index.

Returns:

index settings

status

Index.Status status()

Index.Status for this index.

Returns:

index status