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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: file_loader.hpp,v $
  4.  * PRODUCTION Revision 1000.4  2004/06/01 20:57:40  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.23
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_PLUGINS_DOC_BASIC___FILE_LOADER__HPP
  10. #define GUI_PLUGINS_DOC_BASIC___FILE_LOADER__HPP
  11. /*  $Id: file_loader.hpp,v 1000.4 2004/06/01 20:57:40 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Authors:  Mike DiCuccio
  37.  *
  38.  * File Description:
  39.  *    CDataPlugin_FileLoader - load sequence information from a file.
  40.  */
  41. #include <gui/core/doc_loader.hpp>
  42. #include <gui/plugin/MessageStatus.hpp>
  43. #include <gui/plugin/PluginInfo.hpp>
  44. #include <objmgr/scope.hpp>
  45. #include <objects/seq/Bioseq.hpp>
  46. #include <objects/seq/Seq_annot.hpp>
  47. #include <objects/seqfeat/Seq_feat.hpp>
  48. #include <objects/seqalign/Seq_align.hpp>
  49. #include <objects/seqset/Seq_entry.hpp>
  50. #include <objects/seqset/Bioseq_set.hpp>
  51. #include <objects/submit/Seq_submit.hpp>
  52. BEGIN_NCBI_SCOPE
  53. class IDocument;
  54. class CObjectInfo;
  55. class CDataPlugin_FileLoader : public CDocLoader<CDataPlugin_FileLoader>
  56. {
  57. public:
  58.     /// enum defining the formats we support
  59.     enum EFormat {
  60.         ///< autodetect will try to guess which of the
  61.         ///< following formats applies.
  62.         eFormat_Autodetect,
  63.         ///< force ASN binary
  64.         eFormat_AsnBinary,
  65.         ///< force ASN text
  66.         eFormat_AsnText,
  67.         ///< force XML
  68.         eFormat_XML,
  69.         ///< force FASTA
  70.         eFormat_FastA,
  71.         ///< force generic text alignment
  72.         eFormat_TextAlign,
  73.         ///< force Newick format phylogenetic tree
  74.         eFormat_NewickTree
  75.     };
  76.     CDataPlugin_FileLoader();
  77.     ~CDataPlugin_FileLoader();
  78.     /// virtual hook: load a document
  79.     void Load(objects::CPluginMessage& msg);
  80.     /// virtual hook: import data into a document
  81.     void Import(objects::CPluginMessage& msg);
  82.     /// Subversion of Load called when any suspected object is read
  83.     void Load(const CObjectInfo& info, IDocument* doc,
  84.               objects::CPluginReply& reply);
  85.     static void GetInfo(objects::CPluginInfo& info);
  86. private:
  87.     /// Internal version of load - here we iterate through the various file
  88.     /// types looking for a match.
  89.     void x_LoadFile(const string& fname, EFormat fmt, IDocument* doc,
  90.                     objects::CPluginReply& reply);
  91.     void x_LoadStream(CNcbiIstream& input, EFormat fmt, IDocument* doc,
  92.                       objects::CPluginReply& reply);
  93.     /// sub-versions of load, called for each object that is read
  94.     void x_Load(objects::CSeq_entry& entry, IDocument* doc,
  95.                 objects::CPluginReply& reply);
  96.     void x_Load(objects::CBioseq_set& bioseq_set, IDocument* doc,
  97.                 objects::CPluginReply& reply);
  98.     void x_Load(objects::CBioseq& bioseq, IDocument* doc,
  99.                 objects::CPluginReply& reply);
  100.     void x_Load(objects::CSeq_annot& annot, IDocument* doc,
  101.                 objects::CPluginReply& reply);
  102.     void x_Load(objects::CSeq_align& align, IDocument* doc,
  103.                 objects::CPluginReply& reply);
  104.     void x_Load(objects::CSeq_align_set& align, IDocument* doc,
  105.                 objects::CPluginReply& reply);
  106.     void x_Load(objects::CSeq_submit& submit, IDocument* doc,
  107.                 objects::CPluginReply& reply);
  108.     /// Convert a single Seq-entry to a single bioseq handle
  109.     objects::CBioseq_Handle
  110.     x_SeqEntryToBioseqHandle(objects::CSeq_entry& entry,
  111.                              objects::CScope& scope);
  112.     /// internal load-into function to add an annotation to a document
  113.     objects::EMessageStatus
  114.     x_LoadAnnotation(IDocument* doc, CRef<objects::CSeq_annot>& annot);
  115. };
  116. END_NCBI_SCOPE
  117. /*
  118.  * ===========================================================================
  119.  * $Log: file_loader.hpp,v $
  120.  * Revision 1000.4  2004/06/01 20:57:40  gouriano
  121.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.23
  122.  *
  123.  * Revision 1.23  2004/05/25 17:21:59  dicuccio
  124.  * Modified class names.  Fonts to 12 point
  125.  *
  126.  * Revision 1.22  2004/04/05 14:27:10  dicuccio
  127.  * Added check to make sure the file exists before opening.  Added support for
  128.  * seq-align-set conversions
  129.  *
  130.  * Revision 1.21  2004/03/23 22:09:01  jcherry
  131.  * Isolate stream operations from file stuff
  132.  *
  133.  * Revision 1.20  2004/03/01 15:12:04  dicuccio
  134.  * Added support for CLUSTAL alignments.  Added handling of type specification in
  135.  * plugin args.  Added support for Newic format phylogenetic trees.
  136.  *
  137.  * Revision 1.19  2003/11/18 17:49:01  dicuccio
  138.  * Added standard processing of return values
  139.  *
  140.  * Revision 1.18  2003/11/04 17:49:24  dicuccio
  141.  * Changed calling parameters for plugins - pass CPluginMessage instead of paired
  142.  * CPluginCommand/CPluginReply
  143.  *
  144.  * Revision 1.17  2003/10/10 17:17:28  dicuccio
  145.  * Added Import() method - split out from Load()
  146.  *
  147.  * Revision 1.16  2003/09/29 15:39:10  dicuccio
  148.  * Header file clean-up.  Deprecated gui/scope.hpp and gui/core/types.hpp.  Added
  149.  * GenBank data loader management dialog
  150.  *
  151.  * Revision 1.15  2003/09/16 14:07:28  dicuccio
  152.  * Removed Save function - split into separate plugin class
  153.  *
  154.  * Revision 1.14  2003/09/04 14:51:01  dicuccio
  155.  * Use IDocument instead of CDocument
  156.  *
  157.  * Revision 1.13  2003/07/14 11:16:38  shomrat
  158.  * Plugin messageing system related changes
  159.  *
  160.  * Revision 1.12  2003/06/20 14:52:57  dicuccio
  161.  * Revised plugin registration - moved GetInfo() into the plugin handler
  162.  *
  163.  * Revision 1.11  2003/06/17 19:14:56  dicuccio
  164.  * Cleaned up and re-enabled file importing
  165.  *
  166.  * Revision 1.10  2003/06/10 14:59:13  kuznets
  167.  * File opening reimplemented using CObjectsSniffer(obj_sniff.hpp)
  168.  *
  169.  * Revision 1.9  2003/06/02 16:06:22  dicuccio
  170.  * Rearranged src/objects/ subtree.  This includes the following shifts:
  171.  *     - src/objects/asn2asn --> arc/app/asn2asn
  172.  *     - src/objects/testmedline --> src/objects/ncbimime/test
  173.  *     - src/objects/objmgr --> src/objmgr
  174.  *     - src/objects/util --> src/objmgr/util
  175.  *     - src/objects/alnmgr --> src/objtools/alnmgr
  176.  *     - src/objects/flat --> src/objtools/flat
  177.  *     - src/objects/validator --> src/objtools/validator
  178.  *     - src/objects/cddalignview --> src/objtools/cddalignview
  179.  * In addition, libseq now includes six of the objects/seq... libs, and libmmdb
  180.  * replaces the three libmmdb? libs.
  181.  *
  182.  * Revision 1.8  2003/04/24 16:39:08  dicuccio
  183.  * Updated to reflect changes in plugin API.  Changed location of document marshal
  184.  * from framework to plugin
  185.  *
  186.  * Revision 1.7  2003/02/24 13:03:16  dicuccio
  187.  * Renamed classes in plugin spec:
  188.  *     CArgSeg --> CPluginArgSet
  189.  *     CArgument --> CPluginArg
  190.  *     CPluginArgs --> CPluginCommand
  191.  *     CPluginCommands --> CPluginCommandSet
  192.  *
  193.  * Revision 1.6  2003/02/20 19:49:56  dicuccio
  194.  * Created new plugin architecture, based on ASN.1 spec.  Moved GBENCH frameowrk
  195.  * over to use new plugin architecture.
  196.  *
  197.  * Revision 1.5  2003/02/05 19:55:53  dicuccio
  198.  * Reworked file loading to handle more types
  199.  *
  200.  * Revision 1.4  2003/01/13 13:10:07  dicuccio
  201.  * Namespace clean-up.  Retired namespace gui -> converted all to namespace
  202.  * ncbi.  Moved all FLUID-generated code into namespace ncbi.
  203.  *
  204.  * Revision 1.3  2002/12/30 17:55:42  dicuccio
  205.  * Added new virtual requirement: Save() (not handled by some plugins; return
  206.  * values should be obeyed)
  207.  *
  208.  * Revision 1.2  2002/12/09 20:35:59  dicuccio
  209.  * Large revision to file loading code - added ability to read more object
  210.  * types, added ability to import annotations into current document.
  211.  *
  212.  * Revision 1.1  2002/11/25 20:51:01  dicuccio
  213.  * Initial revision.
  214.  *
  215.  * ===========================================================================
  216.  */
  217. #endif  /// GUI_PLUGINS_DOC_BASIC___FILE_LOADER__HPP