LuceneTextIndexReader (Pinot local segment implementations 0.12.1 API)

java.lang.Object
- org.apache.pinot.segment.local.segment.index.readers.text.LuceneTextIndexReader

All Implemented Interfaces:

Closeable, AutoCloseable, TextIndexReader
```
public class LuceneTextIndexReader
extends Object
implements TextIndexReader
```
This is used to read/search the Lucene text index. When ImmutableSegmentLoader loads the segment, it also loads (mmaps) the Lucene text index if the segment has TEXT column(s).

Constructor Summary

Constructors
Constructor	Description
`LuceneTextIndexReader(String column, File indexDir, int numDocs, Map<String,String> textIndexProperties)`	As part of loading the segment in ImmutableSegmentLoader, we load the text index (per column if it exists) and store the reference in `PhysicalColumnIndexContainer` similar to how it is done for other types of indexes.

Method Summary

Modifier and Type	Method	Description
`void`	`close()`	When we destroy the loaded ImmutableSegment, all the indexes (for each column) are destroyed and as part of that we release the text index
`org.roaringbitmap.buffer.ImmutableRoaringBitmap`	`getDictIds(String searchQuery)`
`org.roaringbitmap.buffer.MutableRoaringBitmap`	`getDocIds(String searchQuery)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LuceneTextIndexReader
```
public LuceneTextIndexReader(String column,
                             File indexDir,
                             int numDocs,
                             @Nullable
                             Map<String,String> textIndexProperties)
```
    As part of loading the segment in ImmutableSegmentLoader, we load the text index (per column if it exists) and store the reference in PhysicalColumnIndexContainer similar to how it is done for other types of indexes.
    
    Parameters:
    
    column - column name
    
    indexDir - segment index directory
    
    numDocs - number of documents in the segment
- Method Detail
  - getDictIds
```
public org.roaringbitmap.buffer.ImmutableRoaringBitmap getDictIds(String searchQuery)
```
    Specified by:
    
    getDictIds in interface TextIndexReader
  - getDocIds
```
public org.roaringbitmap.buffer.MutableRoaringBitmap getDocIds(String searchQuery)
```
    Specified by:
    
    getDocIds in interface TextIndexReader
  - close
```
public void close()
           throws IOException
```
    When we destroy the loaded ImmutableSegment, all the indexes (for each column) are destroyed and as part of that we release the text index
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Throws:
    
    IOException