gate.creole.annic.apache.lucene.index
Class MultiTermDocs

java.lang.Object
  gate.creole.annic.apache.lucene.index.MultiTermDocs

All Implemented Interfaces:

TermDocs

Direct Known Subclasses:

MultiTermPositions

 class MultiTermDocs
extends Object
implements TermDocs

Field Summary

protected int	base
protected TermDocs	current
protected int	pointer
protected IndexReader[]	readers
private TermDocs[]	readerTermDocs
protected int[]	starts
protected Term	term

Constructor Summary

MultiTermDocs(IndexReader[] r, int[] s)

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) Optimized implementation.
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 target) As yet unoptimized implementation.
protected TermDocs	termDocs(IndexReader reader)
private TermDocs	termDocs(int i)

Methods inherited from class java.lang.Object

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

Field Detail

readers

protected IndexReader[] readers

starts

protected int[] starts

term

protected Term term

base

protected int base

pointer

protected int pointer

readerTermDocs

private TermDocs[] readerTermDocs

current

protected TermDocs current

Constructor Detail

MultiTermDocs

public MultiTermDocs(IndexReader[] r,
                     int[] s)

Method Detail

doc

public int doc()

Description copied from interface: TermDocs

Returns the current document number.

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

Specified by:

doc in interface TermDocs

freq

public int freq()

Description copied from interface: TermDocs

Returns the frequency of the term within the current document.

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

Specified by:

freq in interface TermDocs

seek

public void seek(Term term)

Description copied from interface: TermDocs

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

Description copied from interface: TermDocs

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

Throws:

IOException

next

public boolean next()
             throws IOException

Description copied from interface: TermDocs

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

Throws:

IOException

read

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

Optimized implementation.

Specified by:

read in interface TermDocs

Throws:

IOException

skipTo

public boolean skipTo(int target)
               throws IOException

As yet unoptimized implementation.

Specified by:

skipTo in interface TermDocs

Throws:

IOException

termDocs

private TermDocs termDocs(int i)
                   throws IOException

Throws:

IOException

termDocs

protected TermDocs termDocs(IndexReader reader)
                     throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: TermDocs

Frees associated resources.

Specified by:

close in interface TermDocs

Throws:

IOException