Index (fdb-relational-api 4.1.4.0 API)

All Superinterfaces:

Metadata
```
public interface Index
extends Metadata
```
An Index metadata that contains information an underlying index data structure of a Table.
This currently targets only table-specific indexes and not universal indexes. However, it can be extended to cover universal indexes if need be.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`accept(Visitor visitor)`
`java.lang.String`	`getIndexType()`	Returns the type of the index.
`java.lang.String`	`getTableName()`	Returns the name of the `Table` that owns the `index`.
`boolean`	`isSparse()`	Checks whether the index is sparse or not.
`boolean`	`isUnique()`	Checks whether the index is unique.

Methods inherited from interface com.apple.foundationdb.relational.api.metadata.Metadata
getName

- Method Detail
  - getTableName
```
@Nonnull
java.lang.String getTableName()
```
    Returns the name of the Table that owns the index.
    
    Returns:
    
    The name of the Table that owns the index.
  - getIndexType
```
@Nonnull
java.lang.String getIndexType()
```
    Returns the type of the index. An index type could be one of the types defined in com.apple.foundationdb.record.metadata.IndexTypes.
    
    Returns:
    
    the type of the index.
  - isUnique
```
boolean isUnique()
```
    Checks whether the index is unique.
    
    Returns:
    
    True if the index is unique, otherwise False.
  - isSparse
```
boolean isSparse()
```
    Checks whether the index is sparse or not.
    
    Returns:
    
    True if the index is sparse, otherwise False.
  - accept
```
default void accept(@Nonnull
                    Visitor visitor)
```
    Specified by:
    
    accept in interface Metadata