Package org.apache.pinot.segment.spi.creator

Class IndexCreationContext.Common

java.lang.Object

org.apache.pinot.segment.spi.creator.IndexCreationContext.Common

All Implemented Interfaces:

IndexCreationContext

Enclosing interface:

IndexCreationContext

public static final class IndexCreationContext.Common
extends Object
implements IndexCreationContext

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pinot.segment.spi.creator.IndexCreationContext

IndexCreationContext.BloomFilter, IndexCreationContext.Builder, IndexCreationContext.Common, IndexCreationContext.Forward, IndexCreationContext.Geospatial, IndexCreationContext.Inverted, IndexCreationContext.Json, IndexCreationContext.Range, IndexCreationContext.Text, IndexCreationContext.Wrapper

Constructor Summary

Constructors

Constructor	Description
Common(File indexDir, int lengthOfLongestEntry, int maxNumberOfMultiValueElements, int maxRowLengthInBytes, boolean onHeap, FieldSpec fieldSpec, boolean sorted, int cardinality, int totalNumberOfEntries, int totalDocs, boolean hasDictionary, Comparable<?> minValue, Comparable<?> maxValue, boolean forwardIndexDisabled)

Method Summary

Modifier and Type	Method	Description
IndexCreationContext.BloomFilter	forBloomFilter(BloomFilterConfig bloomFilterConfig)
IndexCreationContext.Forward	forForwardIndex(ChunkCompressionType chunkCompressionType, Map<String,Map<String,String>> columnProperties)
IndexCreationContext.Text	forFSTIndex(FSTType fstType, String[] sortedUniqueElementsArray)
IndexCreationContext.Geospatial	forGeospatialIndex(H3IndexConfig h3IndexConfig)
IndexCreationContext.Inverted	forInvertedIndex()
IndexCreationContext.Json	forJsonIndex(JsonIndexConfig jsonIndexConfig)
IndexCreationContext.Range	forRangeIndex(int rangeIndexVersion)
IndexCreationContext.Text	forTextIndex(FSTType fstType, boolean commitOnClose, List<String> stopWordsInclude, List<String> stopWordExclude)
boolean	forwardIndexDisabled()
int	getCardinality()
FieldSpec	getFieldSpec()
File	getIndexDir()
int	getLengthOfLongestEntry()
int	getMaxNumberOfMultiValueElements()
int	getMaxRowLengthInBytes()
Comparable<?>	getMaxValue()
Comparable<?>	getMinValue()
int	getTotalDocs()
int	getTotalNumberOfEntries()
boolean	hasDictionary()
boolean	isOnHeap()
boolean	isSorted()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Common

public Common(File indexDir,
              int lengthOfLongestEntry,
              int maxNumberOfMultiValueElements,
              int maxRowLengthInBytes,
              boolean onHeap,
              FieldSpec fieldSpec,
              boolean sorted,
              int cardinality,
              int totalNumberOfEntries,
              int totalDocs,
              boolean hasDictionary,
              Comparable<?> minValue,
              Comparable<?> maxValue,
              boolean forwardIndexDisabled)

Method Detail

getFieldSpec

public FieldSpec getFieldSpec()

Specified by:

getFieldSpec in interface IndexCreationContext

getIndexDir

public File getIndexDir()

Specified by:

getIndexDir in interface IndexCreationContext

isOnHeap

public boolean isOnHeap()

Specified by:

isOnHeap in interface IndexCreationContext

getLengthOfLongestEntry

public int getLengthOfLongestEntry()

Specified by:

getLengthOfLongestEntry in interface IndexCreationContext

getMaxNumberOfMultiValueElements

public int getMaxNumberOfMultiValueElements()

Specified by:

getMaxNumberOfMultiValueElements in interface IndexCreationContext

getMaxRowLengthInBytes

public int getMaxRowLengthInBytes()

Specified by:

getMaxRowLengthInBytes in interface IndexCreationContext

isSorted

public boolean isSorted()

Specified by:

isSorted in interface IndexCreationContext

getCardinality

public int getCardinality()

Specified by:

getCardinality in interface IndexCreationContext

getTotalNumberOfEntries

public int getTotalNumberOfEntries()

Specified by:

getTotalNumberOfEntries in interface IndexCreationContext

getTotalDocs

public int getTotalDocs()

Specified by:

getTotalDocs in interface IndexCreationContext

hasDictionary

public boolean hasDictionary()

Specified by:

hasDictionary in interface IndexCreationContext

getMinValue

public Comparable<?> getMinValue()

Specified by:

getMinValue in interface IndexCreationContext

getMaxValue

public Comparable<?> getMaxValue()

Specified by:

getMaxValue in interface IndexCreationContext

forwardIndexDisabled

public boolean forwardIndexDisabled()

Specified by:

forwardIndexDisabled in interface IndexCreationContext

forBloomFilter

public IndexCreationContext.BloomFilter forBloomFilter(BloomFilterConfig bloomFilterConfig)

forForwardIndex

public IndexCreationContext.Forward forForwardIndex(ChunkCompressionType chunkCompressionType,
                                                    @Nullable
                                                    Map<String,Map<String,String>> columnProperties)

forFSTIndex

public IndexCreationContext.Text forFSTIndex(FSTType fstType,
                                             String[] sortedUniqueElementsArray)

forGeospatialIndex

public IndexCreationContext.Geospatial forGeospatialIndex(H3IndexConfig h3IndexConfig)

forInvertedIndex

public IndexCreationContext.Inverted forInvertedIndex()

forJsonIndex

public IndexCreationContext.Json forJsonIndex(JsonIndexConfig jsonIndexConfig)

forRangeIndex

public IndexCreationContext.Range forRangeIndex(int rangeIndexVersion)

forTextIndex

public IndexCreationContext.Text forTextIndex(FSTType fstType,
                                              boolean commitOnClose,
                                              List<String> stopWordsInclude,
                                              List<String> stopWordExclude)