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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: gather_items.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:38:46  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.12
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJTOOLS_FORMAT___GATHER_ITEMS__HPP
  10. #define OBJTOOLS_FORMAT___GATHER_ITEMS__HPP
  11. /*  $Id: gather_items.hpp,v 1000.1 2004/06/01 19:38:46 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. *
  38. * File Description:
  39. *
  40. */
  41. #include <corelib/ncbistd.hpp>
  42. #include <corelib/ncbiobj.hpp>
  43. #include <objtools/format/context.hpp>
  44. #include <objtools/format/flat_file_config.hpp>
  45. #include <objtools/format/items/comment_item.hpp>
  46. #include <objtools/format/items/feature_item.hpp>
  47. #include <deque>
  48. BEGIN_NCBI_SCOPE
  49. BEGIN_SCOPE(objects)
  50. class CBioseq_Handle;
  51. class CSeq_feat;
  52. class CFlatItemOStream;
  53. class CFlatGatherer : public CObject
  54. {
  55. public:
  56.     
  57.     // virtual constructor
  58.     static CFlatGatherer* New(CFlatFileConfig::TFormat format);
  59.     virtual void Gather(CFlatFileContext& ctx, CFlatItemOStream& os) const;
  60.     virtual ~CFlatGatherer(void);
  61. protected:
  62.     typedef CRange<TSeqPos> TRange;
  63.     CFlatGatherer(void) {}
  64.     CFlatItemOStream& ItemOS     (void) const { return *m_ItemOS;  }
  65.     CBioseqContext& Context      (void) const { return *m_Current; }
  66.     const CFlatFileConfig& Config(void) const { return m_Context->GetConfig(); }
  67.     virtual void x_GatherSeqEntry(const CSeq_entry_Handle& entry) const;
  68.     virtual void x_GatherBioseq(const CBioseq_Handle& seq) const;
  69.     virtual void x_DoMultipleSections(const CBioseq_Handle& seq) const;
  70.     virtual bool x_DisplayBioseq(const CSeq_entry_Handle& entry,
  71.         const CBioseq_Handle& seq) const;
  72.     virtual void x_DoSingleSection(CBioseqContext& ctx) const = 0;
  73.     // references
  74.     void x_GatherReferences(void) const;
  75.     // features
  76.     void x_GatherFeatures  (void) const;
  77.     void x_GetFeatsOnCdsProduct(const CSeq_feat& feat, CBioseqContext& ctx,
  78.         CRef<CSeq_loc_Mapper>& mapper) const;
  79.     void x_CopyCDSFromCDNA(const CSeq_feat& feat, CBioseqContext& ctx) const;
  80.     bool x_SkipFeature(const CSeq_feat& feat, const CBioseqContext& ctx) const;
  81.     void x_GatherFeaturesOnLocation(const CSeq_loc& loc, SAnnotSelector& sel,
  82.         CBioseqContext& ctx) const;
  83.     // source features
  84.     typedef CRef<CSourceFeatureItem>    TSFItem;
  85.     typedef deque<TSFItem>              TSourceFeatSet;
  86.     void x_GatherSourceFeatures(void) const;
  87.     void x_CollectBioSources(TSourceFeatSet& srcs) const;
  88.     void x_CollectBioSourcesOnBioseq(const CBioseq_Handle& bh,
  89.         const TRange& range, CBioseqContext& ctx, TSourceFeatSet& srcs) const;
  90.     void x_CollectSourceDescriptors(const CBioseq_Handle& bh, CBioseqContext& ctx,
  91.         TSourceFeatSet& srcs) const;
  92.     void x_CollectSourceFeatures(const CBioseq_Handle& bh,
  93.         const TRange& range, CBioseqContext& ctx,
  94.         TSourceFeatSet& srcs) const;
  95.     void x_MergeEqualBioSources(TSourceFeatSet& srcs) const;
  96.     void x_SubtractFromFocus(TSourceFeatSet& srcs) const;
  97.     // comments
  98.     void x_GatherComments  (void) const;
  99.     void x_AddComment(CCommentItem* comment) const;
  100.     void x_AddGSDBComment(const CDbtag& dbtag, CBioseqContext& ctx) const;
  101.     void x_FlushComments(void) const;
  102.     void x_IdComments(CBioseqContext& ctx) const;
  103.     void x_RefSeqComments(CBioseqContext& ctx) const;
  104.     void x_HistoryComments(CBioseqContext& ctx) const;
  105.     void x_WGSComment(CBioseqContext& ctx) const;
  106.     void x_GBBSourceComment(CBioseqContext& ctx) const;
  107.     void x_DescComments(CBioseqContext& ctx) const;
  108.     void x_MaplocComments(CBioseqContext& ctx) const;
  109.     void x_RegionComments(CBioseqContext& ctx) const;
  110.     void x_HTGSComments(CBioseqContext& ctx) const;
  111.     void x_FeatComments(CBioseqContext& ctx) const;
  112.     // sequence 
  113.     void x_GatherSequence  (void) const;
  114.     
  115. private:
  116.     CFlatGatherer(const CFlatGatherer&);
  117.     CFlatGatherer& operator=(const CFlatGatherer&);
  118.     // types
  119.     typedef vector< CRef<CCommentItem> > TCommentVec;
  120.     // data
  121.     mutable CRef<CFlatItemOStream>   m_ItemOS;
  122.     mutable CRef<CFlatFileContext>   m_Context;
  123.     mutable CRef<CBioseqContext>     m_Current;
  124.     mutable TCommentVec              m_Comments;
  125. };
  126. END_SCOPE(objects)
  127. END_NCBI_SCOPE
  128. /*
  129. * ===========================================================================
  130. *
  131. * $Log: gather_items.hpp,v $
  132. * Revision 1000.1  2004/06/01 19:38:46  gouriano
  133. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.12
  134. *
  135. * Revision 1.12  2004/05/06 17:45:08  shomrat
  136. * private methods changes
  137. *
  138. * Revision 1.11  2004/04/27 15:10:30  shomrat
  139. * use TRange instead of CRange<TSeqPos>
  140. *
  141. * Revision 1.10  2004/04/22 15:44:29  shomrat
  142. * Changes in context
  143. *
  144. * Revision 1.9  2004/03/26 21:58:06  ucko
  145. * +<context.hpp> due to use of CRef<CBioseqContext>, which requires a full
  146. * declaration with some compilers.
  147. *
  148. * Revision 1.8  2004/03/26 17:21:57  shomrat
  149. * + typedef TCommentVec
  150. *
  151. * Revision 1.7  2004/03/25 20:31:28  shomrat
  152. * Use handles
  153. *
  154. * Revision 1.6  2004/03/16 15:40:21  vasilche
  155. * Added required include
  156. *
  157. * Revision 1.5  2004/03/12 16:54:32  shomrat
  158. * + x_DisplayBioseq
  159. *
  160. * Revision 1.4  2004/02/11 22:47:14  shomrat
  161. * using types in flag file
  162. *
  163. * Revision 1.3  2004/02/11 16:41:30  shomrat
  164. * modification to feature gathering methods
  165. *
  166. * Revision 1.2  2004/01/14 15:54:06  shomrat
  167. * added source indicator to x_GatherFeatures (temporary)
  168. *
  169. * Revision 1.1  2003/12/17 19:52:53  shomrat
  170. * Initial revision (adapted from flat lib)
  171. *
  172. *
  173. * ===========================================================================
  174. */
  175. #endif  /* OBJTOOLS_FORMAT___GATHER_INFO__HPP */