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

Class IndexingOverrides.Default

java.lang.Object

org.apache.pinot.segment.spi.index.IndexingOverrides.Default

All Implemented Interfaces:

BloomFilterCreatorProvider, ForwardIndexCreatorProvider, GeoSpatialIndexCreatorProvider, IndexCreatorProvider, InvertedIndexCreatorProvider, JsonIndexCreatorProvider, RangeIndexCreatorProvider, TextIndexCreatorProvider, IndexingOverrides.IndexingOverride, MutableDictionaryProvider, MutableForwardIndexProvider, MutableIndexProvider, MutableInvertedIndexProvider, MutableJsonIndexProvider, MutableTextIndexReaderProvider, BloomFilterReaderProvider, ForwardIndexReaderProvider, GeospatialIndexReaderProvider, IndexReaderProvider, InvertedIndexReaderProvider, JsonIndexReaderProvider, RangeIndexReaderProvider, SortedIndexReaderProvider, TextIndexReaderProvider

Enclosing class:

IndexingOverrides

public static class IndexingOverrides.Default
extends Object
implements IndexingOverrides.IndexingOverride

Extend this class to override index creation

Constructor Summary

Constructors

Constructor	Description
Default()

Method Summary

Modifier and Type	Method	Description
BloomFilterCreator	newBloomFilterCreator(IndexCreationContext.BloomFilter context)	Creates a {@see BloomFilterCreator} from information about index creation.
BloomFilterReader	newBloomFilterReader(PinotDataBuffer dataBuffer, boolean onHeap)	Creates a {@see BloomFilterReader}
MutableDictionary	newDictionary(MutableIndexContext.Dictionary context)
MutableForwardIndex	newForwardIndex(MutableIndexContext.Forward context)
ForwardIndexCreator	newForwardIndexCreator(IndexCreationContext.Forward context)	Creates a {@see ForwardIndexCreator} from information about index creation.
ForwardIndexReader<?>	newForwardIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata)	Creates a {@see ForwardIndexReader}
TextIndexReader	newFSTIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata)	Creates a {@see TextIndexReader}
GeoSpatialIndexCreator	newGeoSpatialIndexCreator(IndexCreationContext.Geospatial context)	Creates a {@see GeoSpatialIndexCreator} from information about index creation.
H3IndexReader	newGeospatialIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata)	Creates a {@see H3IndexReader}
MutableInvertedIndex	newInvertedIndex(MutableIndexContext.Inverted context)
DictionaryBasedInvertedIndexCreator	newInvertedIndexCreator(IndexCreationContext.Inverted context)	Creates a {@see DictionaryBasedInvertedIndexCreator} from information about index creation.
InvertedIndexReader<?>	newInvertedIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata)	Creates a {@see InvertedIndexReader}
MutableJsonIndex	newJsonIndex(MutableIndexContext.Json context)
JsonIndexCreator	newJsonIndexCreator(IndexCreationContext.Json context)	Creates a {@see JsonIndexCreator} from information about index creation.
JsonIndexReader	newJsonIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata)	Creates a {@see JsonIndexReader}
CombinedInvertedIndexCreator	newRangeIndexCreator(IndexCreationContext.Range context)	Creates a {@see CombinedInvertedIndexCreator} from information about index creation.
RangeIndexReader<?>	newRangeIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata)	Creates a {@see RangeIndexReader}
SortedIndexReader<?>	newSortedIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata)	Creates a {@see SortedIndexReader}
MutableTextIndex	newTextIndex(MutableIndexContext.Text context)
TextIndexCreator	newTextIndexCreator(IndexCreationContext.Text context)	Creates a {@see TextIndexCreator} from information about index creation.
TextIndexReader	newTextIndexReader(File file, ColumnMetadata columnMetadata, Map<String,String> textIndexProperties)	Creates a {@see TextIndexReader}

Methods inherited from class java.lang.Object

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

Constructor Detail

Default

public Default()

Method Detail

newBloomFilterCreator

public BloomFilterCreator newBloomFilterCreator(IndexCreationContext.BloomFilter context)
                                         throws IOException

Description copied from interface: BloomFilterCreatorProvider

Creates a {@see BloomFilterCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.

Specified by:

newBloomFilterCreator in interface BloomFilterCreatorProvider

Parameters:

context - context about the index creation.

Returns:

a {@see ForwardIndexCreator}

Throws:

IOException - whenever something goes wrong matching or constructing the creator

newForwardIndexCreator

public ForwardIndexCreator newForwardIndexCreator(IndexCreationContext.Forward context)
                                           throws Exception

Description copied from interface: ForwardIndexCreatorProvider

Creates a {@see ForwardIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.

Specified by:

newForwardIndexCreator in interface ForwardIndexCreatorProvider

Parameters:

context - context about the index creation.

Returns:

a {@see ForwardIndexCreator}

Throws:

Exception - whenever something goes wrong matching or constructing the creator

newGeoSpatialIndexCreator

public GeoSpatialIndexCreator newGeoSpatialIndexCreator(IndexCreationContext.Geospatial context)
                                                 throws IOException

Description copied from interface: GeoSpatialIndexCreatorProvider

Creates a {@see GeoSpatialIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.

Specified by:

newGeoSpatialIndexCreator in interface GeoSpatialIndexCreatorProvider

Parameters:

context - context about the index creation.

Returns:

a {@see ForwardIndexCreator}

Throws:

IOException - whenever something goes wrong matching or constructing the creator

newInvertedIndexCreator

public DictionaryBasedInvertedIndexCreator newInvertedIndexCreator(IndexCreationContext.Inverted context)
                                                            throws IOException

Description copied from interface: InvertedIndexCreatorProvider

Creates a {@see DictionaryBasedInvertedIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.

Specified by:

newInvertedIndexCreator in interface InvertedIndexCreatorProvider

Parameters:

context - context about the index creation.

Returns:

a {@see ForwardIndexCreator}

Throws:

IOException - whenever something goes wrong matching or constructing the creator

newJsonIndexCreator

public JsonIndexCreator newJsonIndexCreator(IndexCreationContext.Json context)
                                     throws IOException

Description copied from interface: JsonIndexCreatorProvider

Creates a {@see JsonIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.

Specified by:

newJsonIndexCreator in interface JsonIndexCreatorProvider

Parameters:

context - context about the index creation.

Returns:

a {@see ForwardIndexCreator}

Throws:

IOException - whenever something goes wrong matching or constructing the creator

newRangeIndexCreator

public CombinedInvertedIndexCreator newRangeIndexCreator(IndexCreationContext.Range context)
                                                  throws IOException

Description copied from interface: RangeIndexCreatorProvider

Creates a {@see CombinedInvertedIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.

Specified by:

newRangeIndexCreator in interface RangeIndexCreatorProvider

Parameters:

context - context about the index creation.

Returns:

a {@see ForwardIndexCreator}

Throws:

IOException - whenever something goes wrong matching or constructing the creator

newTextIndexCreator

public TextIndexCreator newTextIndexCreator(IndexCreationContext.Text context)
                                     throws IOException

Description copied from interface: TextIndexCreatorProvider

Creates a {@see TextIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.

Specified by:

newTextIndexCreator in interface TextIndexCreatorProvider

Parameters:

context - context about the index creation.

Returns:

a {@see ForwardIndexCreator}

Throws:

IOException - whenever something goes wrong matching or constructing the creator

newBloomFilterReader

public BloomFilterReader newBloomFilterReader(PinotDataBuffer dataBuffer,
                                              boolean onHeap)
                                       throws IOException

Description copied from interface: BloomFilterReaderProvider

Creates a {@see BloomFilterReader}

Specified by:

newBloomFilterReader in interface BloomFilterReaderProvider

Parameters:

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

onHeap - whether to duplicate on heap.

Returns:

a bloom filter reader

Throws:

IOException - if reading from the buffer fails.

newForwardIndexReader

public ForwardIndexReader<?> newForwardIndexReader(PinotDataBuffer dataBuffer,
                                                   ColumnMetadata metadata)
                                            throws IOException

Description copied from interface: ForwardIndexReaderProvider

Creates a {@see ForwardIndexReader}

Specified by:

newForwardIndexReader in interface ForwardIndexReaderProvider

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 forward index reader

Throws:

IOException - if reading from the buffer fails.

newGeospatialIndexReader

public H3IndexReader newGeospatialIndexReader(PinotDataBuffer dataBuffer,
                                              ColumnMetadata metadata)
                                       throws IOException

Description copied from interface: GeospatialIndexReaderProvider

Creates a {@see H3IndexReader}

Specified by:

newGeospatialIndexReader in interface GeospatialIndexReaderProvider

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 geospatial index reader

Throws:

IOException - if reading from the buffer fails.

newInvertedIndexReader

public InvertedIndexReader<?> newInvertedIndexReader(PinotDataBuffer dataBuffer,
                                                     ColumnMetadata metadata)
                                              throws IOException

Description copied from interface: InvertedIndexReaderProvider

Creates a {@see InvertedIndexReader}

Specified by:

newInvertedIndexReader in interface InvertedIndexReaderProvider

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:

an inverted index reader

Throws:

IOException - if reading from the buffer fails.

newJsonIndexReader

public JsonIndexReader newJsonIndexReader(PinotDataBuffer dataBuffer,
                                          ColumnMetadata metadata)
                                   throws IOException

Description copied from interface: JsonIndexReaderProvider

Creates a {@see JsonIndexReader}

Specified by:

newJsonIndexReader in interface JsonIndexReaderProvider

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 JSON index reader

Throws:

IOException - if reading from the buffer fails.

newRangeIndexReader

public RangeIndexReader<?> newRangeIndexReader(PinotDataBuffer dataBuffer,
                                               ColumnMetadata metadata)
                                        throws IOException

Description copied from interface: RangeIndexReaderProvider

Creates a {@see RangeIndexReader}

Specified by:

newRangeIndexReader in interface RangeIndexReaderProvider

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 range index reader

Throws:

IOException - if reading from the buffer fails.

newSortedIndexReader

public SortedIndexReader<?> newSortedIndexReader(PinotDataBuffer dataBuffer,
                                                 ColumnMetadata metadata)
                                          throws IOException

Description copied from interface: SortedIndexReaderProvider

Creates a {@see SortedIndexReader}

Specified by:

newSortedIndexReader in interface SortedIndexReaderProvider

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 sorted index reader

Throws:

IOException - if reading from the buffer fails.

newFSTIndexReader

public TextIndexReader newFSTIndexReader(PinotDataBuffer dataBuffer,
                                         ColumnMetadata metadata)
                                  throws IOException

Description copied from interface: TextIndexReaderProvider

Creates a {@see TextIndexReader}

Specified by:

newFSTIndexReader in interface TextIndexReaderProvider

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

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

Description copied from interface: TextIndexReaderProvider

Creates a {@see TextIndexReader}

Specified by:

newTextIndexReader in interface TextIndexReaderProvider

Parameters:

file - the file

columnMetadata - 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

newForwardIndex

public MutableForwardIndex newForwardIndex(MutableIndexContext.Forward context)

Specified by:

newForwardIndex in interface MutableForwardIndexProvider

newInvertedIndex

public MutableInvertedIndex newInvertedIndex(MutableIndexContext.Inverted context)

Specified by:

newInvertedIndex in interface MutableInvertedIndexProvider

newTextIndex

public MutableTextIndex newTextIndex(MutableIndexContext.Text context)

Specified by:

newTextIndex in interface MutableTextIndexReaderProvider

newJsonIndex

public MutableJsonIndex newJsonIndex(MutableIndexContext.Json context)

Specified by:

newJsonIndex in interface MutableJsonIndexProvider

newDictionary

public MutableDictionary newDictionary(MutableIndexContext.Dictionary context)

Specified by:

newDictionary in interface MutableDictionaryProvider