Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> lucene >> [ index overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.lucene.index
Class MultiTermPositions  

java.lang.Object
  org.apache.lucene.index.MultiTermDocs
      org.apache.lucene.index.MultiTermPositions

All Implemented Interfaces:

TermDocs, TermPositions

---

class MultiTermPositions

extends MultiTermDocs

implements TermPositions

---

Field Summary
protected  int	base
protected  TermDocs	current
protected  int	pointer
protected  IndexReader[]	readers
protected  int[]	starts
protected  Term	term

 

Constructor Summary

MultiTermPositions(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	nextPosition()           Returns next position in the current document.
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)

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface org.apache.lucene.index.TermDocs

close, doc, freq, next, read, seek, seek, skipTo

 

Field Detail

readers

protected IndexReader[] readers

---

starts

protected int[] starts

---

term

protected Term term

---

base

protected int base

---

pointer

protected int pointer

---

current

protected TermDocs current

Constructor Detail

MultiTermPositions

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

Method Detail

termDocs

protected TermDocs termDocs(IndexReader reader)
                     throws java.io.IOException

Overrides:

termDocs in class MultiTermDocs

---

nextPosition

public int nextPosition()
                 throws java.io.IOException

Description copied from interface: TermPositions

Returns next position in the current document. It is an error to call this more than TermDocs.freq() 55 times without calling TermDocs.next() 55

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

Specified by:

nextPosition in interface TermPositions

---

doc

public int doc()

Description copied from interface: TermDocs

Returns the current document number.

This is invalid until TermDocs.next() 55 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() 55 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 java.io.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

---

next

public boolean next()
             throws java.io.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

---

read

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

Optimized implementation.

Specified by:

read in interface TermDocs

---

skipTo

public boolean skipTo(int target)
               throws java.io.IOException

As yet unoptimized implementation.

Specified by:

skipTo in interface TermDocs

---

close

public void close()
           throws java.io.IOException

Description copied from interface: TermDocs

Frees associated resources.

Specified by:

close in interface TermDocs

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> lucene >> [ index overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---