IndexMetadata (DataStax Java Driver for Apache Cassandra

java.lang.Object
- com.datastax.driver.core.IndexMetadata

```
public class IndexMetadata
extends Object
```
An immutable representation of secondary index metadata.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IndexMetadata.IndexType

static class IndexMetadata.TargetType

Nested Classes
Modifier and Type	Class and Description
`static class`	`IndexMetadata.IndexType`
`static class`	`IndexMetadata.TargetType`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CUSTOM_INDEX_OPTION_NAME`
`static String`	`INDEX_ENTRIES_OPTION_NAME` The name of the option used to specify that the index is on the collection (map) entries.
`static String`	`INDEX_KEYS_OPTION_NAME` The name of the option used to specify that the index is on the collection keys.
`static com.google.common.base.Function<IndexMetadata,String>`	`INDEX_NAME`
`static String`	`INDEX_VALUES_OPTION_NAME` The name of the option used to specify that the index is on the collection values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asCQLQuery()` Returns a CQL query representing this index.
`boolean`	`equals(Object obj)`
`ColumnMetadata`	`getColumn(String name)` Returns metadata on a column of this index.
`List<ColumnMetadata>`	`getColumns()` Returns a list containing all the columns of this index.
`String`	`getIndexClassName()` The name of the class used to implement the custom index, if it is one.
`IndexMetadata.IndexType`	`getIndexType()` Returns the index type.
`String`	`getName()` Returns the index name.
`String`	`getOption(String name)` Return the value for the given option name.
`TableMetadata`	`getTable()` Returns the metadata of the table this column is part of.
`IndexMetadata.TargetType`	`getTargetType()` Returns the index target type.
`int`	`hashCode()`
`boolean`	`isCustomIndex()` Returns whether this index is a custom one.
`boolean`	`isEntries()` Return whether this index is a 'ENTRIES' index on a map, e.g., CREATE INDEX ON mytable (ENTRIES(mymap))
`boolean`	`isFull()` Return whether this index is a 'FULL' index on a frozen collection, e.g., CREATE INDEX ON mytable (FULL(mymap))
`boolean`	`isKeys()` Return whether this index is a 'KEYS' index on a map, e.g., CREATE INDEX ON mytable (KEYS(mymap))
`boolean`	`isValues()` Return whether this index is a 'VALUES' index on a map, e.g., CREATE INDEX ON mytable (VALUES(mymap))

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INDEX_NAME
```
public static final com.google.common.base.Function<IndexMetadata,String> INDEX_NAME
```
  - CUSTOM_INDEX_OPTION_NAME
```
public static final String CUSTOM_INDEX_OPTION_NAME
```
    See Also:
    
    Constant Field Values
  - INDEX_KEYS_OPTION_NAME
```
public static final String INDEX_KEYS_OPTION_NAME
```
    The name of the option used to specify that the index is on the collection keys.
    
    See Also:
    
    Constant Field Values
  - INDEX_VALUES_OPTION_NAME
```
public static final String INDEX_VALUES_OPTION_NAME
```
    The name of the option used to specify that the index is on the collection values.
    
    See Also:
    
    Constant Field Values
  - INDEX_ENTRIES_OPTION_NAME
```
public static final String INDEX_ENTRIES_OPTION_NAME
```
    The name of the option used to specify that the index is on the collection (map) entries.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getTable
```
public TableMetadata getTable()
```
    Returns the metadata of the table this column is part of.
    
    Returns:
    
    the TableMetadata for the table this column is part of.
  - getName
```
public String getName()
```
    Returns the index name.
    
    Returns:
    
    the index name.
  - getColumn
```
public ColumnMetadata getColumn(String name)
```
    Returns metadata on a column of this index.
    
    Parameters:
    
    name - the name of the column to retrieve (name will be interpreted as a case-insensitive identifier unless enclosed in double-quotes, see Metadata.quote(java.lang.String)).
    
    Returns:
    
    the metadata for the column if it exists, or null otherwise.
  - getColumns
```
public List<ColumnMetadata> getColumns()
```
    Returns a list containing all the columns of this index. The order of the columns in the list is consistent with the order of the columns in the index.
    
    Returns:
    
    a list containing the metadata for the columns of this table.
  - getIndexType
```
public IndexMetadata.IndexType getIndexType()
```
    Returns the index type.
    
    Returns:
    
    the index type.
  - getTargetType
```
public IndexMetadata.TargetType getTargetType()
```
    Returns the index target type. Note: for legacy indexes, this is always IndexMetadata.TargetType.COLUMN.
    
    Returns:
    
    the index target type.
  - isCustomIndex
```
public boolean isCustomIndex()
```
    Returns whether this index is a custom one.
    If it is indeed a custom index, getIndexClassName() will return the name of the class used in Cassandra to implement that index.
    
    Returns:
    
    true if this metadata represents a custom index.
  - getIndexClassName
```
public String getIndexClassName()
```
    The name of the class used to implement the custom index, if it is one.
    
    Returns:
    
    the name of the class used Cassandra side to implement this custom index if isCustomIndex() == true, null otherwise.
  - isKeys
```
public boolean isKeys()
```
    Return whether this index is a 'KEYS' index on a map, e.g., CREATE INDEX ON mytable (KEYS(mymap))
    
    Returns:
    
    true if this is a 'KEYS' index on a map.
  - isValues
```
public boolean isValues()
```
    Return whether this index is a 'VALUES' index on a map, e.g., CREATE INDEX ON mytable (VALUES(mymap))
    
    Returns:
    
    true if this is an 'VALUES' index on a map.
  - isEntries
```
public boolean isEntries()
```
    Return whether this index is a 'ENTRIES' index on a map, e.g., CREATE INDEX ON mytable (ENTRIES(mymap))
    
    Returns:
    
    true if this is an 'ENTRIES' index on a map.
  - isFull
```
public boolean isFull()
```
    Return whether this index is a 'FULL' index on a frozen collection, e.g., CREATE INDEX ON mytable (FULL(mymap))
    
    Returns:
    
    true if this is a 'FULL' index on a frozen collection.
  - getOption
```
public String getOption(String name)
```
    Return the value for the given option name.
    
    Parameters:
    
    name - Option name
    
    Returns:
    
    Option value
  - asCQLQuery
```
public String asCQLQuery()
```
    Returns a CQL query representing this index. This method returns a single 'CREATE INDEX' query corresponding to this index definition.
    
    Returns:
    
    the 'CREATE INDEX' query corresponding to this index.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class IndexMetadata

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INDEX_NAME

CUSTOM_INDEX_OPTION_NAME

INDEX_KEYS_OPTION_NAME

INDEX_VALUES_OPTION_NAME

INDEX_ENTRIES_OPTION_NAME

Method Detail

getTable

getName

getColumn

getColumns

getIndexType

getTargetType

isCustomIndex

getIndexClassName

isKeys

isValues

isEntries

isFull

getOption

asCQLQuery

hashCode

equals