SimpleImmutableBitmapIterableIndex (druid-processing 28.0.0 API)

java.lang.Object
- org.apache.druid.segment.index.SimpleBitmapColumnIndex
- - org.apache.druid.segment.index.SimpleImmutableBitmapIterableIndex

All Implemented Interfaces:

BitmapColumnIndex
```
public abstract class SimpleImmutableBitmapIterableIndex
extends SimpleBitmapColumnIndex
```
SimpleBitmapColumnIndex for anything which can compute an Iterable in some manner

Field Summary
- Fields inherited from class org.apache.druid.segment.index.SimpleBitmapColumnIndex
  CAPABILITIES

Constructor Summary

Constructors
Constructor Description

SimpleImmutableBitmapIterableIndex()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`<T> T`	`computeBitmapResult(BitmapResultFactory<T> bitmapResultFactory, boolean includeUnknown)`	Compute a bitmap result wrapped with the `BitmapResultFactory` representing the rows matched by this index.
`double`	`estimateSelectivity(int totalRows)`
`protected abstract Iterable<ImmutableBitmap>`	`getBitmapIterable()`
`protected abstract ImmutableBitmap`	`getUnknownsBitmap()`

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

- Constructor Detail
  - SimpleImmutableBitmapIterableIndex
```
public SimpleImmutableBitmapIterableIndex()
```
- Method Detail
  - estimateSelectivity
```
public double estimateSelectivity(int totalRows)
```
  - computeBitmapResult
```
public <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.
    
    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, this method should also return true if the result is 'unknown' to be a match, such as from the input being null valued. Used primarily to allow NotFilter to invert a match in an SQL compliant manner
    
    Returns:
    
    bitmap result representing rows matched by this index
  - getBitmapIterable
```
protected abstract Iterable<ImmutableBitmap> getBitmapIterable()
```
  - getUnknownsBitmap
```
@Nullable
protected abstract ImmutableBitmap getUnknownsBitmap()
```