org.terrier.realtime.multi

Class MultiIterablePosting

java.lang.Object

org.terrier.structures.postings.IterablePostingImpl

org.terrier.realtime.multi.MultiIterablePosting

All Implemented Interfaces:

Closeable, AutoCloseable, IterablePosting, Posting

public class MultiIterablePosting
extends IterablePostingImpl
implements IterablePosting

A posting list implementation used within a MultiIndex. It iterates over the posting lists from multiple index shards.

Since:

4.0

Author:

Richard McCreadie, Stuart Mackie

Field Summary

Fields inherited from interface org.terrier.structures.postings.IterablePosting

EOL

Constructor Summary

Constructors

Constructor and Description
MultiIterablePosting(IterablePosting[] constituentIPs, int[] offsets) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
WritablePosting	asWritablePosting() Not implemented.
void	close() Not implemented.
boolean	endOfPostings() Status method to see if this posting list iterator has been finished
int	getDocumentLength() Return the length of the document for this posting.
int	getFrequency() Return the frequency of the term in the current document
int	getId() Return the id of the current posting.
int	next() Move this iterator to the next posting.
void	setId(int id) Not implemented.

Methods inherited from class org.terrier.structures.postings.IterablePostingImpl

next

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.terrier.structures.postings.IterablePosting

next

Constructor Detail

MultiIterablePosting

public MultiIterablePosting(IterablePosting[] constituentIPs,
                    int[] offsets)

Constructor.

Method Detail

next

public int next()
         throws IOException

Move this iterator to the next posting.

Specified by:

next in interface IterablePosting

Returns:

id of next posting, or EOL if end of posting list

Throws:

IOException

endOfPostings

public boolean endOfPostings()

Status method to see if this posting list iterator has been finished

Specified by:

endOfPostings in interface IterablePosting

Returns:

true if next() or next(int) would return EOL or have returned EOL.

getId

public int getId()

Return the id of the current posting. For the inverted index, this is the docid; for the direct index it corresponds to the term id

Specified by:

getId in interface Posting

Returns:

id of the posting

getFrequency

public int getFrequency()

Return the frequency of the term in the current document

Specified by:

getFrequency in interface Posting

Returns:

frequency of posting, in tokens

getDocumentLength

public int getDocumentLength()

Return the length of the document for this posting. Usually uses the DocumentIndex, may do otherwise if document length statistics are in posting list

Specified by:

getDocumentLength in interface Posting

Returns:

length of the document of the current posting in tokens.

setId

public void setId(int id)

Not implemented.

Specified by:

setId in interface Posting

asWritablePosting

public WritablePosting asWritablePosting()

Not implemented.

Specified by:

asWritablePosting in interface Posting

Returns:

an identical posting, but which can be maniulated free of this iterator

close

public void close()
           throws IOException

Not implemented.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException