org.apache.lucene.search
Class FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet.FieldCacheTermsFilterDocIdSetIterator

java.lang.Object
  org.apache.lucene.search.DocIdSetIterator
      org.apache.lucene.search.FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet.FieldCacheTermsFilterDocIdSetIterator

Enclosing class:

FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet

protected class FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet.FieldCacheTermsFilterDocIdSetIterator
extends DocIdSetIterator

Field Summary

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

NO_MORE_DOCS

Constructor Summary

protected

FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet.FieldCacheTermsFilterDocIdSetIterator()

Method Summary

int	advance(int target) Advances to the first beyond the current whose document number is greater than or equal to target.
int	doc() Deprecated. use docID() instead.
int	docID() Returns the following: -1 or DocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
boolean	next() Deprecated. use nextDoc() instead.
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: in 3.0 this method will become abstract, following the removal of DocIdSetIterator.next().
boolean	skipTo(int target) Deprecated. use advance(int) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet.FieldCacheTermsFilterDocIdSetIterator

protected FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet.FieldCacheTermsFilterDocIdSetIterator()

Method Detail

doc

public int doc()

Deprecated. use docID() instead.

Description copied from class: DocIdSetIterator

Unsupported anymore. Call DocIdSetIterator.docID() instead. This method throws UnsupportedOperationException if called.

Overrides:

doc in class DocIdSetIterator

docID

public int docID()

Description copied from class: DocIdSetIterator

Returns the following:

• -1 or DocIdSetIterator.NO_MORE_DOCS 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.

NOTE: in 3.0, this method will become abstract.

Overrides:

docID in class DocIdSetIterator

next

public boolean next()

Deprecated. use nextDoc() instead.

Description copied from class: DocIdSetIterator

Unsupported anymore. Call DocIdSetIterator.nextDoc() instead. This method throws UnsupportedOperationException if called.

Overrides:

next in class DocIdSetIterator

nextDoc

public int nextDoc()

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: in 3.0 this method will become abstract, following the removal of DocIdSetIterator.next(). For backward compatibility it is implemented as:

 public int nextDoc() throws IOException {
   return next() ? doc() : NO_MORE_DOCS;
 }
 

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Overrides:

nextDoc in class DocIdSetIterator

skipTo

public boolean skipTo(int target)

Deprecated. use advance(int) instead.

Description copied from class: DocIdSetIterator

Unsupported anymore. Call DocIdSetIterator.advance(int) instead. This method throws UnsupportedOperationException if called.

Overrides:

skipTo in class DocIdSetIterator

advance

public int advance(int target)

Description copied from class: DocIdSetIterator

Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.

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: certain implementations may return a different value (each time) if called several times in a row with the same target.

NOTE: this method may be called with 2147483647 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.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

NOTE: in 3.0 this method will become abstract, following the removal of DocIdSetIterator.skipTo(int).

Overrides:

advance in class DocIdSetIterator