org.elasticsearch.common.lucene.docset

Class DocIdSets

java.lang.Object

org.elasticsearch.common.lucene.docset.DocIdSets

public class DocIdSets
extends Object

Constructor Summary

Constructors

Constructor and Description
DocIdSets()

Method Summary

Modifier and Type	Method and Description
static boolean	isEmpty(org.apache.lucene.search.DocIdSet set) Is it an empty DocIdSet?
static boolean	isFastIterator(org.apache.lucene.search.DocIdSet set) Is DocIdSetIterator implemented in a "fast" manner.
static long	sizeInBytes(org.apache.lucene.search.DocIdSet docIdSet) Return the size of the doc id set, plus a reference to it.
static org.apache.lucene.search.DocIdSet	toCacheable(org.apache.lucene.index.AtomicReader reader, org.apache.lucene.search.DocIdSet set) Converts to a cacheable DocIdSet Note, we don't use DocIdSet.isCacheable() because execution might be expensive even if its cacheable (i.e.
static org.apache.lucene.util.FixedBitSet	toFixedBitSet(org.apache.lucene.search.DocIdSetIterator iterator, int numBits) Creates a FixedBitSet from an iterator.
static org.apache.lucene.util.Bits	toSafeBits(org.apache.lucene.index.AtomicReader reader, org.apache.lucene.search.DocIdSet set) Gets a set to bits.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocIdSets

public DocIdSets()

Method Detail

sizeInBytes

public static long sizeInBytes(org.apache.lucene.search.DocIdSet docIdSet)

Return the size of the doc id set, plus a reference to it.

isEmpty

public static boolean isEmpty(@Nullable
                              org.apache.lucene.search.DocIdSet set)

Is it an empty DocIdSet?

isFastIterator

public static boolean isFastIterator(org.apache.lucene.search.DocIdSet set)

Is DocIdSetIterator implemented in a "fast" manner. For example, it does not ends up iterating one doc at a time check for its "value".

toCacheable

public static org.apache.lucene.search.DocIdSet toCacheable(org.apache.lucene.index.AtomicReader reader,
                                                            @Nullable
                                                            org.apache.lucene.search.DocIdSet set)
                                                     throws IOException

Converts to a cacheable DocIdSet

Note, we don't use DocIdSet.isCacheable() because execution might be expensive even if its cacheable (i.e. not going back to the reader to execute). We effectively always either return an empty DocIdSet or FixedBitSet but never null.

Throws:

IOException

toSafeBits

public static org.apache.lucene.util.Bits toSafeBits(org.apache.lucene.index.AtomicReader reader,
                                                     @Nullable
                                                     org.apache.lucene.search.DocIdSet set)
                                              throws IOException

Gets a set to bits.

Throws:

IOException

toFixedBitSet

public static org.apache.lucene.util.FixedBitSet toFixedBitSet(org.apache.lucene.search.DocIdSetIterator iterator,
                                                               int numBits)
                                                        throws IOException

Creates a FixedBitSet from an iterator.

Throws:

IOException