Interface IndexMaintainerFactory
-
- All Known Implementing Classes:
AtomicMutationIndexMaintainerFactory
,BitmapValueIndexMaintainerFactory
,NoOpIndexMaintainerFactory
,PermutedMinMaxIndexMaintainerFactory
,RankIndexMaintainerFactory
,TextIndexMaintainerFactory
,TimeWindowLeaderboardIndexMaintainerFactory
,ValueIndexMaintainerFactory
,VersionIndexMaintainerFactory
@API(STABLE) public interface IndexMaintainerFactory
A factory forIndexMaintainer
.An index maintainer factory is associated with one or more index types. It is also responsible for validation of
Index
meta-data.An index maintainer factory would typically be annotated to allow the classpath-based registry to find it.
@AutoService(IndexMaintainerFactory.class)
- See Also:
IndexMaintainerRegistry
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IndexMaintainer
getIndexMaintainer(IndexMaintainerState state)
Get an index maintainer for the given record store and index meta-data.Iterable<String>
getIndexTypes()
Get the index types supported by this factory.IndexValidator
getIndexValidator(Index index)
Get a validator for the given index meta-data.
-
-
-
Method Detail
-
getIndexTypes
@Nonnull Iterable<String> getIndexTypes()
Get the index types supported by this factory.- Returns:
- a collection of strings of index types supported by this factory
-
getIndexValidator
@Nonnull IndexValidator getIndexValidator(Index index)
Get a validator for the given index meta-data.- Parameters:
index
- an index that was produced by this factory- Returns:
- a validator for this kind of index
-
getIndexMaintainer
@Nonnull IndexMaintainer getIndexMaintainer(IndexMaintainerState state)
Get an index maintainer for the given record store and index meta-data.- Parameters:
state
- the state of the new index maintainer- Returns:
- a new index maintainer for the type of index given
-
-