public abstract class DocIdSet extends Object implements Accountable
iterator()
to provide access to the set.Modifier and Type | Field and Description |
---|---|
static DocIdSet |
EMPTY
An empty
DocIdSet instance |
Constructor and Description |
---|
DocIdSet() |
Modifier and Type | Method and Description |
---|---|
Bits |
bits()
Optionally provides a
Bits interface for random access
to matching documents. |
abstract DocIdSetIterator |
iterator()
Provides a
DocIdSetIterator to access the set. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getChildResources, ramBytesUsed
public static final DocIdSet EMPTY
DocIdSet
instancepublic abstract DocIdSetIterator iterator() throws IOException
DocIdSetIterator
to access the set.
This implementation can return null
if there
are no docs that match.IOException
public Bits bits() throws IOException
Bits
interface for random access
to matching documents.null
, if this DocIdSet
does not support random access.
In contrast to iterator()
, a return value of null
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 (as Bits
interface cannot throw
IOException
). This is generally true for bit sets
like FixedBitSet
, which return
itself if they are used as DocIdSet
.IOException
Copyright © 2000-2016 Apache Software Foundation. All Rights Reserved.