org.modeshape.jcr.spi.index.provider

Interface ProvidedIndex<T>

Type Parameters:

T - the type of the values handled by this index or Object in the case of multi-column indexes.

All Superinterfaces:

Costable, Filter, Lifecycle, Reindexable

All Known Implementing Classes:

EsIndex, LocalIndex, LuceneIndex

public interface ProvidedIndex<T>
extends Filter, Costable, Reindexable, Lifecycle

Interface that should be implemented by different index providers which provide specific index IndexDefinition.IndexKind to the repository.

Since:

4.5

Nested Class Summary

Nested classes/interfaces inherited from interface org.modeshape.jcr.spi.index.provider.Filter

Filter.Results

Method Summary

Modifier and Type	Method and Description
void	add(String nodeKey, String propertyName, T value) Adds a single value to this index for the given node.
void	add(String nodeKey, String propertyName, T[] values) Adds multiple values to the index for the given node.
void	commit() Commits any potential changes made by the add/remove/update operations to this index.
String	getName() Get the name of the index.
void	remove(String nodeKey) Removes the given node from the index.
void	remove(String nodeKey, String propertyName, T value) Removes a value for the given node from the index.
void	remove(String nodeKey, String propertyName, T[] values) Removes multiple values from the index for the given node.

Methods inherited from interface org.modeshape.jcr.spi.index.provider.Filter

filter

Methods inherited from interface org.modeshape.jcr.spi.index.provider.Costable

estimateCardinality, estimateTotalCount

Methods inherited from interface org.modeshape.jcr.spi.index.provider.Reindexable

clearAllData, requiresReindexing

Methods inherited from interface org.modeshape.jcr.spi.index.provider.Lifecycle

shutdown

Method Detail

add

void add(String nodeKey,
         String propertyName,
         T value)

Adds a single value to this index for the given node.

Parameters:

nodeKey - a NodeKey instance, never null

propertyName - the name for which the value is removed, never null but certain providers may ignore the value. Most of the times this is the real JCR property name, but for some index types (e.g. node types index) this may be something else (e.g. the name of the index)

value - an Object instance, never null

add

void add(String nodeKey,
         String propertyName,
         T[] values)

Adds multiple values to the index for the given node.

Parameters:

nodeKey - a NodeKey instance, never null

propertyName - the name for which the value is removed, never null but certain providers may ignore the value. Most of the times this is the real JCR property name, but for some index types (e.g. node types index) this may be something else (e.g. the name of the index)

values - an array of values, never null or empty

remove

void remove(String nodeKey)

Removes the given node from the index.

Parameters:

nodeKey - a NodeKey instance, never null

remove

void remove(String nodeKey,
            String propertyName,
            T value)

Removes a value for the given node from the index.

Parameters:

nodeKey - a NodeKey instance, never null

propertyName - the name for which the value is removed, never null but certain providers may ignore the value. Most of the times this is the real JCR property name, but for some index types (e.g. node types index) this may be something else (e.g. the name of the index)

value - the value to remove from the index for this node, never null

remove

void remove(String nodeKey,
            String propertyName,
            T[] values)

Removes multiple values from the index for the given node.

Parameters:

nodeKey - a NodeKey instance, never null

propertyName - the name for which the value is removed, never null but certain providers may ignore the value. Most of the times this is the real JCR property name, but for some index types (e.g. node types index) this may be something else (e.g. the name of the index)

values - the values to remove, never null or empty

commit

void commit()

Commits any potential changes made by the add/remove/update operations to this index.

getName

String getName()

Get the name of the index.

Returns:

the index name; never null