NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | List of all members
IDMSearchTool Class Referenceabstract

Search Toolkit Book for IDMSearchTool

IDMSearchTool interface representing a single search tool in Data Mining Service. More...

#include <gui/core/dm_search_tool.hpp>

+ Inheritance diagram for IDMSearchTool:
+ Collaboration diagram for IDMSearchTool:

Classes

struct  TConversions
 
struct  TFilters
 

Public Types

enum  TUIFlagValue { eNone = 0 , eAutorun = 1 , eCache = 2 , eFilter = 4 }
 
typedef int TUIToolFlags
 
typedef pair< string, stringTFilter
 

Public Member Functions

virtual ~IDMSearchTool ()
 
virtual CIRef< IDMSearchFormCreateSearchForm ()=0
 factory method for creating a form representing the tool More...
 
virtual bool IsCompatible (IDataMiningContext *context)=0
 retuns true if the tool is compatible with the provided Search Context More...
 
virtual bool StartSearch (IDMSearchQuery &query, IDMSearchFormController &listener)=0
 Starts search Job, the job is identified by the query object. More...
 
virtual bool CancelSearch (IDMSearchFormController &listener)=0
 
virtual bool PullSearch (IDMSearchQuery &query, IDMSearchFormController &listener)=0
 Pulls cached result from cache if possible (true) More...
 
virtual string GetJobDescr (IDMSearchFormController &listener)=0
 
virtual TUIToolFlags GetFlags (void)=0
 special flags More...
 
virtual TConversionsGetConversions (void)=0
 list of acceptable feat types top convert and default type More...
 
virtual const TFiltersGetFilters (void) const =0
 list of all tool-provided filters More...
 
virtual TFiltersSetFilters ()=0
 
IUITool implementation
virtual IUIToolClone () const =0
 
virtual string GetName () const =0
 returns unique name of the method that is used in UI to identify it More...
 
virtual string GetDescription () const =0
 returns a detailed description of the method that is used in UI More...
 
- Public Member Functions inherited from IUITool
virtual ~IUITool ()
 

Detailed Description

IDMSearchTool interface representing a single search tool in Data Mining Service.

The tool manages multiple Search Sessions and provides a mechanism for asynchronous parallel execution of search jobs.

Definition at line 72 of file dm_search_tool.hpp.

Member Typedef Documentation

◆ TFilter

Definition at line 89 of file dm_search_tool.hpp.

◆ TUIToolFlags

Definition at line 82 of file dm_search_tool.hpp.

Member Enumeration Documentation

◆ TUIFlagValue

Enumerator
eNone 
eAutorun 
eCache 
eFilter 

Definition at line 75 of file dm_search_tool.hpp.

Constructor & Destructor Documentation

◆ ~IDMSearchTool()

virtual IDMSearchTool::~IDMSearchTool ( )
inlinevirtual

Definition at line 96 of file dm_search_tool.hpp.

Member Function Documentation

◆ CancelSearch()

virtual bool IDMSearchTool::CancelSearch ( IDMSearchFormController listener)
pure virtual

Implemented in CSearchToolBase.

◆ Clone()

virtual IUITool* IDMSearchTool::Clone ( ) const
pure virtual

◆ CreateSearchForm()

virtual CIRef<IDMSearchForm> IDMSearchTool::CreateSearchForm ( )
pure virtual

◆ GetConversions()

virtual TConversions& IDMSearchTool::GetConversions ( void  )
pure virtual

list of acceptable feat types top convert and default type

Implemented in CSearchToolBase.

◆ GetDescription()

virtual string IDMSearchTool::GetDescription ( ) const
pure virtual

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

Implements IUITool.

Implemented in CSearchToolBase, CVcfSearchTool, CSequenceSearchTool, COrfSearchTool, CFeatureSearchTool, CEntrezSearchTool, CCpgSearchTool, CComponentSearchTool, CSNPSearchTool, and CNetBLAST_DMSearchTool.

◆ GetFilters()

virtual const TFilters& IDMSearchTool::GetFilters ( void  ) const
pure virtual

list of all tool-provided filters

Implemented in CSearchToolBase.

◆ GetFlags()

virtual TUIToolFlags IDMSearchTool::GetFlags ( void  )
pure virtual

◆ GetJobDescr()

virtual string IDMSearchTool::GetJobDescr ( IDMSearchFormController listener)
pure virtual

Implemented in CSearchToolBase.

◆ GetName()

virtual string IDMSearchTool::GetName ( ) const
pure virtual

◆ IsCompatible()

virtual bool IDMSearchTool::IsCompatible ( IDataMiningContext context)
pure virtual

◆ PullSearch()

virtual bool IDMSearchTool::PullSearch ( IDMSearchQuery query,
IDMSearchFormController listener 
)
pure virtual

Pulls cached result from cache if possible (true)

Implemented in CSearchToolBase.

◆ SetFilters()

virtual TFilters& IDMSearchTool::SetFilters ( )
pure virtual

Implemented in CSearchToolBase.

◆ StartSearch()

virtual bool IDMSearchTool::StartSearch ( IDMSearchQuery query,
IDMSearchFormController listener 
)
pure virtual

Starts search Job, the job is identified by the query object.

Implemented in CSearchToolBase.


The documentation for this class was generated from the following file:
Modified on Thu Feb 22 17:13:40 2024 by modify_doxy.py rev. 669887