lemur::api::TermInfoList Class Reference

Abstract Interface of Term Information List. More...

#include <TermInfoList.hpp>

Inheritance diagram for lemur::api::TermInfoList:

List of all members.


Public Member Functions
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.
virtual int	size ()=0
	Gets the number of entries in this list.
virtual TermInfo *	operator[] (int index) const =0
iterator &	begin () const
iterator &	end () const
Protected Member Functions
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 lemur::api::TermInfoList::~TermInfoList ( ) [inline, virtual]

Member Function Documentation

virtual void lemur::api::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 lemur::index::InvFPTermList.

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

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

Position at beginning of list.

Implemented in indri::index::BagList, indri::index::PositionList, and lemur::index::InvFPTermList.

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

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

Position at end of list.

Implemented in indri::index::BagList, indri::index::PositionList, and lemur::index::InvFPTermList.

virtual TermInfo* lemur::api::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, and lemur::index::InvFPTermList.

virtual bool lemur::api::TermInfoList::hasMore ( ) const [pure virtual]

Has more entries.

Implemented in indri::index::BagList, indri::index::PositionList, and lemur::index::InvFPTermList.

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

Create new element of this list type for the iterator.

Reimplemented in lemur::index::InvFPTermList.

virtual TermInfo* lemur::api::TermInfoList::nextEntry ( ) const [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, and lemur::index::InvFPTermList.

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

Advance to next position.

Implemented in indri::index::BagList, indri::index::PositionList, and lemur::index::InvFPTermList.

virtual TermInfo* lemur::api::TermInfoList::operator[] ( int index ) const [pure virtual]

indexed access to the list. Also sets the iterator to the next item after or to the end if invalid.
Implemented in indri::index::BagList, indri::index::PositionList, and lemur::index::InvFPTermList.

virtual int lemur::api::TermInfoList::size ( ) [pure virtual]

Gets the number of entries in this list.

Implemented in indri::index::BagList, indri::index::PositionList, and lemur::index::InvFPTermList.

virtual void lemur::api::TermInfoList::startIteration ( ) const [pure virtual]

Prepare iteration.

Implemented in indri::index::BagList, indri::index::PositionList, and lemur::index::InvFPTermList.