org.apache.jackrabbit.oak.plugins.index.property

Class PropertyIndexEditorProvider

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.property.PropertyIndexEditorProvider

All Implemented Interfaces:

IndexEditorProvider

public class PropertyIndexEditorProvider
extends java.lang.Object
implements IndexEditorProvider

Service that provides PropertyIndex based editors.

See Also:

PropertyIndexEditor, IndexEditorProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Constructor Summary

Constructors

Constructor and Description
PropertyIndexEditorProvider()

Method Summary

Modifier and Type	Method and Description
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.
PropertyIndexEditorProvider	with(MountInfoProvider mountInfoProvider)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

PropertyIndexEditorProvider

public PropertyIndexEditorProvider()

Method Detail

getIndexEditor

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

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

with

public PropertyIndexEditorProvider with(MountInfoProvider mountInfoProvider)