ivory.core.data.document

Class LazyTermDocVector.Reader

java.lang.Object

ivory.core.data.document.LazyTermDocVector.Reader

All Implemented Interfaces:

TermDocVector.Reader

Enclosing class:

LazyTermDocVector

public static class LazyTermDocVector.Reader
extends Object
implements TermDocVector.Reader

Constructor Summary

Constructors

Constructor and Description
LazyTermDocVector.Reader(int nTerms, byte[] bytes, String[] terms)

Method Summary

Methods

Modifier and Type	Method and Description
int	getNumberOfTerms() Returns the total number of terms in this document.
int[]	getPositions() Returns the position offsets of the current term as an array.
boolean	getPositions(TermPositions tp) Returns the position offsets of the current term as a TermPositions object.
short	getTf() Returns the term frequency of the current term.
boolean	hasMoreTerms() Returns true if there are more terms to read.
String	nextTerm() Returns the next term.
void	reset() Resets the reader to the beginning of the document.

Methods inherited from class java.lang.Object

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

Constructor Detail

LazyTermDocVector.Reader

public LazyTermDocVector.Reader(int nTerms,
                        byte[] bytes,
                        String[] terms)
                         throws IOException

Throws:

IOException

Method Detail

getNumberOfTerms

public int getNumberOfTerms()

Description copied from interface: TermDocVector.Reader

Returns the total number of terms in this document.

Specified by:

getNumberOfTerms in interface TermDocVector.Reader

Returns:

total number of terms in this document

getPositions

public int[] getPositions()

Description copied from interface: TermDocVector.Reader

Returns the position offsets of the current term as an array.

Specified by:

getPositions in interface TermDocVector.Reader

Returns:

array containing position offsets of the current term

getPositions

public boolean getPositions(TermPositions tp)

Description copied from interface: TermDocVector.Reader

Returns the position offsets of the current term as a TermPositions object.

Specified by:

getPositions in interface TermDocVector.Reader

Returns:

TermPositions representing offsets of the current term.

getTf

public short getTf()

Description copied from interface: TermDocVector.Reader

Returns the term frequency of the current term.

Specified by:

getTf in interface TermDocVector.Reader

Returns:

term frequency of the current term

hasMoreTerms

public boolean hasMoreTerms()

Description copied from interface: TermDocVector.Reader

Returns true if there are more terms to read.

Specified by:

hasMoreTerms in interface TermDocVector.Reader

Returns:

true if there are more terms to read

nextTerm

public String nextTerm()

Description copied from interface: TermDocVector.Reader

Returns the next term.

Specified by:

nextTerm in interface TermDocVector.Reader

Returns:

the next term

reset

public void reset()

Description copied from interface: TermDocVector.Reader

Resets the reader to the beginning of the document.

Specified by:

reset in interface TermDocVector.Reader