Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

lemur::api::DocInfoList Class Reference

Abstract Interface of Doc Information List. More...

#include <DocInfoList.hpp>

Inheritance diagram for lemur::api::DocInfoList:

lemur::index::InvDocList lemur::index::InvFPDocList List of all members.

Public Member Functions

 DocInfoList ()
virtual ~DocInfoList ()
virtual void startIteration () const =0
 prepare iteration

virtual bool hasMore () const =0
 test if there's any entry

virtual DocInfonextEntry () const =0
 fetch the next entry, return a pointer to a local static memory, so do not delete it

iteratorbegin () const
iteratorend () const

Protected Member Functions

virtual DocInfonewElement () const
 Create new element of this list type for the iterator.

virtual DocInfogetElement (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

lemur::api::DocInfoList::DocInfoList  )  [inline]
 

virtual lemur::api::DocInfoList::~DocInfoList  )  [inline, virtual]
 


Member Function Documentation

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

iterator& lemur::api::DocInfoList::begin  )  const [inline]
 

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

Position at beginning of list.

Implemented in lemur::index::InvDocList.

iterator& lemur::api::DocInfoList::end  )  const [inline]
 

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

Position at end of list.

Implemented in lemur::index::InvDocList.

virtual DocInfo* lemur::api::DocInfoList::getElement DocInfo elem,
POS_T  position
const [protected, pure virtual]
 

Set element from position, returns pointer to the element.

Implemented in lemur::index::InvDocList, and lemur::index::InvFPDocList.

virtual bool lemur::api::DocInfoList::hasMore  )  const [pure virtual]
 

test if there's any entry

Implemented in lemur::index::InvDocList.

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

Create new element of this list type for the iterator.

Reimplemented in lemur::index::InvFPDocList.

virtual DocInfo* lemur::api::DocInfoList::nextEntry  )  const [pure virtual]
 

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

Implemented in lemur::index::InvDocList, and lemur::index::InvFPDocList.

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

Advance to next position.

Implemented in lemur::index::InvDocList, and lemur::index::InvFPDocList.

virtual void lemur::api::DocInfoList::startIteration  )  const [pure virtual]
 

prepare iteration

Implemented in lemur::index::InvDocList.


Friends And Related Function Documentation

friend class iterator [friend]
 


Member Data Documentation

DocInfoList::iterator lemur::api::DocInfoList::itbegin [mutable, protected]
 

DocInfoList::iterator lemur::api::DocInfoList::itend [mutable, protected]
 


The documentation for this class was generated from the following file:
Generated on Tue Jun 15 11:03:04 2010 for Lemur by doxygen 1.3.4