Package org.apache.druid.segment.index

Class SimpleImmutableBitmapIterableIndex

java.lang.Object

org.apache.druid.segment.index.SimpleBitmapColumnIndex

org.apache.druid.segment.index.SimpleImmutableBitmapIterableIndex

All Implemented Interfaces:

BitmapColumnIndex

Direct Known Subclasses:

DictionaryScanningBitmapIndex

public abstract class SimpleImmutableBitmapIterableIndex
extends SimpleBitmapColumnIndex

SimpleBitmapColumnIndex for anything which can compute an Iterable<ImmutableBitmap> in some manner

Field Summary

Fields inherited from class org.apache.druid.segment.index.SimpleBitmapColumnIndex

CAPABILITIES

Constructor Summary

Constructors

Constructor	Description
SimpleImmutableBitmapIterableIndex()

Method Summary

Modifier and Type	Method	Description
final <T> T	computeBitmapResult(BitmapResultFactory<T> bitmapResultFactory, boolean includeUnknown)	Compute a bitmap result wrapped with the BitmapResultFactory representing the rows matched by this index.
protected abstract Iterable<ImmutableBitmap>	getBitmapIterable(boolean includeUnknown)

Methods inherited from class org.apache.druid.segment.index.SimpleBitmapColumnIndex

getIndexCapabilities

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.segment.index.BitmapColumnIndex

computeBitmapResult, estimatedComputeCost

Constructor Details

SimpleImmutableBitmapIterableIndex

public SimpleImmutableBitmapIterableIndex()

Method Details

computeBitmapResult

public final <T> T computeBitmapResult(BitmapResultFactory<T> bitmapResultFactory,
 boolean includeUnknown)

Description copied from interface: BitmapColumnIndex

Compute a bitmap result wrapped with the BitmapResultFactory representing the rows matched by this index. If building a cursor, use BitmapColumnIndex.computeBitmapResult(BitmapResultFactory, int, int, boolean) instead.

Parameters:

bitmapResultFactory - helper to format the ImmutableBitmap in a form ready for consumption by callers

includeUnknown - mapping for Druid native two state logic system into SQL three-state logic system. If set to true, bitmaps returned by this method should include true bits for any rows where the matching result is 'unknown', such as from the input being null valued.

Returns:

bitmap result representing rows matched by this index

getBitmapIterable

protected abstract Iterable<ImmutableBitmap> getBitmapIterable(boolean includeUnknown)