---

DocInfoList Class Reference

Abstract Interface of Doc Information List. More...

#include <DocInfoList.hpp>

Inheritance diagram for DocInfoList:

List of all members.

Public Methods
	DocInfoList ()
virtual	~DocInfoList ()
virtual void	startIteration () const=0
	prepare iteration
virtual bool	hasMore () const=0
	test if there's any entry
virtual DocInfo *	nextEntry () const=0
	fetch the next entry, return a pointer to a local static memory, so do not delete it
iterator &	begin () const
iterator &	end () const
Protected Methods
virtual DocInfo *	newElement () const
	Create new element of this list type for the iterator.
virtual DocInfo *	getElement (DocInfo *elem, POS_T position) const=0
	Set element from position, returns pointer to the element.
virtual void	assignElement (DocInfo *to, DocInfo *from) const
virtual POS_T	beginPosition () const=0
	Position at beginning of list.
virtual POS_T	endPosition () const=0
	Position at end of list.
virtual POS_T	nextPosition (POS_T position) const=0
	Advance to next position.
Protected Attributes
DocInfoList::iterator	itbegin
DocInfoList::iterator	itend
Friends
class	iterator

---

Detailed Description

Abstract Interface of Doc Information List.

This is an abstract class that represents the doc entries in term index, i.e., the doc ID and the frequency of a term in the document.

---

Constructor & Destructor Documentation

DocInfoList::DocInfoList (    )  [inline]

virtual DocInfoList::~DocInfoList (    )  [inline, virtual]

---

Member Function Documentation

virtual void DocInfoList::assignElement (  DocInfo *    to, DocInfo *    from )  const [inline, protected, virtual]

Copy values from one Element to another Subclasses must cast from DocInfo if not using DocInfo elements Reimplemented in indri::index::DocListIterator, DocPositionInfoList, and InvFPDocList.

iterator& DocInfoList::begin (    )  const [inline]

virtual POS_T DocInfoList::beginPosition (    )  [protected, pure virtual]

Position at beginning of list. Implemented in indri::index::DocListIterator, DocPositionInfoList, and InvDocList.

iterator& DocInfoList::end (    )  const [inline]

virtual POS_T DocInfoList::endPosition (    )  [protected, pure virtual]

Position at end of list. Implemented in indri::index::DocListIterator, DocPositionInfoList, and InvDocList.

virtual DocInfo* DocInfoList::getElement (  DocInfo *    elem, POS_T    position )  const [protected, pure virtual]

Set element from position, returns pointer to the element. Implemented in indri::index::DocListIterator, DocPositionInfoList, InvDocList, and InvFPDocList.

virtual bool DocInfoList::hasMore (    )  [pure virtual]

test if there's any entry Implemented in indri::index::DocListIterator, and InvDocList.

virtual DocInfo* DocInfoList::newElement (    )  const [inline, protected, virtual]

Create new element of this list type for the iterator. Reimplemented in indri::index::DocListIterator, DocPositionInfoList, and InvFPDocList.

virtual DocInfo* DocInfoList::nextEntry (    )  [pure virtual]

fetch the next entry, return a pointer to a local static memory, so do not delete it Implemented in indri::index::DocListIterator, DocPositionInfoList, InvDocList, and InvFPDocList.

virtual POS_T DocInfoList::nextPosition (  POS_T    position )  const [protected, pure virtual]

Advance to next position. Implemented in indri::index::DocListIterator, DocPositionInfoList, InvDocList, and InvFPDocList.

virtual void DocInfoList::startIteration (    )  [pure virtual]

prepare iteration Implemented in indri::index::DocListIterator, and InvDocList.

---

Friends And Related Function Documentation

friend class iterator [friend]

---

Member Data Documentation

DocInfoList::iterator DocInfoList::itbegin [protected]

DocInfoList::iterator DocInfoList::itend [protected]

---

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

• DocInfoList.hpp

---