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(IndexCopier indexCopier)
LuceneIndexEditorProvider(IndexCopier indexCopier, org.apache.jackrabbit.oak.plugins.index.lucene.ExtractedTextCache extractedTextCache)
LuceneIndexEditorProvider(IndexCopier indexCopier, org.apache.jackrabbit.oak.plugins.index.lucene.ExtractedTextCache extractedTextCache, IndexAugmentorFactory augmentorFactory)

Method Summary

Modifier and Type	Method and Description
Editor	getIndexEditor(java.lang.String type, NodeBuilder definition, NodeState root, IndexUpdateCallback callback) Each provider knows how to produce a certain type of index.

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneIndexEditorProvider

public LuceneIndexEditorProvider()

LuceneIndexEditorProvider

public LuceneIndexEditorProvider(IndexCopier indexCopier)

LuceneIndexEditorProvider

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

LuceneIndexEditorProvider

public LuceneIndexEditorProvider(IndexCopier indexCopier,
                                 org.apache.jackrabbit.oak.plugins.index.lucene.ExtractedTextCache extractedTextCache,
                                 IndexAugmentorFactory augmentorFactory)

Method Detail

getIndexEditor

public Editor getIndexEditor(java.lang.String type,
                             NodeBuilder definition,
                             NodeState root,
                             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.

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