Package org.apache.lucene.util
Class NotDocIdSet
- java.lang.Object
-
- org.apache.lucene.search.DocIdSet
-
- org.apache.lucene.util.NotDocIdSet
-
- All Implemented Interfaces:
Accountable
public final class NotDocIdSet extends DocIdSet
ThisDocIdSetencodes the negation of anotherDocIdSet. It is cacheable and supports random-access if the underlying set is cacheable and supports random-access.- 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 NotDocIdSet(int maxDoc, DocIdSet in)Sole constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Bitsbits()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.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
-
-
-
Constructor Detail
-
NotDocIdSet
public NotDocIdSet(int maxDoc, DocIdSet in)Sole constructor.
-
-
Method Detail
-
bits
public Bits bits() throws IOException
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.- Throws:
IOException
-
ramBytesUsed
public long ramBytesUsed()
Description copied from interface:AccountableReturn the memory usage of this object in bytes. Negative values are illegal.
-
iterator
public DocIdSetIterator iterator() throws IOException
Description copied from class:DocIdSetProvides aDocIdSetIteratorto access the set. This implementation can returnnullif there are no docs that match.- Specified by:
iteratorin classDocIdSet- Throws:
IOException
-
-