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

Class RangeIndexType

java.lang.Object

org.apache.pinot.segment.spi.index.AbstractIndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

org.apache.pinot.segment.local.segment.index.range.RangeIndexType

All Implemented Interfaces:

ConfigurableFromIndexLoadingConfig<RangeIndexConfig>, IndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

public class RangeIndexType
extends AbstractIndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>
implements ConfigurableFromIndexLoadingConfig<RangeIndexConfig>

Field Summary

Fields

Modifier and Type	Field	Description
static String	INDEX_DISPLAY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RangeIndexType()

Method Summary

Modifier and Type	Method	Description
ColumnConfigDeserializer<RangeIndexConfig>	createDeserializer()
CombinedInvertedIndexCreator	createIndexCreator(IndexCreationContext context, RangeIndexConfig indexConfig)
IndexHandler	createIndexHandler(SegmentDirectory segmentDirectory, Map<String,FieldIndexConfigs> configsByCol, Schema schema, TableConfig tableConfig)
protected IndexReaderFactory<RangeIndexReader>	createReaderFactory()
Map<String,RangeIndexConfig>	fromIndexLoadingConfig(IndexLoadingConfig indexLoadingConfig)	Returns a map that can be used to get the index config.
RangeIndexConfig	getDefaultConfig()
String	getFileExtension(ColumnMetadata columnMetadata)
Class<RangeIndexConfig>	getIndexConfigClass()
String	getPrettyName()
protected void	handleIndexSpecificCleanup(TableConfig tableConfig)
static RangeIndexReader	read(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, getIndexReader

Field Detail

INDEX_DISPLAY_NAME

public static final String INDEX_DISPLAY_NAME

See Also:

Constant Field Values

Constructor Detail

RangeIndexType

protected RangeIndexType()

Method Detail

getIndexConfigClass

public Class<RangeIndexConfig> getIndexConfigClass()

Specified by:

getIndexConfigClass in interface IndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

fromIndexLoadingConfig

public Map<String,RangeIndexConfig> 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<RangeIndexConfig>

Returns:

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

getDefaultConfig

public RangeIndexConfig getDefaultConfig()

Specified by:

getDefaultConfig in interface IndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

getPrettyName

public String getPrettyName()

Specified by:

getPrettyName in interface IndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

createDeserializer

public ColumnConfigDeserializer<RangeIndexConfig> createDeserializer()

Specified by:

createDeserializer in class AbstractIndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

createIndexCreator

public CombinedInvertedIndexCreator createIndexCreator(IndexCreationContext context,
                                                       RangeIndexConfig indexConfig)
                                                throws IOException

Specified by:

createIndexCreator in interface IndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

Throws:

IOException

createReaderFactory

protected IndexReaderFactory<RangeIndexReader> createReaderFactory()

Specified by:

createReaderFactory in class AbstractIndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

read

public static RangeIndexReader read(PinotDataBuffer dataBuffer,
                                    ColumnMetadata metadata)
                             throws IndexReaderConstraintException

Throws:

IndexReaderConstraintException

getFileExtension

public String getFileExtension(ColumnMetadata columnMetadata)

Specified by:

getFileExtension in interface IndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

createIndexHandler

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

Specified by:

createIndexHandler in interface IndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>

handleIndexSpecificCleanup

protected void handleIndexSpecificCleanup(TableConfig tableConfig)

Overrides:

handleIndexSpecificCleanup in class AbstractIndexType<RangeIndexConfig,RangeIndexReader,CombinedInvertedIndexCreator>