Module org.apache.lucene.core

Package org.apache.lucene.util

Class DocIdSetBuilder

java.lang.Object

org.apache.lucene.util.DocIdSetBuilder

public final class DocIdSetBuilder
extends Object

A builder of DocIdSets. At first it uses a sparse structure to gather documents, and then upgrades to a non-sparse bit set once enough hits match.

To add documents, you first need to call grow(int) in order to reserve space, and then call DocIdSetBuilder.BulkAdder.add(int) on the returned DocIdSetBuilder.BulkAdder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DocIdSetBuilder.Buffer
private static class	DocIdSetBuilder.BufferAdder
static class	DocIdSetBuilder.BulkAdder	Utility class to efficiently add many docs in one go.
private static class	DocIdSetBuilder.FixedBitSetAdder

Field Summary

Fields

Modifier and Type	Field	Description
private DocIdSetBuilder.BulkAdder	adder
private FixedBitSet	bitSet
private List<DocIdSetBuilder.Buffer>	buffers
private long	counter
private final int	maxDoc
(package private) final boolean	multivalued
(package private) final double	numValuesPerDoc
private final int	threshold
private int	totalAllocated

Constructor Summary

Constructors

Constructor	Description
DocIdSetBuilder(int maxDoc)	Create a builder that can contain doc IDs between 0 and maxDoc.
DocIdSetBuilder(int maxDoc, int docCount, long valueCount)
DocIdSetBuilder(int maxDoc, PointValues values, String field)	Create a DocIdSetBuilder instance that is optimized for accumulating docs that match the given PointValues.
DocIdSetBuilder(int maxDoc, Terms terms)	Create a DocIdSetBuilder instance that is optimized for accumulating docs that match the given Terms.

Method Summary

Modifier and Type	Method	Description
void	add(DocIdSetIterator iter)	Add the content of the provided DocIdSetIterator to this builder.
private DocIdSetBuilder.Buffer	addBuffer(int len)
private int	additionalCapacity(int numDocs)
DocIdSet	build()	Build a DocIdSet from the accumulated doc IDs.
private static DocIdSetBuilder.Buffer	concat(List<DocIdSetBuilder.Buffer> buffers)	Concatenate the buffers in any order, leaving at least one empty slot in the end NOTE: this method might reuse one of the arrays
private static int	dedup(int[] arr, int length)
private void	ensureBufferCapacity(int numDocs)
DocIdSetBuilder.BulkAdder	grow(int numDocs)	Reserve space and return a DocIdSetBuilder.BulkAdder object that can be used to add up to numDocs documents.
private void	growBuffer(DocIdSetBuilder.Buffer buffer, int additionalCapacity)
private static boolean	noDups(int[] a, int len)
private void	upgradeToBitSet()

Methods inherited from class java.lang.Object

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

Field Details

maxDoc

private final int maxDoc

threshold

private final int threshold

multivalued

final boolean multivalued

numValuesPerDoc

final double numValuesPerDoc

buffers

private List<DocIdSetBuilder.Buffer> buffers

totalAllocated

private int totalAllocated

bitSet

private FixedBitSet bitSet

counter

private long counter

adder

private DocIdSetBuilder.BulkAdder adder

Constructor Details

DocIdSetBuilder

public DocIdSetBuilder(int maxDoc)

Create a builder that can contain doc IDs between 0 and maxDoc.

DocIdSetBuilder

public DocIdSetBuilder(int maxDoc,
 Terms terms)
                throws IOException

Create a DocIdSetBuilder instance that is optimized for accumulating docs that match the given Terms.

Throws:

IOException

DocIdSetBuilder

public DocIdSetBuilder(int maxDoc,
 PointValues values,
 String field)
                throws IOException

Create a DocIdSetBuilder instance that is optimized for accumulating docs that match the given PointValues.

Throws:

IOException

DocIdSetBuilder

DocIdSetBuilder(int maxDoc,
 int docCount,
 long valueCount)

Method Details

add

public void add(DocIdSetIterator iter)
         throws IOException

Add the content of the provided DocIdSetIterator to this builder. NOTE: if you need to build a DocIdSet out of a single DocIdSetIterator, you should rather use RoaringDocIdSet.Builder.

Throws:

IOException

grow

public DocIdSetBuilder.BulkAdder grow(int numDocs)

Reserve space and return a DocIdSetBuilder.BulkAdder object that can be used to add up to numDocs documents.

ensureBufferCapacity

private void ensureBufferCapacity(int numDocs)

additionalCapacity

private int additionalCapacity(int numDocs)

addBuffer

private DocIdSetBuilder.Buffer addBuffer(int len)

growBuffer

private void growBuffer(DocIdSetBuilder.Buffer buffer,
 int additionalCapacity)

upgradeToBitSet

private void upgradeToBitSet()

build

public DocIdSet build()

Build a DocIdSet from the accumulated doc IDs.

concat

private static DocIdSetBuilder.Buffer concat(List<DocIdSetBuilder.Buffer> buffers)

Concatenate the buffers in any order, leaving at least one empty slot in the end NOTE: this method might reuse one of the arrays

dedup

private static int dedup(int[] arr,
 int length)

noDups

private static boolean noDups(int[] a,
 int len)