---

indri::index::DocListIterator Class Reference

#include <DocListIterator.hpp>

Inheritance diagram for indri::index::DocListIterator:

List of all members.

Public Methods
	DocListIterator (File &segment, int termID, File::offset_type seekLocation=0, INT64 estimatedDataLength=KEYFILE_DOCLISTITERATOR_DEFAULT_BUFFERSIZE)
	~DocListIterator ()
void	startIteration () const
	prepare iteration
bool	hasMore () const
DocInfo *	nextEntry () const
	fetch the next entry, return a pointer to a local static memory, so do not delete it
DocInfo *	nextEntry (DOCID_T documentID)
	fetch the next entry with docID >= <documentID>
DocInfo *	currentEntry ()
virtual DocInfo *	newElement () const
	Create new element of this list type for the iterator.
virtual void	assignElement (DocInfo *to, DocInfo *from) const
	copy values from one Element (of type DocInfo) to another
virtual DocInfo *	getElement (DocInfo *elem, POS_T position) const
	set element from position, returns pointer to the element
virtual POS_T	beginPosition () const
	Position at beginning of list.
virtual POS_T	endPosition () const
	Position at end of list.
virtual POS_T	nextPosition (POS_T position) const
	Advance to next position.

---

Constructor & Destructor Documentation

DocListIterator::DocListIterator (  File &    segment, int    termID, File::offset_type    seekLocation = 0, INT64    estimatedDataLength = KEYFILE_DOCLISTITERATOR_DEFAULT_BUFFERSIZE )

DocListIterator::~DocListIterator (    )

---

Member Function Documentation

virtual void indri::index::DocListIterator::assignElement (  DocInfo *    to, DocInfo *    from )  const [inline, virtual]

copy values from one Element (of type DocInfo) to another Implements DocPositionInfoList.

POS_T DocListIterator::beginPosition (    )  [virtual]

Position at beginning of list. Implements DocPositionInfoList.

DocInfo * DocListIterator::currentEntry (    )  [virtual]

Implements DocPositionInfoList.

POS_T DocListIterator::endPosition (    )  [virtual]

Position at end of list. Implements DocPositionInfoList.

DocInfo * DocListIterator::getElement (  DocInfo *    elem, POS_T    position )  const [virtual]

set element from position, returns pointer to the element Implements DocPositionInfoList.

bool DocListIterator::hasMore (    )  [virtual]

Important note: In this implementation, hasMore() invalidates any structures returned by nextEntry() or nextEntry( docID ). Implements DocInfoList.

virtual DocInfo* indri::index::DocListIterator::newElement (    )  [inline, virtual]

Create new element of this list type for the iterator. Implements DocPositionInfoList.

DocInfo * DocListIterator::nextEntry (  DOCID_T    documentID )  [virtual]

fetch the next entry with docID >= <documentID> Implements DocPositionInfoList.

DocInfo * DocListIterator::nextEntry (    )  [virtual]

fetch the next entry, return a pointer to a local static memory, so do not delete it Implements DocPositionInfoList.

POS_T DocListIterator::nextPosition (  POS_T    position )  const [virtual]

Advance to next position. Implements DocPositionInfoList.

void DocListIterator::startIteration (    )  [virtual]

prepare iteration Implements DocInfoList.

---

The documentation for this class was generated from the following files:

• DocListIterator.hpp
• DocListIterator.cpp

---