org.apache.jackrabbit.oak.plugins.index.lucene

Class LuceneIndexEditorProvider

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.lucene.LuceneIndexEditorProvider

All Implemented Interfaces:

IndexEditorProvider

public class LuceneIndexEditorProvider
extends java.lang.Object
implements IndexEditorProvider

Service that provides Lucene based IndexEditors

See Also:

LuceneIndexEditor, IndexEditorProvider

Constructor Summary

Constructors

Constructor and Description
LuceneIndexEditorProvider()
LuceneIndexEditorProvider(@Nullable IndexCopier indexCopier)
LuceneIndexEditorProvider(@Nullable IndexCopier indexCopier, org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache extractedTextCache)
LuceneIndexEditorProvider(@Nullable IndexCopier indexCopier, org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache extractedTextCache, @Nullable IndexAugmentorFactory augmentorFactory, MountInfoProvider mountInfoProvider)
LuceneIndexEditorProvider(@Nullable IndexCopier indexCopier, @Nullable IndexTracker indexTracker, org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache extractedTextCache, @Nullable IndexAugmentorFactory augmentorFactory, MountInfoProvider mountInfoProvider)
LuceneIndexEditorProvider(@Nullable IndexCopier indexCopier, @Nullable IndexTracker indexTracker, org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache extractedTextCache, @Nullable IndexAugmentorFactory augmentorFactory, MountInfoProvider mountInfoProvider, org.apache.jackrabbit.oak.plugins.index.lucene.directory.ActiveDeletedBlobCollectorFactory.ActiveDeletedBlobCollector activeDeletedBlobCollector, @Nullable LuceneIndexMBean mbean, @Nullable StatisticsProvider statisticsProvider)

Method Summary

Modifier and Type	Method and Description
org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache	getExtractedTextCache()
Editor	getIndexEditor(@NotNull java.lang.String type, @NotNull NodeBuilder definition, @NotNull NodeState root, @NotNull IndexUpdateCallback callback) Each provider knows how to produce a certain type of index.
void	setBlobStore(@Nullable GarbageCollectableBlobStore blobStore)
void	setIndexingQueue(org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.IndexingQueue indexingQueue)
void	setInMemoryDocsLimit(int inMemoryDocsLimit)
void	setWriterConfig(org.apache.jackrabbit.oak.plugins.index.lucene.writer.LuceneIndexWriterConfig writerConfig)
LuceneIndexEditorProvider	withAsyncIndexesSizeStatsUpdate(AsyncIndexesSizeStatsUpdate asyncIndexesSizeStatsUpdate)

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneIndexEditorProvider

public LuceneIndexEditorProvider()

LuceneIndexEditorProvider

public LuceneIndexEditorProvider(@Nullable
                                 @Nullable IndexCopier indexCopier)

LuceneIndexEditorProvider

public LuceneIndexEditorProvider(@Nullable
                                 @Nullable IndexCopier indexCopier,
                                 org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache extractedTextCache)

LuceneIndexEditorProvider

public LuceneIndexEditorProvider(@Nullable
                                 @Nullable IndexCopier indexCopier,
                                 org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache extractedTextCache,
                                 @Nullable
                                 @Nullable IndexAugmentorFactory augmentorFactory,
                                 MountInfoProvider mountInfoProvider)

LuceneIndexEditorProvider

public LuceneIndexEditorProvider(@Nullable
                                 @Nullable IndexCopier indexCopier,
                                 @Nullable
                                 @Nullable IndexTracker indexTracker,
                                 org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache extractedTextCache,
                                 @Nullable
                                 @Nullable IndexAugmentorFactory augmentorFactory,
                                 MountInfoProvider mountInfoProvider)

LuceneIndexEditorProvider

public LuceneIndexEditorProvider(@Nullable
                                 @Nullable IndexCopier indexCopier,
                                 @Nullable
                                 @Nullable IndexTracker indexTracker,
                                 org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache extractedTextCache,
                                 @Nullable
                                 @Nullable IndexAugmentorFactory augmentorFactory,
                                 MountInfoProvider mountInfoProvider,
                                 @NotNull
                                 org.apache.jackrabbit.oak.plugins.index.lucene.directory.ActiveDeletedBlobCollectorFactory.ActiveDeletedBlobCollector activeDeletedBlobCollector,
                                 @Nullable
                                 @Nullable LuceneIndexMBean mbean,
                                 @Nullable
                                 @Nullable StatisticsProvider statisticsProvider)

Method Detail

withAsyncIndexesSizeStatsUpdate

public LuceneIndexEditorProvider withAsyncIndexesSizeStatsUpdate(AsyncIndexesSizeStatsUpdate asyncIndexesSizeStatsUpdate)

getIndexEditor

public Editor getIndexEditor(@NotNull
                             @NotNull java.lang.String type,
                             @NotNull
                             @NotNull NodeBuilder definition,
                             @NotNull
                             @NotNull NodeState root,
                             @NotNull
                             @NotNull IndexUpdateCallback callback)
                      throws CommitFailedException

Description copied from interface: IndexEditorProvider

Each provider knows how to produce a certain type of index. If the type param is of an unknown value, the provider is expected to return null.

The definition builder must points to the index definition node under which the indexer is expected to store the index content.

The callback instance may be of type ContextAwareCallback and that can be used to access IndexingContext

Specified by:

getIndexEditor in interface IndexEditorProvider

Parameters:

type - index type

definition - index definition node builder, used for updates

root - root node state, used for things like node type information

callback - used to register for index update notifications

Returns:

index update editor, or null if type is unknown

Throws:

CommitFailedException

getExtractedTextCache

public org.apache.jackrabbit.oak.plugins.index.search.ExtractedTextCache getExtractedTextCache()

setInMemoryDocsLimit

public void setInMemoryDocsLimit(int inMemoryDocsLimit)

setBlobStore

public void setBlobStore(@Nullable
                         @Nullable GarbageCollectableBlobStore blobStore)

setIndexingQueue

public void setIndexingQueue(org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.IndexingQueue indexingQueue)

setWriterConfig

public void setWriterConfig(org.apache.jackrabbit.oak.plugins.index.lucene.writer.LuceneIndexWriterConfig writerConfig)