org.terrier.structures.postings

Interface IterablePosting

All Superinterfaces:

AutoCloseable, Closeable, Posting

All Known Implementing Classes:

ANDIterablePosting, ArrayOfBasicIterablePosting, ArrayOfBlockFieldIterablePosting, ArrayOfBlockIterablePosting, ArrayOfFieldIterablePosting, ArrayOfIdsIterablePosting, BasicIntegerCodingIterablePosting, BasicIterablePosting, BasicIterablePostingDocidOnly, BlockFieldIntegerCodingIterablePosting, BlockFieldIterablePosting, BlockFieldORIterablePosting, BlockFieldPostingInRun.bfPIRPostingIterator, BlockIntegerCodingIterablePosting, BlockIterablePosting, BlockORIterablePosting, BlockPostingInRun.BlockPIRPostingIterator, DocumentPostingList.postingIterator, FieldIntegerCodingIterablePosting, FieldIterablePosting, FieldOnlyIterablePosting, FieldORIterablePosting, FieldPostingInRun.fPIRPostingIterator, IntegerCodingIterablePosting, IterablePostingImpl, MemoryFieldsIterablePosting, MemoryIterablePosting, MultiDirectIterablePostingWithOffset, MultiIterablePosting, ORIterablePosting, PhraseIterablePosting, ProximityIterablePosting, SimplePostingInRun.PIRPostingIterator

public interface IterablePosting
extends Posting, Closeable

An interface that allows a list of postings to be iterated over

Since:

3.0

Author:

Craig Macdonald, Nicola Tonnellotto

Field Summary

Fields

Modifier and Type	Field and Description
static int	END_OF_LIST
static int	EOL Value which denotes that the end of the posting list has been reached

Method Summary

Modifier and Type	Method and Description
boolean	endOfPostings() Status method to see if this posting list iterator has been finished
int	next() Move this iterator to the next posting.
int	next(int targetId) Move this iterator to the posting with specified id, or next posting after that.

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

asWritablePosting, getDocumentLength, getFrequency, getId, setId

Methods inherited from interface java.io.Closeable

close

Field Detail

EOL

static final int EOL

Value which denotes that the end of the posting list has been reached

See Also:

Constant Field Values

END_OF_LIST

static final int END_OF_LIST

See Also:

Constant Field Values

Method Detail

next

int next()
  throws IOException

Move this iterator to the next posting.

Returns:

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

Throws:

IOException

next

int next(int targetId)
  throws IOException

Move this iterator to the posting with specified id, or next posting after that. This is usually implemented internally by next(), but more efficient implementations can override this behaviour.

Parameters:

targetId - id of the posting to find in this posting list.

Returns:

id of the posting found, or EOL if end of posting list.

Throws:

IOException

endOfPostings

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.