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

Class OrderedPropertyIndexEditorProvider

java.lang.Object

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

All Implemented Interfaces:

IndexEditorProvider, OrderedIndex

public class OrderedPropertyIndexEditorProvider
extends java.lang.Object
implements IndexEditorProvider, OrderedIndex

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jackrabbit.oak.plugins.index.property.OrderedIndex

OrderedIndex.OrderDirection

Field Summary

Fields inherited from interface org.apache.jackrabbit.oak.plugins.index.property.OrderedIndex

DEFAULT_DIRECTION, DEPRECATION_MESSAGE, DIRECTION, TRACK_DEPRECATION_EVERY, TYPE

Constructor Summary

Constructors

Constructor and Description
OrderedPropertyIndexEditorProvider()

Method Summary

Modifier and Type	Method and Description
@Nullable 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderedPropertyIndexEditorProvider

public OrderedPropertyIndexEditorProvider()

Method Detail

getIndexEditor

@Nullable
public @Nullable 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