Class FstIndexType
- java.lang.Object
-
- org.apache.pinot.segment.spi.index.AbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
-
- org.apache.pinot.segment.local.segment.index.fst.FstIndexType
-
- All Implemented Interfaces:
ConfigurableFromIndexLoadingConfig<FstIndexConfig>,IndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
public class FstIndexType extends AbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator> implements ConfigurableFromIndexLoadingConfig<FstIndexConfig>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.pinot.segment.spi.index.IndexType
IndexType.BuildLifecycle
-
-
Field Summary
Fields Modifier and Type Field Description static StringINDEX_DISPLAY_NAME
-
Constructor Summary
Constructors Modifier Constructor Description protectedFstIndexType()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ColumnConfigDeserializer<FstIndexConfig>createDeserializer()FSTIndexCreatorcreateIndexCreator(IndexCreationContext context, FstIndexConfig indexConfig)IndexHandlercreateIndexHandler(SegmentDirectory segmentDirectory, Map<String,FieldIndexConfigs> configsByCol, Schema schema, TableConfig tableConfig)protected IndexReaderFactory<TextIndexReader>createReaderFactory()Map<String,FstIndexConfig>fromIndexLoadingConfig(IndexLoadingConfig indexLoadingConfig)Returns a map that can be used to get the index config.FstIndexConfiggetDefaultConfig()List<String>getFileExtensions(ColumnMetadata columnMetadata)Class<FstIndexConfig>getIndexConfigClass()StringgetPrettyName()protected voidhandleIndexSpecificCleanup(TableConfig tableConfig)static TextIndexReaderread(PinotDataBuffer dataBuffer, ColumnMetadata metadata)-
Methods inherited from class org.apache.pinot.segment.spi.index.AbstractIndexType
convertToNewFormat, equals, getConfig, getId, getReaderFactory, hashCode, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.pinot.segment.spi.index.IndexType
createMutableIndex, getIndexBuildLifecycle, getIndexReader
-
-
-
-
Field Detail
-
INDEX_DISPLAY_NAME
public static final String INDEX_DISPLAY_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
getIndexConfigClass
public Class<FstIndexConfig> getIndexConfigClass()
- Specified by:
getIndexConfigClassin interfaceIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
-
fromIndexLoadingConfig
public Map<String,FstIndexConfig> fromIndexLoadingConfig(IndexLoadingConfig indexLoadingConfig)
Description copied from interface:ConfigurableFromIndexLoadingConfigReturns a map that can be used to get the index config. This map is used with higher priority whenever the index configuration needs to be read from anIndexLoadingConfig. SometimesIndexLoadingConfigis not completely configured andIndexLoadingConfig.getAllKnownColumns()does not return all columns in the table. Therefore the returned map may not have an entry for each column in the actual schema.- Specified by:
fromIndexLoadingConfigin interfaceConfigurableFromIndexLoadingConfig<FstIndexConfig>- Returns:
- a map whose keys are the column names and the values are the index configuration for that column.
-
getDefaultConfig
public FstIndexConfig getDefaultConfig()
- Specified by:
getDefaultConfigin interfaceIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
-
getPrettyName
public String getPrettyName()
- Specified by:
getPrettyNamein interfaceIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
-
createDeserializer
public ColumnConfigDeserializer<FstIndexConfig> createDeserializer()
- Specified by:
createDeserializerin classAbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
-
createIndexCreator
public FSTIndexCreator createIndexCreator(IndexCreationContext context, FstIndexConfig indexConfig) throws IOException
- Specified by:
createIndexCreatorin interfaceIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>- Throws:
IOException
-
createReaderFactory
protected IndexReaderFactory<TextIndexReader> createReaderFactory()
- Specified by:
createReaderFactoryin classAbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
-
read
public static TextIndexReader read(PinotDataBuffer dataBuffer, ColumnMetadata metadata) throws IndexReaderConstraintException, IOException
-
createIndexHandler
public IndexHandler createIndexHandler(SegmentDirectory segmentDirectory, Map<String,FieldIndexConfigs> configsByCol, @Nullable Schema schema, @Nullable TableConfig tableConfig)
- Specified by:
createIndexHandlerin interfaceIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
-
getFileExtensions
public List<String> getFileExtensions(@Nullable ColumnMetadata columnMetadata)
- Specified by:
getFileExtensionsin interfaceIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
-
handleIndexSpecificCleanup
protected void handleIndexSpecificCleanup(TableConfig tableConfig)
- Overrides:
handleIndexSpecificCleanupin classAbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
-
-