org.roaringbitmap

Class OrderedWriter

java.lang.Object

org.roaringbitmap.OrderedWriter

public class OrderedWriter
extends Object

This class can be used to write quickly values to a bitmap. The values are expected to be (increasing) sorted order. Values are first written to a temporary internal buffer, but the underlying bitmap can forcefully synchronize by calling "flush" (although calling flush to often would defeat the performance purpose of this class). The main use case for an OrderedWriter is to create bitmaps quickly. You should benchmark your particular use case to see if it helps.

 

       //...

       RoaringBitmap r = new RoaringBitmap();
       OrderedWriter ow = new OrderedWriter(r);
       for (int i :....) {
         ow.add(i);
       }
       ow.flush(); // important
 
 

Constructor Summary

Constructors

Constructor and Description
OrderedWriter(RoaringBitmap underlying) Initialize an OrderedWriter with a receiving bitmap

Method Summary

Modifier and Type	Method and Description
void	add(int value) Adds the value to the underlying bitmap.
void	flush() Ensures that any buffered additions are flushed to the underlying bitmap.
RoaringBitmap	getUnderlying() Grab a reference to the underlying bitmap

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderedWriter

public OrderedWriter(RoaringBitmap underlying)

Initialize an OrderedWriter with a receiving bitmap

Parameters:

underlying - bitmap where the data gets written

Method Detail

getUnderlying

public RoaringBitmap getUnderlying()

Grab a reference to the underlying bitmap

Returns:

the underlying bitmap

add

public void add(int value)

Adds the value to the underlying bitmap. The data might be added to a temporary buffer. You should call "flush" when you are done.

Parameters:

value - the value to add.

Throws:

IllegalStateException - if values are not added in increasing order

flush

public void flush()

Ensures that any buffered additions are flushed to the underlying bitmap.