org.modeshape.jcr.spi.index.provider

Interface ManagedIndex

All Superinterfaces:

Costable, Filter, Lifecycle, Reindexable

All Known Implementing Classes:

DefaultManagedIndex

public interface ManagedIndex
extends Filter, Costable, Lifecycle, Reindexable

The top-level interface for an index owned by a provider, with common methods needed by indexes regardless of number of columns.

Index providers may choose to implement this from scratch and return it to the repository, or they may choose to implement a ManagedIndexBuilder instance and use an DefaultManagedIndex instance to wrap their ProvidedIndex instances.

See Also:

ManagedIndexBuilder, ProvidedIndex

Nested Class Summary

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

Filter.ResultBatch, Filter.Results

Method Summary

Modifier and Type	Method and Description
void	enable(boolean enable) Mark whether this index is enabled for use, or not enabled meaning it should not be used.
IndexChangeAdapter	getIndexChangeAdapter() Get the ChangeSetAdapter implementation through which changes to content are sent to the index.
IndexManager.IndexStatus	getStatus() Return the current status of the managed index
boolean	isEnabled() Determine if this index is enabled for use.
void	updateStatus(IndexManager.IndexStatus currentStatus, IndexManager.IndexStatus newStatus) Update the status of this index to a new value if the current status is currentStatus

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.Lifecycle

shutdown

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

clearAllData, requiresReindexing

Method Detail

getIndexChangeAdapter

IndexChangeAdapter getIndexChangeAdapter()

Get the ChangeSetAdapter implementation through which changes to content are sent to the index. Each local index has an ChangeSetListener that is registered on the event bus and kept throughout the lifetime of the index (even if there are changes), and that listener delegates to this adapter.

Returns:

the adapter; never null

enable

void enable(boolean enable)

Mark whether this index is enabled for use, or not enabled meaning it should not be used.

Parameters:

enable - true if the index is to be enabled, or false otherwise

isEnabled

boolean isEnabled()

Determine if this index is enabled for use.

Returns:

true if enabled, or false otherwise

getStatus

IndexManager.IndexStatus getStatus()

Return the current status of the managed index

Returns:

a IndexManager.IndexStatus instance, never null

updateStatus

void updateStatus(IndexManager.IndexStatus currentStatus,
                  IndexManager.IndexStatus newStatus)

Update the status of this index to a new value if the current status is currentStatus

Parameters:

currentStatus - a IndexManager.IndexStatus instance, may not be null

newStatus - a IndexManager.IndexStatus instance, may not be null