Package org.apache.lucene.util
Class BitDocIdSet
- java.lang.Object
-
- org.apache.lucene.search.DocIdSet
-
- org.apache.lucene.util.BitDocIdSet
-
- All Implemented Interfaces:
Accountable
public class BitDocIdSet extends DocIdSet
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
-
Field Summary
-
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE
-
-
Constructor Summary
Constructors Constructor Description BitDocIdSet(BitSet set)Same asBitDocIdSet(BitSet, long)but uses the set'sapproximate cardinalityas a cost.BitDocIdSet(BitSet set, long cost)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BitSetbits()Optionally provides aBitsinterface for random access to matching documents.DocIdSetIteratoriterator()Provides aDocIdSetIteratorto access the set.longramBytesUsed()Return the memory usage of this object in bytes.StringtoString()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
-
-
-
Constructor Detail
-
BitDocIdSet
public BitDocIdSet(BitSet set, long cost)
-
BitDocIdSet
public BitDocIdSet(BitSet set)
Same asBitDocIdSet(BitSet, long)but uses the set'sapproximate cardinalityas a cost.
-
-
Method Detail
-
iterator
public DocIdSetIterator iterator()
Description copied from class:DocIdSetProvides aDocIdSetIteratorto access the set. This implementation can returnnullif there are no docs that match.
-
bits
public BitSet bits()
Description copied from class:DocIdSetOptionally provides aBitsinterface for random access to matching documents.- Overrides:
bitsin classDocIdSet- Returns:
null, if thisDocIdSetdoes not support random access. In contrast toDocIdSet.iterator(), a return value ofnulldoes not imply that no documents match the filter! The default implementation does not provide random access, so you only need to implement this method if your DocIdSet can guarantee random access to every docid in O(1) time without external disk access (asBitsinterface cannot throwIOException). This is generally true for bit sets likeFixedBitSet, which return itself if they are used asDocIdSet.
-
ramBytesUsed
public long ramBytesUsed()
Description copied from interface:AccountableReturn the memory usage of this object in bytes. Negative values are illegal.
-
-