Package org.apache.pinot.segment.local.segment.index.text

Class TextIndexType

java.lang.Object

org.apache.pinot.segment.spi.index.AbstractIndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

org.apache.pinot.segment.local.segment.index.text.TextIndexType

All Implemented Interfaces:

ConfigurableFromIndexLoadingConfig<TextIndexConfig>, IndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

public class TextIndexType
extends AbstractIndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>
implements ConfigurableFromIndexLoadingConfig<TextIndexConfig>

Field Summary

Fields

Modifier and Type	Field	Description
static String	INDEX_DISPLAY_NAME
protected static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextIndexType()

Method Summary

Modifier and Type	Method	Description
ColumnConfigDeserializer<TextIndexConfig>	createDeserializer()
TextIndexCreator	createIndexCreator(IndexCreationContext context, TextIndexConfig indexConfig)
IndexHandler	createIndexHandler(SegmentDirectory segmentDirectory, Map<String,FieldIndexConfigs> configsByCol, Schema schema, TableConfig tableConfig)
MutableIndex	createMutableIndex(MutableIndexContext context, TextIndexConfig config)
protected IndexReaderFactory<TextIndexReader>	createReaderFactory()
Map<String,TextIndexConfig>	fromIndexLoadingConfig(IndexLoadingConfig indexLoadingConfig)	Returns a map that can be used to get the index config.
TextIndexConfig	getDefaultConfig()
String	getFileExtension(ColumnMetadata columnMetadata)
Class<TextIndexConfig>	getIndexConfigClass()
String	getPrettyName()

Methods inherited from class org.apache.pinot.segment.spi.index.AbstractIndexType

convertToNewFormat, equals, getConfig, getId, getReaderFactory, handleIndexSpecificCleanup, 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

getIndexReader

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

INDEX_DISPLAY_NAME

public static final String INDEX_DISPLAY_NAME

See Also:

Constant Field Values

Constructor Detail

TextIndexType

protected TextIndexType()

Method Detail

getIndexConfigClass

public Class<TextIndexConfig> getIndexConfigClass()

Specified by:

getIndexConfigClass in interface IndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

fromIndexLoadingConfig

public Map<String,TextIndexConfig> fromIndexLoadingConfig(IndexLoadingConfig indexLoadingConfig)

Description copied from interface: ConfigurableFromIndexLoadingConfig

Returns 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 an IndexLoadingConfig. Sometimes IndexLoadingConfig is not completely configured and IndexLoadingConfig.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:

fromIndexLoadingConfig in interface ConfigurableFromIndexLoadingConfig<TextIndexConfig>

Returns:

a map whose keys are the column names and the values are the index configuration for that column.

getDefaultConfig

public TextIndexConfig getDefaultConfig()

Specified by:

getDefaultConfig in interface IndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

getPrettyName

public String getPrettyName()

Specified by:

getPrettyName in interface IndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

createDeserializer

public ColumnConfigDeserializer<TextIndexConfig> createDeserializer()

Specified by:

createDeserializer in class AbstractIndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

createIndexCreator

public TextIndexCreator createIndexCreator(IndexCreationContext context,
                                           TextIndexConfig indexConfig)
                                    throws IOException

Specified by:

createIndexCreator in interface IndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

Throws:

IOException

createReaderFactory

protected IndexReaderFactory<TextIndexReader> createReaderFactory()

Specified by:

createReaderFactory in class AbstractIndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

createIndexHandler

public IndexHandler createIndexHandler(SegmentDirectory segmentDirectory,
                                       Map<String,FieldIndexConfigs> configsByCol,
                                       @Nullable
                                       Schema schema,
                                       @Nullable
                                       TableConfig tableConfig)

Specified by:

createIndexHandler in interface IndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

getFileExtension

public String getFileExtension(ColumnMetadata columnMetadata)

Specified by:

getFileExtension in interface IndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>

createMutableIndex

@Nullable
public MutableIndex createMutableIndex(MutableIndexContext context,
                                       TextIndexConfig config)

Specified by:

createMutableIndex in interface IndexType<TextIndexConfig,TextIndexReader,TextIndexCreator>