WsMnoGoSearch Class Reference

#include <WsMnoGoSearch.h>

Inheritance diagram for WsMnoGoSearch:

Collaboration diagram for WsMnoGoSearch:

Public Member Functions
	WsMnoGoSearch ()
	Constructor for the Search object. More...
virtual	~WsMnoGoSearch ()
int	load (FileSystemTreePtr fst, string query)
	Loads all search results. More...
int	getSize ()
	Loads all search results. More...
vector< WsResultItem >	getResults (const set< string > &groups)
	Get list of documents readable by person member of all groups passed in parameter. More...
virtual int	load (FileSystemTreePtr fs, std::string q)=0
	load the results (execute the search query) More...
virtual vector< WsResultItem >	getResults (const std::set< std::string > &groups)=0
	return the results found for the query filtered for the user More...

Private Attributes
FileSystemTreePtr	m_fst
char	m_udmQuery [256]
string	m_user
int	m_size
list< WsResultItem >	m_results
void *	m_hndlMno
pf_UdmEnvInit	mf_UdmEnvInit
pf_UdmAgentInit	mf_UdmAgentInit
pf_UdmAgentAddLine	mf_UdmAgentAddLine
pf_UdmFind2	mf_UdmFind2
pf_UdmVarListFindInt	mf_UdmVarListFindInt
pf_UdmVarListFindStr	mf_UdmVarListFindStr
pf_UdmResultFree	mf_UdmResultFree
pf_UdmAgentFree	mf_UdmAgentFree
pf_UdmEnvFree	mf_UdmEnvFree
UDM_ENV	m_env
UDM_AGENT	m_agent
UDM_RESULT *	m_res

Detailed Description

Definition at line 32 of file WsMnoGoSearch.h.

Constructor & Destructor Documentation

WsMnoGoSearch::WsMnoGoSearch

(

)

Constructor for the Search object.

Parameters

fst	the file system tree in memory
query	the search query to perform

Definition at line 19 of file WsMnoGoSearch.cpp.

WsMnoGoSearch::~WsMnoGoSearch ( )

virtual

Definition at line 82 of file WsMnoGoSearch.cpp.

Member Function Documentation

virtual vector<WsResultItem> WsAbstractSearch::getResults ( const std::set< std::string > &  groups )

pure virtualinherited

return the results found for the query filtered for the user

Parameters

groups

the groups which the user belongs to

Returns

a vector<WsResultItem> containing the results. An empty vector is returned if no results found or if the user don't have access to any found result

Here is the caller graph for this function:

vector< WsResultItem > WsMnoGoSearch::getResults

(

const set< string > &

groups

)

Get list of documents readable by person member of all groups passed in parameter.

Parameters

groups

set of group names

Returns

an instance of list<ResultItem>

Definition at line 124 of file WsMnoGoSearch.cpp.

int WsMnoGoSearch::getSize ( )

virtual

Loads all search results.

Returns

the total number (unfiltered by access right) of document corresponding to the search query

Implements WsAbstractSearch.

Definition at line 119 of file WsMnoGoSearch.cpp.

virtual int WsAbstractSearch::load ( FileSystemTreePtr  fs, std::string  q  )

pure virtualinherited

load the results (execute the search query)

Returns

SUCCESS if ok, failure otherwise

Here is the caller graph for this function:

int WsMnoGoSearch::load	(	FileSystemTreePtr	fst,
		string	query
	)

Loads all search results.

Parameters

fst	the instance of WsFileSystemTree
query	the terms we are looking for

Returns

the number of items found, -1 in case of error

Definition at line 89 of file WsMnoGoSearch.cpp.

Member Data Documentation

UDM_AGENT WsMnoGoSearch::m_agent

private

Definition at line 84 of file WsMnoGoSearch.h.

UDM_ENV WsMnoGoSearch::m_env

private

Definition at line 83 of file WsMnoGoSearch.h.

FileSystemTreePtr WsMnoGoSearch::m_fst

private

Definition at line 65 of file WsMnoGoSearch.h.

void* WsMnoGoSearch::m_hndlMno

private

Definition at line 72 of file WsMnoGoSearch.h.

UDM_RESULT* WsMnoGoSearch::m_res

private

Definition at line 85 of file WsMnoGoSearch.h.

list<WsResultItem> WsMnoGoSearch::m_results

private

Definition at line 69 of file WsMnoGoSearch.h.

int WsMnoGoSearch::m_size

private

Definition at line 68 of file WsMnoGoSearch.h.

char WsMnoGoSearch::m_udmQuery[256]

private

Definition at line 66 of file WsMnoGoSearch.h.

string WsMnoGoSearch::m_user

private

Definition at line 67 of file WsMnoGoSearch.h.

pf_UdmAgentAddLine WsMnoGoSearch::mf_UdmAgentAddLine

private

Definition at line 75 of file WsMnoGoSearch.h.

pf_UdmAgentFree WsMnoGoSearch::mf_UdmAgentFree

private

Definition at line 80 of file WsMnoGoSearch.h.

pf_UdmAgentInit WsMnoGoSearch::mf_UdmAgentInit

private

Definition at line 74 of file WsMnoGoSearch.h.

pf_UdmEnvFree WsMnoGoSearch::mf_UdmEnvFree

private

Definition at line 81 of file WsMnoGoSearch.h.

pf_UdmEnvInit WsMnoGoSearch::mf_UdmEnvInit

private

Definition at line 73 of file WsMnoGoSearch.h.

pf_UdmFind2 WsMnoGoSearch::mf_UdmFind2

private

Definition at line 76 of file WsMnoGoSearch.h.

pf_UdmResultFree WsMnoGoSearch::mf_UdmResultFree

private

Definition at line 79 of file WsMnoGoSearch.h.

pf_UdmVarListFindInt WsMnoGoSearch::mf_UdmVarListFindInt

private

Definition at line 77 of file WsMnoGoSearch.h.

pf_UdmVarListFindStr WsMnoGoSearch::mf_UdmVarListFindStr

private

Definition at line 78 of file WsMnoGoSearch.h.

---

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

• /Users/benoitdaccache/Documents/Dropbox/Programming/Ws/wscore/src/WsSearchModules/MnoGoSearch/src/WsMnoGoSearch.h
• /Users/benoitdaccache/Documents/Dropbox/Programming/Ws/wscore/src/WsSearchModules/MnoGoSearch/src/WsMnoGoSearch.cpp