Module org.elasticsearch.server

Package org.elasticsearch.search.vectors

Class ESAcceptDocs.ScorerSupplierAcceptDocs

java.lang.Object

org.apache.lucene.search.AcceptDocs

org.elasticsearch.search.vectors.ESAcceptDocs

org.elasticsearch.search.vectors.ESAcceptDocs.ScorerSupplierAcceptDocs

Enclosing class:

ESAcceptDocs

public static final class ESAcceptDocs.ScorerSupplierAcceptDocs
extends ESAcceptDocs

An AcceptDocs that wraps a ScorerSupplier. Indicates that a filter was provided.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.vectors.ESAcceptDocs

ESAcceptDocs.BitsAcceptDocs, ESAcceptDocs.ESAcceptDocsAll, ESAcceptDocs.ScorerSupplierAcceptDocs

Method Summary

Modifier and Type	Method	Description
int	approximateCost()	Returns an approximate cost of the accepted documents.
org.apache.lucene.util.Bits	bits()
int	cost()
Optional<org.apache.lucene.util.BitSet>	getBitSet()	Returns an optional BitSet representing the accepted documents.
org.apache.lucene.search.DocIdSetIterator	iterator()

Methods inherited from class org.apache.lucene.search.AcceptDocs

fromIteratorSupplier, fromLiveDocs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

bits

public org.apache.lucene.util.Bits bits()
                                 throws IOException

Specified by:

bits in class org.apache.lucene.search.AcceptDocs

Throws:

IOException

iterator

public org.apache.lucene.search.DocIdSetIterator iterator()
                                                   throws IOException

Specified by:

iterator in class org.apache.lucene.search.AcceptDocs

Throws:

IOException

cost

public int cost()
         throws IOException

Specified by:

cost in class org.apache.lucene.search.AcceptDocs

Throws:

IOException

approximateCost

public int approximateCost()
                    throws IOException

Description copied from class: ESAcceptDocs

Returns an approximate cost of the accepted documents. This is generally much cheaper than AcceptDocs.cost(), as implementations may not fully evaluate filters to provide this estimate and may ignore deletions

Specified by:

approximateCost in class ESAcceptDocs

Returns:

the approximate cost

Throws:

IOException - if an I/O error occurs

getBitSet

public Optional<org.apache.lucene.util.BitSet> getBitSet()
                                                  throws IOException

Description copied from class: ESAcceptDocs

Returns an optional BitSet representing the accepted documents. If a BitSet representation is not available, returns an empty Optional. An empty optional indicates that there are some accepted documents, but they cannot be represented as a BitSet efficiently. Null implies that all documents are accepted.

Specified by:

getBitSet in class ESAcceptDocs

Returns:

an Optional containing the BitSet of accepted documents, or empty if not available, or null if all documents are accepted

Throws:

IOException - if an I/O error occurs