Package org.apache.pinot.segment.local.segment.store

Class StarTreeIndexReader

java.lang.Object

org.apache.pinot.segment.local.segment.store.StarTreeIndexReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class StarTreeIndexReader
extends Object
implements Closeable

This class provides access to the StarTree index data in a segment directory. The StarTree index data is stored in star_tree_index file, whose content can be parsed according to offset/size from star_tree_index_map file.

Constructor Summary

Constructors

Constructor	Description
StarTreeIndexReader(File segmentDirectory, SegmentMetadataImpl segmentMetadata, ReadMode readMode)

Method Summary

Modifier and Type	Method	Description
void	close()
PinotDataBuffer	getBuffer(int starTreeId, String column, IndexType<?,?,?> type)
boolean	hasIndexFor(int starTreeId, String column, IndexType<?,?,?> type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StarTreeIndexReader

public StarTreeIndexReader(File segmentDirectory,
                           SegmentMetadataImpl segmentMetadata,
                           ReadMode readMode)
                    throws IOException,
                           org.apache.commons.configuration2.ex.ConfigurationException

Parameters:

segmentDirectory - the segment directory contains StarTree index

segmentMetadata - segment metadata must be fully initialized

readMode - mmap vs heap mode

Throws:

IOException

org.apache.commons.configuration2.ex.ConfigurationException

Method Detail

getBuffer

public PinotDataBuffer getBuffer(int starTreeId,
                                 String column,
                                 IndexType<?,?,?> type)
                          throws IOException

Throws:

IOException

hasIndexFor

public boolean hasIndexFor(int starTreeId,
                           String column,
                           IndexType<?,?,?> type)

toString

public String toString()

Overrides:

toString in class Object

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException