Wittyshare  0.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
WsAbstractSearch Class Referenceabstract

Abstract class for search. More...

#include <WsAbstractSearch.h>

Inheritance diagram for WsAbstractSearch:
Inheritance graph
Collaboration diagram for WsAbstractSearch:
Collaboration graph

Public Member Functions

virtual ~WsAbstractSearch ()
 virtual destructor More...
 
virtual int load (FileSystemTreePtr fs, std::string q)=0
 load the results (execute the search query) More...
 
virtual int getSize ()=0
 return the number of results found More...
 
virtual vector< WsResultItemgetResults (const std::set< std::string > &groups)=0
 return the results found for the query filtered for the user More...
 

Detailed Description

Abstract class for search.

Search module must inherit this class.

Definition at line 31 of file WsAbstractSearch.h.

Constructor & Destructor Documentation

WsAbstractSearch::~WsAbstractSearch ( )
virtual

virtual destructor

Definition at line 15 of file WsAbstractSearch.cpp.

Member Function Documentation

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

return the results found for the query filtered for the user

Parameters
groupsthe 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:

virtual int WsAbstractSearch::getSize ( )
pure virtual

return the number of results found

Implemented in WsMnoGoSearch.

Here is the caller graph for this function:

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

load the results (execute the search query)

Returns
SUCCESS if ok, failure otherwise

Here is the caller graph for this function:


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