ivory.core.data.index

Class ProximityPostingsReader

java.lang.Object

ivory.core.data.index.ProximityPostingsReader

All Implemented Interfaces:

PostingsReader

Direct Known Subclasses:

ProximityPostingsReaderOrderedWindow, ProximityPostingsReaderUnorderedWindow

public abstract class ProximityPostingsReader
extends Object
implements PostingsReader

Author:

Don Metzler

Constructor Summary

Constructors

Constructor and Description
ProximityPostingsReader(PostingsReader[] readers, int size)

Method Summary

Methods

Modifier and Type	Method and Description
int	getDocno() Returns the docno of the current posting.
int	getNumberOfPostings() Returns the number of postings in this postings list.
int[]	getPositions() Returns an array of term positions corresponding to the current posting.
boolean	getPositions(TermPositions tp) Loads a TermPositions object corresponding to the current posting.
PostingsList	getPostingsList() Returns the PostingsList associated with this reader.
short	getTf() Returns the score corresponding to the current posting.
int	getWindowSize()
boolean	hasMorePostings() Checks to see if there are any more postings to be read.
boolean	nextPosting(Posting posting) Reads the next posting, consuming it from the stream of postings.
int	peekNextDocno() Returns the docno of the next posting, without consuming it from the stream of postings.
short	peekNextTf() Returns the score of the next posting, without consuming it from the stream of postings.
void	reset() Resets this object to start reading from the first posting.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProximityPostingsReader

public ProximityPostingsReader(PostingsReader[] readers,
                       int size)

Method Detail

getDocno

public int getDocno()

Description copied from interface: PostingsReader

Returns the docno of the current posting.

Specified by:

getDocno in interface PostingsReader

Returns:

docno of the current posting.

getNumberOfPostings

public int getNumberOfPostings()

Description copied from interface: PostingsReader

Returns the number of postings in this postings list. Note that this value may not be the same as the document frequency of the term (e.g., if this postings list contains only a partition of the entire collection).

Specified by:

getNumberOfPostings in interface PostingsReader

Returns:

number of postings

getPositions

public int[] getPositions()

Description copied from interface: PostingsReader

Returns an array of term positions corresponding to the current posting. This is an optional operation valid only for postings that store positional information.

Specified by:

getPositions in interface PostingsReader

Returns:

array of term positions

getPositions

public boolean getPositions(TermPositions tp)

Description copied from interface: PostingsReader

Loads a TermPositions object corresponding to the current posting. This is an optional operation valid only for postings that store positional information.

Specified by:

getPositions in interface PostingsReader

Returns:

{code true} if there are any more postings to be read, false otherwise

getPostingsList

public PostingsList getPostingsList()

Description copied from interface: PostingsReader

Returns the PostingsList associated with this reader.

Specified by:

getPostingsList in interface PostingsReader

Returns:

PostingsList associated with this reader

getTf

public short getTf()

Description copied from interface: PostingsReader

Returns the score corresponding to the current posting.

Specified by:

getTf in interface PostingsReader

Returns:

term frequency of the current posting

getWindowSize

public int getWindowSize()

hasMorePostings

public boolean hasMorePostings()

Description copied from interface: PostingsReader

Checks to see if there are any more postings to be read.

Specified by:

hasMorePostings in interface PostingsReader

Returns:

true if there are any more postings to be read, false otherwise

nextPosting

public boolean nextPosting(Posting posting)

Description copied from interface: PostingsReader

Reads the next posting, consuming it from the stream of postings.

Specified by:

nextPosting in interface PostingsReader

Parameters:

posting - object for holding the posting

Returns:

true if posting successfully read, false otherwise

peekNextDocno

public int peekNextDocno()

Description copied from interface: PostingsReader

Returns the docno of the next posting, without consuming it from the stream of postings. This is an optional operation.

Specified by:

peekNextDocno in interface PostingsReader

Returns:

docno of the next posting

peekNextTf

public short peekNextTf()

Description copied from interface: PostingsReader

Returns the score of the next posting, without consuming it from the stream of postings. This is an optional operation.

Specified by:

peekNextTf in interface PostingsReader

Returns:

term frequency of the next posting

reset

public void reset()

Description copied from interface: PostingsReader

Resets this object to start reading from the first posting.

Specified by:

reset in interface PostingsReader