Class CompositeIndexEditorProvider
java.lang.Object
org.apache.jackrabbit.oak.plugins.index.CompositeIndexEditorProvider
- All Implemented Interfaces:
AutoCloseable
,IndexEditorProvider
Aggregation of a list of editor providers into a single provider.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
static @NotNull IndexEditorProvider
compose
(@NotNull List<IndexEditorProvider> providers) static @NotNull IndexEditorProvider
compose
(IndexEditorProvider... providers) getIndexEditor
(@NotNull String type, @NotNull NodeBuilder builder, @NotNull NodeState root, @NotNull IndexUpdateCallback callback) Each provider knows how to produce a certain type of index.
-
Constructor Details
-
CompositeIndexEditorProvider
-
-
Method Details
-
compose
-
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 thetype
param is of an unknown value, the provider is expected to returnnull
.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 typeContextAwareCallback
and that can be used to accessIndexingContext
- Specified by:
getIndexEditor
in interfaceIndexEditorProvider
- Parameters:
type
- index typebuilder
- index definition node builder, used for updatesroot
- root node state, used for things like node type informationcallback
- used to register for index update notifications- Returns:
- index update editor, or
null
if type is unknown - Throws:
CommitFailedException
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceIndexEditorProvider
- Throws:
IOException
-