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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: gb_release_file.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/06/01 19:35:29  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.1
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef UTILS___GB_RELEASE_FILE__HPP
  10. #define UTILS___GB_RELEASE_FILE__HPP
  11. /*  $Id: gb_release_file.hpp,v 1000.0 2004/06/01 19:35:29 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. * Author:  Mati Shomrat
  37. * File Description:
  38. *   Utility class for processing Genbank release files.
  39. */
  40. #include <corelib/ncbistd.hpp>
  41. #include <objects/seqset/Seq_entry.hpp>
  42. BEGIN_NCBI_SCOPE
  43. USING_SCOPE(objects);
  44. // forward decleration
  45. class CGBReleaseFileImpl;
  46. // CGBReleaseFile is a utility class to ease the processing of Genbank
  47. // release files one Seq-entry at a time.
  48. // It shields the user from the underlying I/O hook mechanism.
  49. // 
  50. // Usage:
  51. // 1. Implement ISeqEntryHandler interface
  52. // 2. Create a CGBReleaseFile with the release file's name
  53. // 3. Register the handler object.
  54. // 4. Call Read(..), the handling method will be called for each Seq-entry.
  55. class NCBI_SEQSET_EXPORT CGBReleaseFile
  56. {
  57. public:
  58.     
  59.     // Interface for handling Seq-entry objects
  60.     class ISeqEntryHandler
  61.     {
  62.     public:
  63.         // user code for handling a Seq-entry goes here.
  64.         // The return value indicates whethear to continue (true),
  65.         // or abort (false) the read.
  66.         virtual bool HandleSeqEntry(CRef<CSeq_entry>& entry) = 0;
  67.     };
  68.     
  69.     // constructor
  70.     CGBReleaseFile(const string& file_name);
  71.     // destructor
  72.     virtual ~CGBReleaseFile(void);
  73.     
  74.     // Register handler
  75.     void RegisterHandler(ISeqEntryHandler* handler);
  76.     // Read the release file
  77.     void Read(void);
  78. private:
  79.     
  80.     CGBReleaseFileImpl& x_GetImpl(void);
  81.     CRef<CObject>   m_Impl;
  82. };
  83. END_NCBI_SCOPE
  84. /*
  85. * ===========================================================================
  86. *
  87. * $Log: gb_release_file.hpp,v $
  88. * Revision 1000.0  2004/06/01 19:35:29  gouriano
  89. * PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.1
  90. *
  91. * Revision 1.1  2004/05/19 14:40:22  shomrat
  92. * Initial Revision
  93. *
  94. *
  95. * ===========================================================================
  96. */
  97. #endif  //  UTILS___GB_RELEASE_FILE__HPP