Package org.apache.lucene.index

Class FilterSortedDocValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.BinaryDocValues

org.apache.lucene.index.SortedDocValues

org.apache.lucene.index.FilterSortedDocValues

public abstract class FilterSortedDocValues
extends SortedDocValues

Delegates all methods to a wrapped SortedDocValues.

Field Summary

Fields

Modifier and Type	Field	Description
protected SortedDocValues	in	Wrapped values

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
FilterSortedDocValues(SortedDocValues in)	Sole constructor

Method Summary

Modifier and Type	Method	Description
int	advance(int target)	Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.
boolean	advanceExact(int target)	Advance the iterator to exactly target and return whether target has a value.
BytesRef	binaryValue()	Returns the binary value for the current document ID.
long	cost()	Returns the estimated cost of this DocIdSetIterator.
int	docID()	Returns the following: -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
int	getValueCount()	Returns the number of unique values.
TermsEnum	intersect(CompiledAutomaton automaton)	Returns a TermsEnum over the values, filtered by a CompiledAutomaton The enum supports TermsEnum.ord().
BytesRef	lookupOrd(int ord)	Retrieves the value for the specified ordinal.
int	lookupTerm(BytesRef key)	If key exists, returns its ordinal, else returns -insertionPoint-1, like Arrays.binarySearch.
int	nextDoc()	Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set. NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
int	ordValue()	Returns the ordinal for the current docID.
TermsEnum	termsEnum()	Returns a TermsEnum over the values.

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

all, empty, range, slowAdvance

Methods inherited from class java.lang.Object

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

Field Detail

in

protected final SortedDocValues in

Wrapped values

Constructor Detail

FilterSortedDocValues

public FilterSortedDocValues(SortedDocValues in)

Sole constructor

Method Detail

advanceExact

public boolean advanceExact(int target)
                     throws IOException

Advance the iterator to exactly target and return whether target has a value. target must be greater than or equal to the current doc ID and must be a valid doc ID, ie. ≥ 0 and < maxDoc. After this method returns, DocIdSetIterator.docID() returns target.

Throws:

IOException

ordValue

public int ordValue()
             throws IOException

Description copied from class: SortedDocValues

Returns the ordinal for the current docID. It is illegal to call this method after advanceExact(int) returned false.

Specified by:

ordValue in class SortedDocValues

Returns:

ordinal for the document: this is dense, starts at 0, then increments by 1 for the next value in sorted order.

Throws:

IOException

lookupOrd

public BytesRef lookupOrd(int ord)
                   throws IOException

Description copied from class: SortedDocValues

Retrieves the value for the specified ordinal. The returned BytesRef may be re-used across calls to SortedDocValues.lookupOrd(int) so make sure to copy it if you want to keep it around.

Specified by:

lookupOrd in class SortedDocValues

Parameters:

ord - ordinal to lookup (must be >= 0 and < SortedDocValues.getValueCount())

Throws:

IOException

See Also:

SortedDocValues.ordValue()

binaryValue

public BytesRef binaryValue()
                     throws IOException

Description copied from class: BinaryDocValues

Returns the binary value for the current document ID. It is illegal to call this method after advanceExact(int) returned false.

Overrides:

binaryValue in class SortedDocValues

Returns:

binary value

Throws:

IOException

getValueCount

public int getValueCount()

Description copied from class: SortedDocValues

Returns the number of unique values.

Specified by:

getValueCount in class SortedDocValues

Returns:

number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.

lookupTerm

public int lookupTerm(BytesRef key)
               throws IOException

Description copied from class: SortedDocValues

If key exists, returns its ordinal, else returns -insertionPoint-1, like Arrays.binarySearch.

Overrides:

lookupTerm in class SortedDocValues

Parameters:

key - Key to look up

Throws:

IOException

termsEnum

public TermsEnum termsEnum()
                    throws IOException

Description copied from class: SortedDocValues

Returns a TermsEnum over the values. The enum supports TermsEnum.ord() and TermsEnum.seekExact(long).

Overrides:

termsEnum in class SortedDocValues

Throws:

IOException

intersect

public TermsEnum intersect(CompiledAutomaton automaton)
                    throws IOException

Description copied from class: SortedDocValues

Returns a TermsEnum over the values, filtered by a CompiledAutomaton The enum supports TermsEnum.ord().

Overrides:

intersect in class SortedDocValues

Throws:

IOException

docID

public int docID()

Description copied from class: DocIdSetIterator

Returns the following:

• -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
• DocIdSetIterator.NO_MORE_DOCS if the iterator has exhausted.
• Otherwise it should return the doc ID it is currently on.

Specified by:

docID in class DocIdSetIterator

nextDoc

public int nextDoc()
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Specified by:

nextDoc in class DocIdSetIterator

Throws:

IOException

advance

public int advance(int target)
            throws IOException

Description copied from class: DocIdSetIterator

Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.

The behavior of this method is undefined when called with target ≤ current, or after the iterator has exhausted. Both cases may result in unpredicted behavior.

When target > current it behaves as if written:

 int advance(int target) {
   int doc;
   while ((doc = nextDoc()) < target) {
   }
   return doc;
 }
 

Some implementations are considerably more efficient than that.

NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

Specified by:

advance in class DocIdSetIterator

Throws:

IOException

cost

public long cost()

Description copied from class: DocIdSetIterator

Returns the estimated cost of this DocIdSetIterator.

This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.

Specified by:

cost in class DocIdSetIterator