Package org.apache.pinot.segment.spi.index.reader.provider

Interface TextIndexReaderProvider

All Known Subinterfaces:

IndexingOverrides.IndexingOverride, IndexReaderProvider

All Known Implementing Classes:

IndexingOverrides.Default

public interface TextIndexReaderProvider

Method Summary

Modifier and Type	Method	Description
TextIndexReader	newFSTIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata)	Creates a {@see TextIndexReader}
TextIndexReader	newTextIndexReader(File file, ColumnMetadata metadata, Map<String,String> textIndexProperties)	Creates a {@see TextIndexReader}

Method Detail

newFSTIndexReader

TextIndexReader newFSTIndexReader(PinotDataBuffer dataBuffer,
                                  ColumnMetadata metadata)
                           throws IOException

Creates a {@see TextIndexReader}

Parameters:

dataBuffer - the buffer, the caller is responsible for closing it

metadata - the column metadata, may be used to select a reader if the buffer does not start with a magic byte.

Returns:

a text index reader

Throws:

IOException - if reading from the buffer fails.

newTextIndexReader

TextIndexReader newTextIndexReader(File file,
                                   ColumnMetadata metadata,
                                   @Nullable
                                   Map<String,String> textIndexProperties)

Creates a {@see TextIndexReader}

Parameters:

file - the file

metadata - the column metadata, may be used to select a reader if the buffer does not start with a magic byte.

Returns:

a text index reader