org.apache.lucene.index

Class FilterIndexReader.FilterTermDocs

Enclosing Class:
FilterIndexReader
Implemented Interfaces:
TermDocs
Known Direct Subclasses:
FilterIndexReader.FilterTermPositions

public static class FilterIndexReader.FilterTermDocs
extends Object
implements TermDocs

Base class for filtering TermDocs implementations.

Field Summary

protected TermDocs
in

Constructor Summary

FilterTermDocs(TermDocs in)

Method Summary

void
close()
Frees associated resources.
int
doc()
Returns the current document number.
int
freq()
Returns the frequency of the term within the current document.
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(Term term)
Sets this to the data for a term.
void
seek(TermEnum termEnum)
Sets this to the data for the current term in a TermEnum.
boolean
skipTo(int i)
Skips entries to the first beyond the current whose document number is greater than or equal to target.

Field Details

in

protected TermDocs in

Constructor Details

FilterTermDocs

public FilterTermDocs(TermDocs in)

Method Details

close

public void close()
            throws IOException
Frees associated resources.
Specified by:
close in interface TermDocs

doc

public int doc()
Specified by:
doc in interface TermDocs

freq

public int freq()
Specified by:
freq in interface TermDocs

next

public boolean next()
            throws IOException
Moves to the next pair in the enumeration.

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

Specified by:
next in interface TermDocs

read

public int read(int[] docs,
                int[] freqs)
            throws IOException
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.

Specified by:
read in interface TermDocs

seek

public void seek(Term term)
            throws IOException
Sets this to the data for a term. The enumeration is reset to the start of the data for this term.
Specified by:
seek in interface TermDocs

seek

public void seek(TermEnum termEnum)
            throws IOException
Sets this to the data for the current term in a TermEnum. This may be optimized in some implementations.
Specified by:
seek in interface TermDocs

skipTo

public boolean skipTo(int i)
            throws IOException
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.
Specified by:
skipTo in interface TermDocs

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.