CSearchToolBase Class Reference

Search Toolkit Book for CSearchToolBase

#include <search_tool_base.hpp>

Inheritance diagram for CSearchToolBase:

[legend]Collaboration diagram for CSearchToolBase:

[legend]List of all members.

Detailed Description

CSearchToolBase.

Definition at line 54 of file search_tool_base.hpp.

Public Types

enum EPatternType { eExactMatch, eWildcard, eRegexp, eNamed }

Public Member Functions

CSearchToolBase ()

virtual ~CSearchToolBase ()

void OnAJNotification (CEvent *evt)

CAppJobDispatcher notification handler.

void OnProgress (CEvent *evt)

virtual IDMSearchTool::TUIToolFlags GetFlags (void)

special flags

virtual IDMSearchTool::TConversions & GetConversions (void)

list of acceptable feat types top convert and default type

virtual IDMSearchTool::TFilters & GetFilters (void)

list of all tool-provided filters

virtual void SetFilters (IDMSearchTool::TFilters &filters)

IUITool interface

virtual IUITool * Clone () const =0

virtual string GetName () const =0

returns unique name of the method that is used in UI to identify it

virtual string GetDescription () const =0

returns a detailed description of the method that is used in UI

IDMSearchTool implementation

virtual IDMSearchForm * CreateSearchForm ()=0

factory method for creating a form representing the tool

virtual bool IsCompatible (IDataMiningContext *context)=0

retuns true if the tool is compatible with the provided Search Context

virtual bool StartSearch (IDMSearchQuery &query, IDMSearchFormController &listener)

virtual bool CancelSearch (IDMSearchFormController &listener)

virtual bool PullSearch (IDMSearchQuery &query, IDMSearchFormController &listener)

Pulls cached result from cache if possible (true).

virtual string GetJobDescr (IDMSearchFormController &form)

Static Public Member Functions

static string GetPatternTypeStr (EPatternType ptype)

String representation of pattern type.

Protected Member Functions

virtual CRef< CSearchJobBase > x_CreateJob (IDMSearchQuery &query)=0

create a job based on the given query, override in derived classes

int x_GetSessionIndexByID (int job_id)

int x_GetSessionIndexByQuery (IDMSearchQuery &query)

int x_GetSessionIndexByListener (IDMSearchFormController &listener)

virtual void x_OnJobCompleted (CAppJobNotification &notify, SSession &session)

virtual void x_OnJobFailed (CAppJobNotification &notify, SSession &session)

virtual void x_OnJobCanceled (CAppJobNotification &notify, SSession &session)

Protected Attributes

string m_Name

int m_ReportPeriod

vector< SSession * > m_Sessions

IDMSearchTool::TConversions m_Conversions

IDMSearchTool::TFilters m_Filters

CRef< CObjectList > m_Cache

Private Member Functions

DECLARE_EVENT_MAP ()

Classes

struct SSession

Member Enumeration Documentation

enum CSearchToolBase::EPatternType

Enumerator:

eExactMatch

eWildcard

eRegexp

eNamed

Definition at line 62 of file search_tool_base.hpp.

Constructor & Destructor Documentation

CSearchToolBase::CSearchToolBase ( )

Definition at line 53 of file search_tool_base.cpp.

CSearchToolBase::~CSearchToolBase ( ) [virtual]

Definition at line 59 of file search_tool_base.cpp.

Member Function Documentation

bool CSearchToolBase::CancelSearch ( IDMSearchFormController & listener ) [virtual]

Implements IDMSearchTool.
Definition at line 141 of file search_tool_base.cpp.
References CAppJobDispatcher::DeleteJob(), ERR_POST, CAppJobDispatcher::GetInstance(), CSearchToolBase::SSession::m_JobID, m_Sessions, and x_GetSessionIndexByListener().

virtual IUITool* CSearchToolBase::Clone ( ) const [pure virtual]

Implements IDMSearchTool.
Implemented in CNetBLAST_DMSearchTool, CComponentSearchTool, CCpgSearchTool, CEntrezSearchTool, CFeatureSearchTool, COrfSearchTool, and CSequenceSearchTool.

virtual IDMSearchForm* CSearchToolBase::CreateSearchForm ( ) [pure virtual]

factory method for creating a form representing the tool

Implements IDMSearchTool.
Implemented in CSeqLocToolBase, CNetBLAST_DMSearchTool, CComponentSearchTool, CCpgSearchTool, CEntrezSearchTool, CFeatureSearchTool, COrfSearchTool, and CSequenceSearchTool.

CSearchToolBase::DECLARE_EVENT_MAP ( ) [private]

IDMSearchTool::TConversions & CSearchToolBase::GetConversions ( void ) [virtual]

list of acceptable feat types top convert and default type

Implements IDMSearchTool.
Definition at line 328 of file search_tool_base.cpp.
References m_Conversions.

virtual string CSearchToolBase::GetDescription ( ) const [pure virtual]

returns a detailed description of the method that is used in UI

Implements IDMSearchTool.
Implemented in CNetBLAST_DMSearchTool, CComponentSearchTool, CCpgSearchTool, CEntrezSearchTool, CFeatureSearchTool, COrfSearchTool, and CSequenceSearchTool.

IDMSearchTool::TFilters & CSearchToolBase::GetFilters ( void ) [virtual]

list of all tool-provided filters

Implements IDMSearchTool.
Definition at line 333 of file search_tool_base.cpp.
References m_Filters.

IDMSearchTool::TUIToolFlags CSearchToolBase::GetFlags ( void ) [virtual]

special flags

Implements IDMSearchTool.
Reimplemented in CNetBLAST_DMSearchTool, and COrfSearchTool.
Definition at line 323 of file search_tool_base.cpp.
References IDMSearchTool::eCache.
Referenced by x_OnJobCompleted().

string CSearchToolBase::GetJobDescr ( IDMSearchFormController & form ) [virtual]

Implements IDMSearchTool.
Definition at line 237 of file search_tool_base.cpp.
References m_Sessions, and x_GetSessionIndexByListener().

virtual string CSearchToolBase::GetName ( ) const [pure virtual]

returns unique name of the method that is used in UI to identify it

Implements IDMSearchTool.
Implemented in CNetBLAST_DMSearchTool, CComponentSearchTool, CCpgSearchTool, CEntrezSearchTool, CFeatureSearchTool, COrfSearchTool, and CSequenceSearchTool.

string CSearchToolBase::GetPatternTypeStr ( EPatternType ptype ) [static]

String representation of pattern type.

Definition at line 63 of file search_tool_base.cpp.
References eExactMatch, eNamed, eRegexp, and eWildcard.
Referenced by CSequenceSearchQuery::ToString().

virtual bool CSearchToolBase::IsCompatible ( IDataMiningContext * context ) [pure virtual]

retuns true if the tool is compatible with the provided Search Context

Implements IDMSearchTool.
Implemented in CSeqLocToolBase, CNetBLAST_DMSearchTool, CComponentSearchTool, CCpgSearchTool, CEntrezSearchTool, CFeatureSearchTool, COrfSearchTool, and CSequenceSearchTool.

void CSearchToolBase::OnAJNotification ( CEvent * evt )

CAppJobDispatcher notification handler.

Definition at line 167 of file search_tool_base.cpp.
References _ASSERT, IAppJob::eCanceled, IAppJob::eCompleted, IAppJob::eFailed, ERR_POST, CAppJobNotification::GetJobID(), CAppJobNotification::GetState(), m_Sessions, x_GetSessionIndexByID(), x_OnJobCanceled(), x_OnJobCompleted(), and x_OnJobFailed().

void CSearchToolBase::OnProgress ( CEvent * evt )

Definition at line 203 of file search_tool_base.cpp.
References _ASSERT, ERR_POST, CAppJobNotification::GetJobID(), CRef< C, Locker >::GetPointer(), CConstRef< Interface, Locker >::GetPointer(), CAppJobNotification::GetProgress(), CAppJobProgress::GetText(), CSearchToolBase::SSession::m_Listener, CDMSearchProgress::m_Result, m_Sessions, IDMSearchFormController::OnSearchProgress(), and x_GetSessionIndexByID().

&CSearchToolBase::OnProgress bool CSearchToolBase::PullSearch ( IDMSearchQuery & query,

IDMSearchFormController & listener

) [virtual]

Pulls cached result from cache if possible (true).

Implements IDMSearchTool.
Definition at line 84 of file search_tool_base.cpp.
References IDMSearchTool::eAutorun, IDMSearchTool::eCache, and m_Cache.

void CSearchToolBase::SetFilters ( IDMSearchTool::TFilters & filters ) [virtual]

Implements IDMSearchTool.
Definition at line 338 of file search_tool_base.cpp.
References m_Filters.

bool CSearchToolBase::StartSearch ( IDMSearchQuery & query,

IDMSearchFormController & listener

) [virtual]

launch on ThreadPool, receive notifications, no progress reports delete the Job when completed
create session record
Implements IDMSearchTool.
Definition at line 103 of file search_tool_base.cpp.
References ERR_POST, CAppJobDispatcher::GetInstance(), CSearchToolBase::SSession::m_Descr, m_Filters, CSearchToolBase::SSession::m_JobID, CSearchToolBase::SSession::m_Listener, CSearchToolBase::SSession::m_Query, m_ReportPeriod, m_Sessions, query, CAppJobDispatcher::StartJob(), and x_CreateJob().

virtual CRef<CSearchJobBase> CSearchToolBase::x_CreateJob ( IDMSearchQuery & query ) [protected, pure virtual]

create a job based on the given query, override in derived classes

Implemented in CNetBLAST_DMSearchTool, CComponentSearchTool, CCpgSearchTool, CEntrezSearchTool, CFeatureSearchTool, COrfSearchTool, and CSequenceSearchTool.
Referenced by StartSearch().

int CSearchToolBase::x_GetSessionIndexByID ( int job_id ) [protected]

Definition at line 248 of file search_tool_base.cpp.
References m_Sessions.
Referenced by OnAJNotification(), and OnProgress().

int CSearchToolBase::x_GetSessionIndexByListener ( IDMSearchFormController & listener ) [protected]

Definition at line 270 of file search_tool_base.cpp.
References m_Sessions.
Referenced by CancelSearch(), and GetJobDescr().

int CSearchToolBase::x_GetSessionIndexByQuery ( IDMSearchQuery & query ) [protected]

Definition at line 259 of file search_tool_base.cpp.
References m_Sessions, and query.

void CSearchToolBase::x_OnJobCanceled ( CAppJobNotification & notify,

SSession & session

) [protected, virtual]

Definition at line 315 of file search_tool_base.cpp.
References m_Cache, CSearchToolBase::SSession::m_Listener, IDMSearchFormController::OnSearchCanceled(), and CRef< C, Locker >::Reset().
Referenced by OnAJNotification().

void CSearchToolBase::x_OnJobCompleted ( CAppJobNotification & notify,

SSession & session

) [protected, virtual]

Definition at line 281 of file search_tool_base.cpp.
References IDMSearchTool::eCache, ERR_POST, GetFlags(), CRef< C, Locker >::GetPointer(), CAppJobNotification::GetResult(), m_Cache, CSearchToolBase::SSession::m_JobID, CSearchToolBase::SSession::m_Listener, IDMSearchFormController::OnSearchFailed(), IDMSearchFormController::OnSearchFinished(), and CRef< C, Locker >::Reset().
Referenced by OnAJNotification().

void CSearchToolBase::x_OnJobFailed ( CAppJobNotification & notify,

SSession & session

) [protected, virtual]

Definition at line 301 of file search_tool_base.cpp.
References ERR_POST, CAppJobNotification::GetError(), m_Cache, CSearchToolBase::SSession::m_JobID, CSearchToolBase::SSession::m_Listener, IDMSearchFormController::OnSearchFailed(), and CRef< C, Locker >::Reset().
Referenced by OnAJNotification().

Member Data Documentation

CRef<CObjectList> CSearchToolBase::m_Cache [protected]

Definition at line 133 of file search_tool_base.hpp.
Referenced by x_OnJobCanceled(), x_OnJobCompleted(), and x_OnJobFailed().

IDMSearchTool::TConversions CSearchToolBase::m_Conversions [protected]

Definition at line 130 of file search_tool_base.hpp.
Referenced by CCpgSearchTool::CCpgSearchTool(), COrfSearchTool::COrfSearchTool(), CSequenceSearchTool::CSequenceSearchTool(), and GetConversions().

IDMSearchTool::TFilters CSearchToolBase::m_Filters [protected]

Definition at line 131 of file search_tool_base.hpp.
Referenced by COrfSearchTool::COrfSearchTool(), GetFilters(), SetFilters(), and StartSearch().

string CSearchToolBase::m_Name [protected]

Definition at line 126 of file search_tool_base.hpp.

int CSearchToolBase::m_ReportPeriod [protected]

Definition at line 128 of file search_tool_base.hpp.
Referenced by StartSearch().

vector<SSession*> CSearchToolBase::m_Sessions [protected]

Definition at line 129 of file search_tool_base.hpp.
Referenced by CancelSearch(), GetJobDescr(), OnAJNotification(), OnProgress(), StartSearch(), x_GetSessionIndexByID(), x_GetSessionIndexByListener(), and x_GetSessionIndexByQuery().

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

include/gui/core/search_tool_base.hpp
src/gui/core/search_tool_base.cpp

Generated on Wed Dec 9 08:07:31 2009 for NCBI C++ ToolKit by

1.4.6

Modified on Wed Dec 09 08:19:48 2009 by modify_doxy.py rev. 173732


Public Types
enum	EPatternType { eExactMatch, eWildcard, eRegexp, eNamed }
Public Member Functions
	CSearchToolBase ()
virtual	~CSearchToolBase ()
void	OnAJNotification (CEvent *evt)
	CAppJobDispatcher notification handler.
void	OnProgress (CEvent *evt)
virtual IDMSearchTool::TUIToolFlags	GetFlags (void)
	special flags
virtual IDMSearchTool::TConversions &	GetConversions (void)
	list of acceptable feat types top convert and default type
virtual IDMSearchTool::TFilters &	GetFilters (void)
	list of all tool-provided filters
virtual void	SetFilters (IDMSearchTool::TFilters &filters)
IUITool interface
virtual IUITool *	Clone () const =0
virtual string	GetName () const =0
	returns unique name of the method that is used in UI to identify it
virtual string	GetDescription () const =0
	returns a detailed description of the method that is used in UI
IDMSearchTool implementation
virtual IDMSearchForm *	CreateSearchForm ()=0
	factory method for creating a form representing the tool
virtual bool	IsCompatible (IDataMiningContext *context)=0
	retuns true if the tool is compatible with the provided Search Context
virtual bool	StartSearch (IDMSearchQuery &query, IDMSearchFormController &listener)
virtual bool	CancelSearch (IDMSearchFormController &listener)
virtual bool	PullSearch (IDMSearchQuery &query, IDMSearchFormController &listener)
	Pulls cached result from cache if possible (true).
virtual string	GetJobDescr (IDMSearchFormController &form)
Static Public Member Functions
static string	GetPatternTypeStr (EPatternType ptype)
	String representation of pattern type.
Protected Member Functions
virtual CRef< CSearchJobBase >	x_CreateJob (IDMSearchQuery &query)=0
	create a job based on the given query, override in derived classes
int	x_GetSessionIndexByID (int job_id)
int	x_GetSessionIndexByQuery (IDMSearchQuery &query)
int	x_GetSessionIndexByListener (IDMSearchFormController &listener)
virtual void	x_OnJobCompleted (CAppJobNotification &notify, SSession &session)
virtual void	x_OnJobFailed (CAppJobNotification &notify, SSession &session)
virtual void	x_OnJobCanceled (CAppJobNotification &notify, SSession &session)
Protected Attributes
string	m_Name
int	m_ReportPeriod
vector< SSession * >	m_Sessions
IDMSearchTool::TConversions	m_Conversions
IDMSearchTool::TFilters	m_Filters
CRef< CObjectList >	m_Cache
Private Member Functions
	DECLARE_EVENT_MAP ()
Classes
struct	SSession