Package org.apache.pinot.segment.local.segment.creator.impl.inv.text

Class LuceneFSTIndexCreator

java.lang.Object

org.apache.pinot.segment.local.segment.creator.impl.inv.text.LuceneFSTIndexCreator

All Implemented Interfaces:

Closeable, AutoCloseable, FSTIndexCreator, IndexCreator

public class LuceneFSTIndexCreator
extends Object
implements FSTIndexCreator

This index works only for dictionary enabled columns. It requires entries be added into this index in sorted order and it creates a mapping from sorted entry to the index underneath. This index stores key (column value) to dictionary id as an entry.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	add(String document)
void	add(String[] documents, 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

LuceneFSTIndexCreator

public LuceneFSTIndexCreator(File indexDir,
                             String columnName,
                             String[] sortedEntries)
                      throws IOException

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.

Throws:

IOException

LuceneFSTIndexCreator

public LuceneFSTIndexCreator(IndexCreationContext context)
                      throws IOException

Throws:

IOException

Method Detail

add

public void add(String document)

Specified by:

add in interface FSTIndexCreator

add

public void add(String[] documents,
                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