Interface IndexEditorProvider
-
- All Known Implementing Classes:
CompositeIndexEditorProvider
,SegmentPropertyIndexEditorProvider
,WhiteboardIndexEditorProvider
public interface IndexEditorProvider
Extension point for plugging in different kinds of IndexEditor providers.- See Also:
IndexEditor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @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.
-
-
-
Method Detail
-
getIndexEditor
@Nullable @Nullable Editor getIndexEditor(@NotNull @NotNull String type, @NotNull @NotNull NodeBuilder definition, @NotNull @NotNull NodeState root, @NotNull @NotNull IndexUpdateCallback callback) throws CommitFailedException
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
- Parameters:
type
- index typedefinition
- 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
-
-