org.terrier.structures.indexing
Class DocumentPostingList.postingIterator

java.lang.Object
  org.terrier.structures.postings.IterablePostingImpl
      org.terrier.structures.indexing.DocumentPostingList.postingIterator

All Implemented Interfaces:

java.io.Closeable, IterablePosting, Posting

Enclosing class:

DocumentPostingList

protected class DocumentPostingList.postingIterator
extends IterablePostingImpl

Field Summary

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

EOL

Constructor Summary

DocumentPostingList.postingIterator(java.lang.String[] _terms, int[] _termIds)

Method Summary

WritablePosting	asWritablePosting() Copies 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 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) It may be of benefit to update the frequency of the id in some applications.

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

Constructor Detail

DocumentPostingList.postingIterator

public DocumentPostingList.postingIterator(java.lang.String[] _terms,
                                           int[] _termIds)

Method Detail

asWritablePosting

public WritablePosting asWritablePosting()

Description copied from interface: Posting

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

Returns:

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

getDocumentLength

public int getDocumentLength()

Description copied from interface: Posting

Return the length of the document for this posting. 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.

getFrequency

public int getFrequency()

Description copied from interface: Posting

Return the frequency of the term in the current document

Returns:

frequency of posting, in tokens

getId

public int getId()

Description copied from interface: Posting

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

Returns:

id of the posting

setId

public void setId(int id)

Description copied from interface: Posting

It may be of benefit to update the frequency of the id in some applications. This should not be used lightly, as it may break the decompression of other postings in iterators.

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()

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

Returns:

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

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException