---

TermInfoList Class Reference

Abstract Interface of Term Information List. More...

#include <TermInfoList.hpp>

Inheritance diagram for TermInfoList:

List of all members.

Public Methods
virtual	~TermInfoList ()
virtual void	startIteration () const=0
	Prepare iteration.
virtual bool	hasMore () const=0
	Has more entries.
virtual TermInfo *	nextEntry () const=0
	Get a pointer to the next entry (pointer to a local static memory), so do not delete it.
iterator &	begin () const
iterator &	end () const
Protected Methods
virtual TermInfo *	newElement () const
	Create new element of this list type for the iterator.
virtual TermInfo *	getElement (TermInfo *elem, POS_T position) const=0
	Set element from position, returns pointer to the element.
virtual void	assignElement (TermInfo *to, TermInfo *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
TermInfoList::iterator	itbegin
TermInfoList::iterator	itend
Friends
class	iterator

---

Detailed Description

Abstract Interface of Term Information List.

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

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

virtual void TermInfoList::assignElement (  TermInfo *    to, TermInfo *    from )  const [inline, protected, virtual]

Copy values from one Element to another Subclasses must cast from TermInfo if not using TermInfo elements Reimplemented in InvFPTermList.

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

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

Position at beginning of list. Implemented in indri::index::BagList, indri::index::PositionList, InvFPTermList, and InvTermList.

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

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

Position at end of list. Implemented in indri::index::BagList, indri::index::PositionList, InvFPTermList, and InvTermList.

virtual TermInfo* TermInfoList::getElement (  TermInfo *    elem, POS_T    position )  const [protected, pure virtual]

Set element from position, returns pointer to the element. Implemented in indri::index::BagList, indri::index::PositionList, InvFPTermList, and InvTermList.

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

Has more entries. Implemented in indri::index::BagList, indri::index::PositionList, InvFPTermList, and InvTermList.

virtual TermInfo* TermInfoList::newElement (    )  const [inline, protected, virtual]

Create new element of this list type for the iterator. Reimplemented in InvFPTermList.

virtual TermInfo* TermInfoList::nextEntry (    )  [pure virtual]

Get a pointer to the next entry (pointer to a local static memory), so do not delete it. Implemented in indri::index::BagList, indri::index::PositionList, InvFPTermList, and InvTermList.

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

Advance to next position. Implemented in indri::index::BagList, indri::index::PositionList, InvFPTermList, and InvTermList.

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

Prepare iteration. Implemented in indri::index::BagList, indri::index::PositionList, InvFPTermList, and InvTermList.

---

Friends And Related Function Documentation

friend class iterator [friend]

---

Member Data Documentation

TermInfoList::iterator TermInfoList::itbegin [protected]

TermInfoList::iterator TermInfoList::itend [protected]

---

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

• TermInfoList.hpp

---