public abstract class

AbstractAllTermDocs

extends Object
implements TermDocs
java.lang.Object
   ↳ org.apache.lucene.index.AbstractAllTermDocs

Class Overview

Base class for enumerating all but deleted docs.

NOTE: this class is meant only to be used internally by Lucene; it's only public so it can be shared across packages. This means the API is freely subject to change, and, the class could be removed entirely, in any Lucene release. Use directly at your own risk!

Summary

Fields
protected int doc
protected int maxDoc
Protected Constructors
AbstractAllTermDocs(int maxDoc)
Public Methods
void close()
Frees associated resources.
int doc()
Returns the current document number.
int freq()
Returns the frequency of the term within the current document.
abstract boolean isDeleted(int doc)
boolean next()
Moves to the next pair in the enumeration.
int read(int[] docs, int[] freqs)
Attempts to read multiple entries from the enumeration, up to length of docs.
void seek(TermEnum termEnum)
Sets this to the data for the current term in a TermEnum.
void seek(Term term)
Sets this to the data for a term.
boolean skipTo(int target)
Skips entries to the first beyond the current whose document number is greater than or equal to target.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.io.Closeable
From interface org.apache.lucene.index.TermDocs

Fields

protected int doc

protected int maxDoc

Protected Constructors

protected AbstractAllTermDocs (int maxDoc)

Public Methods

public void close ()

Frees associated resources.

Throws
IOException

public int doc ()

Returns the current document number.

This is invalid until next() is called for the first time.

public int freq ()

Returns the frequency of the term within the current document.

This is invalid until next() is called for the first time.

public abstract boolean isDeleted (int doc)

public boolean next ()

Moves to the next pair in the enumeration.

Returns true iff there is such a next pair in the enumeration.

Throws
IOException

public int read (int[] docs, int[] freqs)

Attempts to read multiple entries from the enumeration, up to length of docs. Document numbers are stored in docs, and term frequencies are stored in freqs. The freqs array must be as long as the docs array.

Returns the number of entries read. Zero is only returned when the stream has been exhausted.

Throws
IOException

public void seek (TermEnum termEnum)

Sets this to the data for the current term in a TermEnum. This may be optimized in some implementations.

Throws
IOException

public void seek (Term term)

Sets this to the data for a term. The enumeration is reset to the start of the data for this term.

Throws
IOException

public boolean skipTo (int target)

Skips entries to the first beyond the current whose document number is greater than or equal to target.

Returns true iff there is such an entry.

Behaves as if written: 

   boolean skipTo(int target) {
     do {
       if (!next())
 	     return false;
     } while (target > doc());
     return true;
   }
Some implementations are considerably more efficient than that.

Throws
IOException