entrez_search.cpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:9k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: entrez_search.cpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/06/01 21:26:50  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.1
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /*  $Id: entrez_search.cpp,v 1000.0 2004/06/01 21:26:50 gouriano Exp $
  10.  * ===========================================================================
  11.  *
  12.  *                            PUBLIC DOMAIN NOTICE
  13.  *               National Center for Biotechnology Information
  14.  *
  15.  *  This software/database is a "United States Government Work" under the
  16.  *  terms of the United States Copyright Act.  It was written as part of
  17.  *  the author's official duties as a United States Government employee and
  18.  *  thus cannot be copyrighted.  This software/database is freely available
  19.  *  to the public for use. The National Library of Medicine and the U.S.
  20.  *  Government have not placed any restriction on its use or reproduction.
  21.  *
  22.  *  Although all reasonable efforts have been taken to ensure the accuracy
  23.  *  and reliability of the software and data, the NLM and the U.S.
  24.  *  Government do not and cannot warrant the performance or results that
  25.  *  may be obtained by using this software or data. The NLM and the U.S.
  26.  *  Government disclaim all warranties, express or implied, including
  27.  *  warranties of performance, merchantability or fitness for any particular
  28.  *  purpose.
  29.  *
  30.  *  Please cite the author in any work or product based on this material.
  31.  *
  32.  * ===========================================================================
  33.  *
  34.  * Authors:  Mike DiCuccio
  35.  *
  36.  * File Description:
  37.  *    CDataPlugin_EntrezSearch - load sequence information form Genbank.
  38.  */
  39. #include <ncbi_pch.hpp>
  40. #include "entrez_search.hpp"
  41. #include "entrez_search_dlg.hpp"
  42. #include <gui/core/version.hpp>
  43. #include <gui/core/plugin_utils.hpp>
  44. #include <gui/plugin/PluginCommandSet.hpp>
  45. #include <gui/plugin/PluginInfo.hpp>
  46. #include <gui/plugin/PluginValue.hpp>
  47. #include <gui/utils/message_box.hpp>
  48. BEGIN_NCBI_SCOPE
  49. USING_SCOPE(objects);
  50. //
  51. // class CDataPlugin_EntrezSearchException defines some internal exception types used in
  52. // processing files.
  53. //
  54. // This class is used internally to avoid an ad-hoc exception mechanism;
  55. // currently, it reports only errors concerning invalid format types.
  56. //
  57. class CDataPlugin_EntrezSearchException : EXCEPTION_VIRTUAL_BASE public CException
  58. {
  59. public:
  60.     // Enumerated list of exception types
  61.     enum EErrCode {
  62.         eInvalidId
  63.     };
  64.     // Convert an enuerated exception to a human-readable string representation
  65.     // of this exception.
  66.     virtual const char* GetErrCodeString(void) const
  67.     {
  68.         switch (GetErrCode()) {
  69.         case eInvalidId:        return "eInvalidId";
  70.         default:                return CException::GetErrCodeString();
  71.         }
  72.     }
  73.     // constructor boilerplate
  74.     NCBI_EXCEPTION_DEFAULT(CDataPlugin_EntrezSearchException, CException);
  75. };
  76. void CDataPlugin_EntrezSearch::GetInfo(CPluginInfo& info)
  77. {
  78.     info.Reset();
  79.     // version info macro
  80.     info.SetInfo(CPluginVersion::eMajor, CPluginVersion::eMinor, 0,
  81.                  string(__DATE__) + " " + string(__TIME__),
  82.                  "CDataPlugin_EntrezSearch", "GenBank (Nucleotide\/Protein\/Genome)",
  83.                  "Search public GenBank records", "");
  84.     // command info
  85.     CPluginCommandSet& cmds     = info.SetCommands();
  86.     CPluginCommand& search_args = cmds.AddDataCommand(eDataCommand_search);
  87.     {{
  88.         CPluginArg& arg = 
  89.             search_args.AddArgument("query", "Search string",
  90.                                     CPluginArg::eString);
  91.         arg.SetHidden(true);
  92.     }}
  93.     {{
  94.         CPluginArg& arg = 
  95.             search_args.AddArgument("db", "Database to search",
  96.                                     CPluginArg::eString);
  97.         arg.SetHidden(true);
  98.     }}
  99. }
  100. CDataPlugin_EntrezSearch::CDataPlugin_EntrezSearch()
  101. {
  102. }
  103. CDataPlugin_EntrezSearch::~CDataPlugin_EntrezSearch()
  104. {
  105. }
  106. //
  107. // load a record from Genbank into a fully-prepared document
  108. //
  109. void CDataPlugin_EntrezSearch::Search(CPluginMessage& msg)
  110. {
  111.     const CPluginCommand& args = msg.GetRequest().GetCommand();
  112.     CPluginReply& reply = msg.SetReply();
  113.     reply.SetStatus(eMessageStatus_success);
  114.     if ( !m_Dialog.get() ) {
  115.         m_Dialog.reset(new CEntrezSearchDlg());
  116.     }
  117.     if (args.HasArgument("query")  &&  CPluginUtils::IsValid(args["query"])) {
  118.         string query = args["query"].AsString();
  119.         m_Dialog->SetQuery(query);
  120.     }
  121.     if (args.HasArgument("db")  &&  CPluginUtils::IsValid(args["db"])) {
  122.         string db = args["db"].AsString();
  123.         m_Dialog->SetDB(db);
  124.     }
  125.     m_Dialog->Show();
  126. }
  127. END_NCBI_SCOPE
  128. /*
  129.  * ===========================================================================
  130.  * $Log: entrez_search.cpp,v $
  131.  * Revision 1000.0  2004/06/01 21:26:50  gouriano
  132.  * PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.1
  133.  *
  134.  * Revision 1.1  2004/05/25 17:15:39  dicuccio
  135.  * Initial revision - moved over from old GenBank search
  136.  *
  137.  * Revision 1.7  2003/12/22 19:29:20  dicuccio
  138.  * Added explicit passing of query string and database
  139.  *
  140.  * Revision 1.6  2003/12/04 18:14:07  dicuccio
  141.  * Lots of updates.  Added a status bar to track actions.  General code-clean-up
  142.  *
  143.  * Revision 1.5  2003/11/24 15:45:34  dicuccio
  144.  * Renamed CVersion to CPluginVersion
  145.  *
  146.  * Revision 1.4  2003/11/04 17:49:24  dicuccio
  147.  * Changed calling parameters for plugins - pass CPluginMessage instead of paired
  148.  * CPluginCommand/CPluginReply
  149.  *
  150.  * Revision 1.3  2003/10/07 13:47:05  dicuccio
  151.  * Renamed CPluginURL* to CPluginValue*
  152.  *
  153.  * Revision 1.2  2003/08/01 14:37:20  dicuccio
  154.  * Solved issue with plugin communication - make sure that sequences are loaded
  155.  * when the load button is clicked, not when the dialog closes
  156.  *
  157.  * Revision 1.1  2003/07/31 17:04:00  dicuccio
  158.  * Added GenBank search
  159.  *
  160.  * Revision 1.22  2003/07/14 11:16:52  shomrat
  161.  * Plugin messageing system related changes
  162.  *
  163.  * Revision 1.21  2003/06/25 17:02:58  dicuccio
  164.  * Split CPluginHandle into a handle (pointer-to-implementation) and
  165.  * implementation file.  Lots of #include file clean-ups.
  166.  *
  167.  * Revision 1.20  2003/06/20 14:52:57  dicuccio
  168.  * Revised plugin registration - moved GetInfo() into the plugin handler
  169.  *
  170.  * Revision 1.19  2003/06/02 16:06:22  dicuccio
  171.  * Rearranged src/objects/ subtree.  This includes the following shifts:
  172.  *     - src/objects/asn2asn --> arc/app/asn2asn
  173.  *     - src/objects/testmedline --> src/objects/ncbimime/test
  174.  *     - src/objects/objmgr --> src/objmgr
  175.  *     - src/objects/util --> src/objmgr/util
  176.  *     - src/objects/alnmgr --> src/objtools/alnmgr
  177.  *     - src/objects/flat --> src/objtools/flat
  178.  *     - src/objects/validator --> src/objtools/validator
  179.  *     - src/objects/cddalignview --> src/objtools/cddalignview
  180.  * In addition, libseq now includes six of the objects/seq... libs, and libmmdb
  181.  * replaces the three libmmdb? libs.
  182.  *
  183.  * Revision 1.18  2003/05/30 14:15:42  dicuccio
  184.  * Renamed MessageBox to NcbiMessageBox because brain-dead MSVC thinks this is
  185.  * ::MessageBox and rewrites the symbol as MessageBoxA, which results in an
  186.  * unresolved external and conflict with the Win32 API :(.
  187.  *
  188.  * Revision 1.17  2003/05/30 13:10:37  dicuccio
  189.  * Use MessageBox() instead of fl_alter()
  190.  *
  191.  * Revision 1.16  2003/05/19 13:40:44  dicuccio
  192.  * Moved gui/core/plugin/ -> gui/plugin/.  Merged core libraries into libgui_core.
  193.  * Removed old, unused dialog box.
  194.  *
  195.  * Revision 1.15  2003/05/01 12:54:34  dicuccio
  196.  * Changed a useful trace -> log post for failure to load accession
  197.  *
  198.  * Revision 1.14  2003/04/29 14:52:31  dicuccio
  199.  * Deprecated old accession entry dialog.  Added correct plugin argument to specify accession names
  200.  *
  201.  * Revision 1.13  2003/04/24 16:39:08  dicuccio
  202.  * Updated to reflect changes in plugin API.  Changed location of document
  203.  * marshal from framework to plugin
  204.  *
  205.  * Revision 1.12  2003/02/26 14:26:56  dicuccio
  206.  * Removed unnecessary _TRACE() statements
  207.  *
  208.  * Revision 1.11  2003/02/24 13:03:16  dicuccio
  209.  * Renamed classes in plugin spec:
  210.  *     CArgSeg --> CPluginArgSet
  211.  *     CArgument --> CPluginArg
  212.  *     CPluginArgs --> CPluginCommand
  213.  *     CPluginCommands --> CPluginCommandSet
  214.  *
  215.  * Revision 1.10  2003/02/20 19:49:56  dicuccio
  216.  * Created new plugin architecture, based on ASN.1 spec.  Moved GBENCH
  217.  * frameowrk over to use new plugin architecture.
  218.  *
  219.  * Revision 1.9  2003/02/06 18:48:36  dicuccio
  220.  * Made 'catch (...)' conditional for non-debug builds
  221.  *
  222.  * Revision 1.8  2003/01/15 21:08:34  dicuccio
  223.  * Removed dead _TRACE() statements
  224.  *
  225.  * Revision 1.7  2003/01/13 13:10:07  dicuccio
  226.  * Namespace clean-up.  Retired namespace gui -> converted all to namespace
  227.  * ncbi.  Moved all FLUID-generated code into namespace ncbi.
  228.  *
  229.  * Revision 1.6  2003/01/03 17:25:50  dicuccio
  230.  * Fixed (finally!) issues regarding input validation of seq-ids.
  231.  *
  232.  * Revision 1.5  2002/12/30 18:44:20  dicuccio
  233.  * Fixed a number of buglets in accession dialog and in handling of empty
  234.  * accessions.
  235.  *
  236.  * Revision 1.4  2002/12/30 17:48:28  dicuccio
  237.  * Added mechanism for data loader plugins to announce supported modes of
  238.  * operation (load, import, save currently)
  239.  *
  240.  * Revision 1.3  2002/12/20 19:17:58  dicuccio
  241.  * Added better handling of sueqnece ID errors (try not to segfault...)
  242.  *
  243.  * Revision 1.2  2002/12/12 15:22:38  dicuccio
  244.  * Minot tweak to avoid a compiler warning.
  245.  *
  246.  * Revision 1.1  2002/11/25 20:51:01  dicuccio
  247.  * Initial revision.
  248.  *
  249.  * ===========================================================================
  250.  */