Package org.terrier.structures.postings

Class FieldOnlyIterablePosting

java.lang.Object

org.terrier.structures.postings.IterablePostingImpl

org.terrier.structures.postings.FieldOnlyIterablePosting

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, IterablePosting, Posting

public class FieldOnlyIterablePosting
extends IterablePostingImpl

This class takes an IterablePosting list that has fields, and makes it appear as a single basic posting list.

Since:

4.2

Author:

Craig Macdonald

Field Summary

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

END_OF_LIST, EOL

Constructor Summary

Constructors

Constructor	Description
FieldOnlyIterablePosting(IterablePosting _ip, int _fieldId)

Method Summary

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

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.Posting

setId

Constructor Detail

FieldOnlyIterablePosting

public FieldOnlyIterablePosting(IterablePosting _ip,
                                int _fieldId)

Method Detail

next

public int next()
         throws java.io.IOException

Description copied from interface: IterablePosting

Move this iterator to the next posting.

Returns:

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

Throws:

java.io.IOException

endOfPostings

public boolean endOfPostings()

Description copied from interface: IterablePosting

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

Returns:

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

getId

public int getId()

Description copied from interface: Posting

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

Returns:

id of the posting.

getFrequency

public int getFrequency()

Description copied from interface: Posting

Return the frequency of the term in the current document, in tokens.

Returns:

frequency of the term in the current document, in tokens.

getDocumentLength

public int getDocumentLength()

Description copied from interface: Posting

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

Returns:

length of the document of the current posting in tokens.

asWritablePosting

public WritablePosting asWritablePosting()

Description copied from interface: Posting

Copy this posting to one free of an iterator. Kind of like a clone.

Returns:

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

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException