org.apache.jackrabbit.oak.index

Class SegmentPropertyIndexEditorProvider

java.lang.Object

org.apache.jackrabbit.oak.index.SegmentPropertyIndexEditorProvider

All Implemented Interfaces:

Closeable, AutoCloseable, IndexEditorProvider

public class SegmentPropertyIndexEditorProvider
extends Object
implements IndexEditorProvider, Closeable

Editor implementation which stores the property index NodeState data in a different SegmentNodeStore used solely for property index storage purpose

Constructor Summary

Constructors

Constructor and Description
SegmentPropertyIndexEditorProvider(File storeDir)

Method Summary

Modifier and Type	Method and Description
void	close()
@Nullable Editor	getIndexEditor(@NotNull String type, @NotNull NodeBuilder definition, @NotNull NodeState root, @NotNull IndexUpdateCallback callback) Each provider knows how to produce a certain type of index.
SegmentPropertyIndexEditorProvider	with(MountInfoProvider mountInfoProvider)

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentPropertyIndexEditorProvider

public SegmentPropertyIndexEditorProvider(File storeDir)

Method Detail

getIndexEditor

@Nullable
public @Nullable Editor getIndexEditor(@NotNull
                                                 @NotNull 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

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

with

public SegmentPropertyIndexEditorProvider with(MountInfoProvider mountInfoProvider)