Xpace::Remote::Index Class Reference

An index. More...

#include <remote.h>

Public Member Functions
void	destroy ()
	destroy an index More...
virtual bool	operator! () const =0
virtual void	getConfig (String *) const =0
virtual uint64	getTermCount () const =0
virtual size_t	getTerms (String *, uint64 start, size_t count) const =0
	get a range of terms in the index More...
virtual RefList *	search (const String &query) const =0
	do a search More...

Protected Member Functions
	Index ()
virtual	~Index ()

Detailed Description

An index.

Definition at line 162 of file remote.h.

Constructor & Destructor Documentation

Xpace::Remote::Index::Index ( )

inlineprotected

Definition at line 211 of file remote.h.

virtual Xpace::Remote::Index::~Index ( )

inlineprotectedvirtual

Definition at line 216 of file remote.h.

Member Function Documentation

void Xpace::Remote::Index::destroy

(

)

destroy an index

Parameters

the	index to destroy

virtual bool Xpace::Remote::Index::operator! ( ) const

pure virtual

Returns

true iff this index is empty

virtual void Xpace::Remote::Index::getConfig ( String *  ) const

pure virtual

Return values

this	index's configuration

virtual uint64 Xpace::Remote::Index::getTermCount ( ) const

pure virtual

Returns

the number of terms in this index

virtual size_t Xpace::Remote::Index::getTerms ( String *  , uint64  start, size_t  count  ) const

pure virtual

get a range of terms in the index

Return values

the	range of terms, e.g., "<term val="AK" count="4321"/><term val="AL" count="5432"\>"

Parameters

start

start of range number of terms to get

Returns

number of terms gotten

virtual RefList* Xpace::Remote::Index::search ( const String &  query ) const

pure virtual

do a search

Parameters

query

Exceptions

XML_Error

Returns

a pointer to the search result

---

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

• remote/remote.h