Package org.apache.lucene.util
Class DocIdSetBuilder
java.lang.Object
org.apache.lucene.util.DocIdSetBuilder
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.
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceUtility class to efficiently add many docs in one go. -
Constructor Summary
ConstructorsConstructorDescriptionDocIdSetBuilder(int maxDoc) Create a builder that can contain doc IDs between0andmaxDoc.DocIdSetBuilder(int maxDoc, PointValues values) Create aDocIdSetBuilderinstance that is optimized for accumulating docs that match the givenPointValues.DocIdSetBuilder(int maxDoc, Terms terms) Create aDocIdSetBuilderinstance that is optimized for accumulating docs that match the givenTerms. -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(DocIdSetIterator iter) Add the content of the providedDocIdSetIteratorto this builder.build()Build aDocIdSetfrom the accumulated doc IDs.grow(int numDocs) Reserve space and return aDocIdSetBuilder.BulkAdderobject that can be used to add up tonumDocsdocuments.
-
Constructor Details
-
DocIdSetBuilder
public DocIdSetBuilder(int maxDoc) Create a builder that can contain doc IDs between0andmaxDoc. -
DocIdSetBuilder
Create aDocIdSetBuilderinstance that is optimized for accumulating docs that match the givenTerms.- Throws:
IOException
-
DocIdSetBuilder
Create aDocIdSetBuilderinstance that is optimized for accumulating docs that match the givenPointValues.- Throws:
IOException
-
-
Method Details
-
add
Add the content of the providedDocIdSetIteratorto this builder. NOTE: if you need to build aDocIdSetout of a singleDocIdSetIterator, you should rather useRoaringDocIdSet.Builder.- Throws:
IOException
-
grow
Reserve space and return aDocIdSetBuilder.BulkAdderobject that can be used to add up tonumDocsdocuments. -
build
Build aDocIdSetfrom the accumulated doc IDs.
-