Package org.apache.jackrabbit.oak.plugins.index

Class CompositeIndexEditorProvider

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.CompositeIndexEditorProvider

All Implemented Interfaces:

AutoCloseable, IndexEditorProvider

public class CompositeIndexEditorProvider
extends Object
implements IndexEditorProvider

Aggregation of a list of editor providers into a single provider.

Constructor Summary

Constructors

Constructor	Description
CompositeIndexEditorProvider(IndexEditorProvider... providers)

Method Summary

Modifier and Type	Method	Description
void	close()
static @NotNull IndexEditorProvider	compose(@NotNull List<IndexEditorProvider> providers)
static @NotNull IndexEditorProvider	compose(IndexEditorProvider... providers)
Editor	getIndexEditor(@NotNull String type, @NotNull NodeBuilder builder, @NotNull NodeState root, @NotNull IndexUpdateCallback callback)	Each provider knows how to produce a certain type of index.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeIndexEditorProvider

public CompositeIndexEditorProvider(IndexEditorProvider... providers)

Method Detail

compose

@NotNull
public static @NotNull IndexEditorProvider compose(IndexEditorProvider... providers)

compose

@NotNull
public static @NotNull IndexEditorProvider compose(@NotNull
                                                   @NotNull List<IndexEditorProvider> providers)

getIndexEditor

public Editor getIndexEditor(@NotNull
                             @NotNull String type,
                             @NotNull
                             @NotNull NodeBuilder builder,
                             @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

builder - 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 AutoCloseable

Specified by:

close in interface IndexEditorProvider

Throws:

IOException