Package org.apache.lucene.util
Class NotDocIdSet
java.lang.Object
org.apache.lucene.search.DocIdSet
org.apache.lucene.util.NotDocIdSet
- All Implemented Interfaces:
Accountable
This
DocIdSet
encodes the negation of another DocIdSet
. 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
-
Method Summary
Modifier and TypeMethodDescriptionbits()
Optionally provides aBits
interface for random access to matching documents.iterator()
Provides aDocIdSetIterator
to access the set.long
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 Details
-
NotDocIdSet
Sole constructor.
-
-
Method Details
-
bits
Description copied from class:DocIdSet
Optionally provides aBits
interface for random access to matching documents.- Overrides:
bits
in classDocIdSet
- Returns:
null
, if thisDocIdSet
does not support random access. In contrast toDocIdSet.iterator()
, a return value ofnull
does 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 (asBits
interface 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:Accountable
Return the memory usage of this object in bytes. Negative values are illegal. -
iterator
Description copied from class:DocIdSet
Provides aDocIdSetIterator
to access the set. This implementation can returnnull
if there are no docs that match.- Specified by:
iterator
in classDocIdSet
- Throws:
IOException
-