NativeFSTIndexCreator (Pinot local segment implementations 1.0.0 API)

java.lang.Object
- org.apache.pinot.segment.local.utils.nativefst.NativeFSTIndexCreator

All Implemented Interfaces:: Closeable, AutoCloseable, FSTIndexCreator, IndexCreator

public class NativeFSTIndexCreator
extends Object
implements FSTIndexCreator

Constructor Summary

Constructors
Constructor	Description
`NativeFSTIndexCreator(File indexDir, String columnName, String[] sortedEntries)`	This index requires values of the column be added in sorted order.
`NativeFSTIndexCreator(IndexCreationContext context)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(String document)`
`void`	`add(String[] document, int length)`
`void`	`close()`
`void`	`seal()`

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

Methods inherited from interface org.apache.pinot.segment.spi.index.creator.FSTIndexCreator
add, add

- Constructor Detail
  - NativeFSTIndexCreator
```
public NativeFSTIndexCreator(File indexDir,
                             String columnName,
                             String[] sortedEntries)
```
    This index requires values of the column be added in sorted order. Sorted entries could be passed in through constructor or added through addSortedDictIds function. Index of the sorted entry should correspond to the dictionary id.
    
    Parameters:
    
    indexDir - Index directory
    
    columnName - Column name for which index is being created
    
    sortedEntries - Sorted entries of the unique values of the column.
  - NativeFSTIndexCreator
```
public NativeFSTIndexCreator(IndexCreationContext context)
```
- Method Detail
  - add
```
public void add(String document)
```
    Specified by:
    
    add in interface FSTIndexCreator
  - add
```
public void add(String[] document,
                int length)
```
    Specified by:
    
    add in interface FSTIndexCreator
  - seal
```
public void seal()
          throws IOException
```
    Specified by:
    
    seal in interface IndexCreator
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Throws:
    
    IOException