org.springframework.data.redis.core.index

Class IndexConfiguration

java.lang.Object

org.springframework.data.redis.core.index.IndexConfiguration

All Implemented Interfaces:

ConfigurableIndexDefinitionProvider, IndexDefinitionProvider, IndexDefinitionRegistry

public class IndexConfiguration
extends Object
implements ConfigurableIndexDefinitionProvider

IndexConfiguration allows programmatic setup of indexes. This is suitable for cases where there is no option to use the equivalent Indexed annotation.

Since:

1.7

Author:

Christoph Strobl, Rob Winch

Constructor Summary

Constructors

Constructor and Description
IndexConfiguration() Creates new empty IndexConfiguration.

Method Summary

Modifier and Type	Method and Description
void	addIndexDefinition(IndexDefinition indexDefinition) Add given RedisIndexSetting.
Set<IndexDefinition>	getIndexDefinitionsFor(Serializable keyspace) Get the list of IndexDefinition for a given keyspace.
Set<IndexDefinition>	getIndexDefinitionsFor(Serializable keyspace, String path) Get the list of IndexDefinition for a given keyspace and property path.
boolean	hasIndexFor(Serializable keyspace) Checks if an index is defined for a given keyspace.
boolean	hasIndexFor(Serializable keyspace, String path) Checks if an index is defined for a given keyspace and property path.
protected Iterable<? extends IndexDefinition>	initialConfiguration() Customization hook.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexConfiguration

public IndexConfiguration()

Creates new empty IndexConfiguration.

Method Detail

hasIndexFor

public boolean hasIndexFor(Serializable keyspace)

Description copied from interface: IndexDefinitionProvider

Checks if an index is defined for a given keyspace.

Specified by:

hasIndexFor in interface IndexDefinitionProvider

Parameters:

keyspace - the keyspace to get

Returns:

never null

hasIndexFor

public boolean hasIndexFor(Serializable keyspace,
                           String path)

Description copied from interface: IndexDefinitionProvider

Checks if an index is defined for a given keyspace and property path.

Specified by:

hasIndexFor in interface IndexDefinitionProvider

Returns:

true if index is defined.

getIndexDefinitionsFor

public Set<IndexDefinition> getIndexDefinitionsFor(Serializable keyspace,
                                                   String path)

Description copied from interface: IndexDefinitionProvider

Get the list of IndexDefinition for a given keyspace and property path.

Specified by:

getIndexDefinitionsFor in interface IndexDefinitionProvider

Returns:

never null.

getIndexDefinitionsFor

public Set<IndexDefinition> getIndexDefinitionsFor(Serializable keyspace)

Description copied from interface: IndexDefinitionProvider

Get the list of IndexDefinition for a given keyspace.

Specified by:

getIndexDefinitionsFor in interface IndexDefinitionProvider

Returns:

never null.

addIndexDefinition

public void addIndexDefinition(IndexDefinition indexDefinition)

Description copied from interface: IndexDefinitionRegistry

Add given RedisIndexSetting.

Specified by:

addIndexDefinition in interface IndexDefinitionRegistry

Parameters:

indexDefinition - must not be null.

initialConfiguration

protected Iterable<? extends IndexDefinition> initialConfiguration()

Customization hook.

Returns:

must not return null.