lemur::api::FieldInfoList Class Reference

Abstract Interface of Field Information List. More...

#include <FieldInfoList.hpp>

Inheritance diagram for lemur::api::FieldInfoList:

List of all members.


Public Member Functions
virtual	~FieldInfoList ()
virtual void	startIteration ()=0
	Prepare iteration.
virtual bool	hasMore () const =0
	Has more entries.
virtual FieldInfo *	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
	returns the number of FieldInfo elements in the list
virtual FieldInfo *	operator[] (int index)=0
	indexed access to the list
iterator &	begin () const
iterator &	end () const
Protected Member Functions
virtual FieldInfo *	newElement () const
	Create new element of this list type for the iterator.
virtual FieldInfo *	getElement (FieldInfo *elem, POS_T position) const =0
	Set element from position, returns pointer to the element.
virtual void	assignElement (FieldInfo to, FieldInfo 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
FieldInfoList::iterator	itbegin
FieldInfoList::iterator	itend
Friends
class	iterator

Detailed Description

Abstract Interface of Field Information List.

This is an abstract class that represents the FieldInfo entries for a document in an index

Constructor & Destructor Documentation

virtual lemur::api::FieldInfoList::~FieldInfoList ( ) [inline, virtual]

Member Function Documentation

virtual void lemur::api::FieldInfoList::assignElement ( FieldInfo * to,

FieldInfo * from

) const [inline, protected, virtual]

Copy values from one Element to another Subclasses must cast from FieldInfo if not using FieldInfo elements

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

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

Position at beginning of list.

Implemented in lemur::api::IndriFieldInfoList.

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

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

Position at end of list.

Implemented in lemur::api::IndriFieldInfoList.

virtual FieldInfo* lemur::api::FieldInfoList::getElement ( FieldInfo * elem,

POS_T position

) const [protected, pure virtual]

Set element from position, returns pointer to the element.

Implemented in lemur::api::IndriFieldInfoList.

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

Has more entries.

Implemented in lemur::api::IndriFieldInfoList.

virtual FieldInfo* lemur::api::FieldInfoList::newElement ( ) const [inline, protected, virtual]

Create new element of this list type for the iterator.

virtual FieldInfo* lemur::api::FieldInfoList::nextEntry ( ) const [pure virtual]

Get a pointer to the next entry (pointer to a local static memory), so do not delete it.

Implemented in lemur::api::IndriFieldInfoList.

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

Advance to next position.

Implemented in lemur::api::IndriFieldInfoList.

virtual FieldInfo* lemur::api::FieldInfoList::operator[] ( int index ) [pure virtual]

indexed access to the list

Implemented in lemur::api::IndriFieldInfoList.

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

returns the number of FieldInfo elements in the list

Implemented in lemur::api::IndriFieldInfoList.