Xpace::Remote::IndexList Class Reference

A list of indexes. More...

#include <remote.h>

Public Member Functions
void	destroy ()
	Destroy an index list. More...
virtual size_t	getCount () const =0
virtual Index *	openIndex (uint indexNum, const String &config=String())=0
	open an index by number More...
virtual Index *	openIndex (uint *indexNum, const String &name, const String &config=String())=0
	open an index by name More...
virtual RefList *	search (const String &query)=0
	do a search More...

Static Public Member Functions
static IndexList *	create (const String &config)
	Create an index list. More...

Protected Member Functions
	IndexList ()
virtual	~IndexList ()

Detailed Description

A list of indexes.

Definition at line 230 of file remote.h.

Constructor & Destructor Documentation

Xpace::Remote::IndexList::IndexList ( )

inlineprotected

Definition at line 279 of file remote.h.

virtual Xpace::Remote::IndexList::~IndexList ( )

inlineprotectedvirtual

Definition at line 284 of file remote.h.

Member Function Documentation

static IndexList* Xpace::Remote::IndexList::create ( const String &  config )

static

Create an index list.

Parameters

config

- must have a "index_list" tag

void Xpace::Remote::IndexList::destroy

(

)

Destroy an index list.

Parameters

the	list to destroy

virtual size_t Xpace::Remote::IndexList::getCount ( ) const

pure virtual

Returns

the number of indexes in the list

virtual Index* Xpace::Remote::IndexList::openIndex ( uint  indexNum, const String &  config = String()  )

pure virtual

open an index by number

Parameters

indexNum	the index to get
config	- use this config where possible

Returns

a pointer to the Index; 0 if there is no index

virtual Index* Xpace::Remote::IndexList::openIndex ( uint *  indexNum, const String &  name, const String &  config = String()  )

pure virtual

open an index by name

Return values

indexNum

fillin the index's number

Parameters

name	the index to get
config	- use this config where possible

Returns

a pointer to the Index; 0 if there is no index

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

pure virtual

do a search

Parameters

query;

includes index names TODO - define syntax

Returns

a pointer to the search result

---

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

• remote/remote.h