开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
feature_item.hpp
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：13k
源码类别：

生物技术

开发平台：

C/C++

feature_item.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: feature_item.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:39:30  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.16
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef OBJTOOLS_FORMAT_ITEMS___FLAT_FEATURE__HPP
  11. #define OBJTOOLS_FORMAT_ITEMS___FLAT_FEATURE__HPP
  13. /*  $Id: feature_item.hpp,v 1000.1 2004/06/01 19:39:30 gouriano Exp $
  14. * ===========================================================================
  15. *
  16. *                            PUBLIC DOMAIN NOTICE
  17. *               National Center for Biotechnology Information
  18. *
  19. *  This software/database is a "United States Government Work" under the
  20. *  terms of the United States Copyright Act.  It was written as part of
  21. *  the author's official duties as a United States Government employee and
  22. *  thus cannot be copyrighted.  This software/database is freely available
  23. *  to the public for use. The National Library of Medicine and the U.S.
  24. *  Government have not placed any restriction on its use or reproduction.
  25. *
  26. *  Although all reasonable efforts have been taken to ensure the accuracy
  27. *  and reliability of the software and data, the NLM and the U.S.
  28. *  Government do not and cannot warrant the performance or results that
  29. *  may be obtained by using this software or data. The NLM and the U.S.
  30. *  Government disclaim all warranties, express or implied, including
  31. *  warranties of performance, merchantability or fitness for any particular
  32. *  purpose.
  33. *
  34. *  Please cite the author in any work or product based on this material.
  35. *
  36. * ===========================================================================
  37. *
  38. * Author:  Aaron Ucko, NCBI
  39. *          Mati Shomrat
  40. *
  41. * File Description:
  42. *   new (early 2003) flat-file generator -- representation of features
  43. *   (mainly of interest to implementors)
  44. *
  45. */
  46. #include <corelib/ncbistd.hpp>
  47. #include <corelib/ncbiobj.hpp>
  48. #include <objmgr/feat_ci.hpp>
  49. #include <objtools/format/items/flat_qual_slots.hpp>
  50. #include <objtools/format/items/qualifiers.hpp>
  51. #include <objtools/format/formatter.hpp>
  52. #include <objtools/format/text_ostream.hpp>
  53. #include <objtools/format/items/item_base.hpp>
  56. BEGIN_NCBI_SCOPE
  57. BEGIN_SCOPE(objects)
  60. class CFeatHeaderItem : public CFlatItem
  61. {
  62. public:
  63.     CFeatHeaderItem(CBioseqContext& ctx);
  64.     void Format(IFormatter& formatter,
  65.         IFlatTextOStream& text_os) const {
  66.         formatter.FormatFeatHeader(*this, text_os);
  67.     }
  69.     const CSeq_id& GetId(void) const { return *m_Id; }  // for FTable format
  71. private:
  72.     void x_GatherInfo(CBioseqContext& ctx);
  74.     // data
  75.     CConstRef<CSeq_id>  m_Id;  // for FTable format
  76. };
  79. class CFlatFeature : public CObject
  80. {
  81. public:
  82.     CFlatFeature(const string& key, const CFlatSeqLoc& loc, const CSeq_feat& feat)
  83.         : m_Key(key), m_Loc(&loc), m_Feat(&feat) { }
  85.     typedef vector<CRef<CFormatQual> > TQuals;
  87.     const string&      GetKey  (void) const { return m_Key;   }
  88.     const CFlatSeqLoc& GetLoc  (void) const { return *m_Loc;  }
  89.     const TQuals&      GetQuals(void) const { return m_Quals; }
  90.     const CSeq_feat&   GetFeat (void) const { return *m_Feat; }
  92.     TQuals& SetQuals(void) { return m_Quals; }
  94. private:
  95.     string                  m_Key;
  96.     CConstRef<CFlatSeqLoc>  m_Loc;
  97.     TQuals                  m_Quals;
  98.     CConstRef<CSeq_feat>    m_Feat;
  99. };
  102. class CFeatureItemBase : public CFlatItem
  103. {
  104. public:
  105.     CConstRef<CFlatFeature> Format(void) const;
  106.     void Format(IFormatter& formatter, IFlatTextOStream& text_os) const {
  107.         formatter.FormatFeature(*this, text_os);
  108.     }
  109.     bool operator<(const CFeatureItemBase& f2) const {
  110.         return m_Feat->Compare(*f2.m_Feat, GetLoc(), f2.GetLoc()) < 0; 
  111.     }
  112.     const CSeq_feat& GetFeat(void)  const { return *m_Feat; }
  113.     const CSeq_loc&  GetLoc(void)   const { return *m_Loc; }
  115.     virtual string GetKey(void) const { 
  116.         return m_Feat->GetData().GetKey(CSeqFeatData::eVocabulary_genbank);
  117.     }
  119. protected:
  121.     // constructor
  122.     CFeatureItemBase(const CSeq_feat& feat, CBioseqContext& ctx,
  123.                      const CSeq_loc* loc = 0);
  125.     virtual void x_AddQuals(CBioseqContext& ctx) = 0;
  126.     virtual void x_FormatQuals(CFlatFeature& ff) const = 0;
  128.     CConstRef<CSeq_feat>    m_Feat;
  129.     CConstRef<CSeq_loc>     m_Loc;
  130. };
  133. class CFeatureItem : public CFeatureItemBase
  134. {
  135. public:
  136.     enum EMapped
  137.     {
  138.         eMapped_not_mapped,
  139.         eMapped_from_genomic,
  140.         eMapped_from_cdna,
  141.         eMapped_from_prot
  142.     };
  144.     // constructors
  145.     CFeatureItem(const CSeq_feat& feat, CBioseqContext& ctx,
  146.         const CSeq_loc* loc, EMapped mapped = eMapped_not_mapped);
  148.     // fetaure key (name)
  149.     string GetKey(void) const;
  151.     // mapping
  152.     bool IsMapped           (void) const { return m_Mapped != eMapped_not_mapped;   }
  153.     bool IsMappedFromGenomic(void) const { return m_Mapped == eMapped_from_genomic; }
  154.     bool IsMappedFromCDNA   (void) const { return m_Mapped == eMapped_from_cdna;    }
  155.     bool IsMappedFromProt   (void) const { return m_Mapped == eMapped_from_prot;    }
  157. private:
  158.     void x_GatherInfo(CBioseqContext& ctx);
  159.     //void x_FixLocation(CBioseqContext& ctx);
  161.     // qualifier collection
  162.     void x_AddQuals(CBioseqContext& ctx);
  163.     void x_AddQuals(const CCdregion& cds)  const;
  164.     void x_AddQuals(const CProt_ref& prot) const;
  165.     void x_AddGeneQuals(const CSeq_feat& gene, CScope& scope) const;
  166.     void x_AddCdregionQuals(const CSeq_feat& cds, CBioseqContext& ctx,
  167.         bool& pseudo, bool& had_prot_desc) const;
  168.     const CProt_ref* x_AddProteinQuals(CBioseq_Handle& prot) const;
  169.     void x_AddProductIdQuals(CBioseq_Handle& prod, EFeatureQualifier slot) const;
  170.     void x_AddRnaQuals(const CSeq_feat& feat, CBioseqContext& ctx,
  171.         bool& pseudo) const;
  172.     void x_AddProtQuals(const CSeq_feat& feat, CBioseqContext& ctx,
  173.         bool& pseudo, bool& had_prot_desc, string& precursor_comment) const;
  174.     void x_AddRegionQuals(const CSeq_feat& feat, CBioseqContext& ctx) const;
  175.     void x_AddQuals(const CGene_ref& gene) const;
  176.     void x_AddExtQuals(const CSeq_feat::TExt& ext) const;
  177.     void x_AddGoQuals(const CUser_object& uo) const;
  178.     void x_AddExceptionQuals(CBioseqContext& ctx) const;
  179.     void x_ImportQuals(const CSeq_feat::TQual& quals) const;
  180.     void x_CleanQuals(void) const;
  181.     const CFlatStringQVal* x_GetStringQual(EFeatureQualifier slot) const;
  182.     // feature table quals
  183.     typedef vector< CRef<CFormatQual> > TQualVec;
  184.     void x_AddFTableQuals(CBioseqContext& ctx) const;
  185.     bool x_AddFTableGeneQuals(const CSeqFeatData::TGene& gene) const;
  186.     void x_AddFTableRnaQuals(const CSeq_feat& feat, CBioseqContext& ctx) const;
  187.     void x_AddFTableCdregionQuals(const CSeq_feat& feat, CBioseqContext& ctx) const;
  188.     void x_AddFTableProtQuals(const CSeq_feat& prot) const;
  189.     void x_AddFTableRegionQuals(const CSeqFeatData::TRegion& region) const;
  190.     void x_AddFTableBondQuals(const CSeqFeatData::TBond& bond) const;
  191.     void x_AddFTableSiteQuals(const CSeqFeatData::TSite& site) const;
  192.     void x_AddFTablePsecStrQuals(const CSeqFeatData::TPsec_str& psec_str) const;
  193.     void x_AddFTablePsecStrQuals(const CSeqFeatData::THet& het) const;
  194.     void x_AddFTableBiosrcQuals(const CBioSource& src) const;
  195.     void x_AddFTableDbxref(const CSeq_feat::TDbxref& dbxref) const;
  196.     void x_AddFTableExtQuals(const CSeq_feat::TExt& ext) const;
  197.     void x_AddFTableQual(const string& name, const string& val = kEmptyStr) const {
  198.         CFormatQual::EStyle style = val.empty() ? CFormatQual::eEmpty : CFormatQual::eQuoted;
  199.         m_FTableQuals.push_back(CRef<CFormatQual>(new CFormatQual(name, val, style)));
  200.     }
  201.     
  202.     // typdef
  203.     typedef CQualContainer<EFeatureQualifier> TQuals;
  204.     typedef TQuals::iterator TQI;
  205.     typedef TQuals::const_iterator TQCI;
  207.     
  208.     // qualifiers container
  209.     void x_AddQual(EFeatureQualifier slot, const IFlatQVal* value) const {
  210.         m_Quals.AddQual(slot, value);
  211.     }
  212.     void x_RemoveQuals(EFeatureQualifier slot) const {
  213.         m_Quals.RemoveQuals(slot);
  214.     }
  215.     bool x_HasQual(EFeatureQualifier slot) const { 
  216.         return m_Quals.HasQual(slot);
  217.     }
  218.     pair<TQCI, TQCI> x_GetQual(EFeatureQualifier slot) const {
  219.         return const_cast<const TQuals&>(m_Quals).GetQuals(slot);
  220.     }
  221.     void x_DropIllegalQuals(void) const;
  223.     // format
  224.     void x_FormatQuals(CFlatFeature& ff) const;
  225.     void x_FormatNoteQuals(CFlatFeature& ff) const;
  226.     void x_FormatQual(EFeatureQualifier slot, const string& name,
  227.         CFlatFeature::TQuals& qvec, IFlatQVal::TFlags flags = 0) const;
  228.     void x_FormatNoteQual(EFeatureQualifier slot, const string& name, 
  229.         CFlatFeature::TQuals& qvec, IFlatQVal::TFlags flags = 0) const 
  230.         { x_FormatQual(slot, name, qvec, flags | IFlatQVal::fIsNote); }
  232.     // data
  233.     mutable CSeqFeatData::ESubtype m_Type;
  234.     mutable TQuals                 m_Quals;
  235.     mutable TQualVec               m_FTableQuals;
  236.     EMapped                        m_Mapped;
  237. };
  240. class CSourceFeatureItem : public CFeatureItemBase
  241. {
  242. public:
  243.     typedef CRange<TSeqPos> TRange;
  245.     CSourceFeatureItem(const CBioSource& src, TRange range, CBioseqContext& ctx);
  246.     CSourceFeatureItem(const CSeq_feat& feat, CBioseqContext& ctx,
  247.                            const CSeq_loc* loc = 0)
  248.         : CFeatureItemBase(feat, ctx, loc), m_WasDesc(false)
  249.     {
  250.         x_GatherInfo(ctx);
  251.     }
  252.     CSourceFeatureItem(const CMappedFeat& feat, CBioseqContext& ctx,
  253.                            const CSeq_loc* loc = 0)
  254.         : CFeatureItemBase(feat.GetOriginalFeature(), ctx,
  255.                            loc ? loc : &feat.GetLocation()),
  256.           m_WasDesc(false)
  257.     {
  258.         x_GatherInfo(ctx);
  259.     }
  261.     bool WasDesc(void) const { return m_WasDesc; }
  262.     const CBioSource& GetSource(void) const {
  263.         return m_Feat->GetData().GetBiosrc();
  264.     }
  265.     string GetKey(void) const { return "source"; }
  267. private:
  268.     void x_GatherInfo(CBioseqContext& ctx) {
  269.         x_AddQuals(ctx);
  270.     }
  272.     void x_AddQuals(CBioseqContext& ctx);
  273.     void x_AddQuals(const CBioSource& src, CBioseqContext& ctx) const;
  274.     void x_AddQuals(const COrg_ref& org, CBioseqContext& ctx) const;
  276.     // XXX - massage slot as necessary and perhaps sanity-check value's type
  277.     void x_AddQual (ESourceQualifier slot, const IFlatQVal* value) const {
  278.         m_Quals.AddQual(slot, value); 
  279.     }
  281.     void x_FormatQuals(CFlatFeature& ff) const;
  282.     void x_FormatGBNoteQuals(CFlatFeature& ff) const;
  283.     void x_FormatNoteQuals(CFlatFeature& ff) const;
  284.     void x_FormatQual(ESourceQualifier slot, const string& name,
  285.         CFlatFeature::TQuals& qvec, IFlatQVal::TFlags flags = 0) const {
  286.             bool add_period = false;
  287.             x_FormatQual(slot, name, qvec, add_period, flags);
  288.     }
  289.     void x_FormatQual(ESourceQualifier slot, const string& name,
  290.         CFlatFeature::TQuals& qvec, bool& add_period,
  291.         IFlatQVal::TFlags flags = 0) const;
  292.     void x_FormatNoteQual(ESourceQualifier slot, const string& name,
  293.             CFlatFeature::TQuals& qvec, bool& add_period,
  294.             IFlatQVal::TFlags flags = 0) const {
  295.         x_FormatQual(slot, name, qvec, add_period, flags | IFlatQVal::fIsNote); 
  296.     }
  298.     typedef CQualContainer<ESourceQualifier> TQuals;
  299.     typedef TQuals::const_iterator           TQCI;
  301.     bool           m_WasDesc;
  302.     mutable TQuals m_Quals;
  303. };
  306. END_SCOPE(objects)
  307. END_NCBI_SCOPE
  309. /*
  310. * ===========================================================================
  311. *
  312. * $Log: feature_item.hpp,v $
  313. * Revision 1000.1  2004/06/01 19:39:30  gouriano
  314. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.16
  315. *
  316. * Revision 1.16  2004/05/19 14:42:38  shomrat
  317. * + x_DropIllegalQuals
  318. *
  319. * Revision 1.15  2004/05/07 15:21:50  shomrat
  320. * + Helper function x_GetStringQual(..)
  321. *
  322. * Revision 1.14  2004/05/06 17:41:38  shomrat
  323. * Fixes to feature formatting
  324. *
  325. * Revision 1.13  2004/04/22 15:36:00  shomrat
  326. * Changes in context
  327. *
  328. * Revision 1.12  2004/04/13 16:42:24  shomrat
  329. * Additions due to GBSeq format
  330. *
  331. * Revision 1.11  2004/04/07 14:25:03  shomrat
  332. * Added FTable format methods
  333. *
  334. * Revision 1.10  2004/03/31 15:59:54  ucko
  335. * CFeatureItem::x_GetQual: make sure to call the const version of
  336. * GetQuals to fix WorkShop build errors.
  337. *
  338. * Revision 1.9  2004/03/30 20:26:32  shomrat
  339. * Separated quals container from feature class
  340. *
  341. * Revision 1.8  2004/03/25 20:27:52  shomrat
  342. * moved constructor body to .cpp file
  343. *
  344. * Revision 1.7  2004/03/18 15:27:25  shomrat
  345. * + GetId for ftable format
  346. *
  347. * Revision 1.6  2004/03/08 21:00:48  shomrat
  348. * Exception qualifiers gathering
  349. *
  350. * Revision 1.5  2004/03/05 18:49:26  shomrat
  351. * enhancements to qualifier collection and formatting
  352. *
  353. * Revision 1.4  2004/02/11 22:48:18  shomrat
  354. * override GetKey
  355. *
  356. * Revision 1.3  2004/02/11 16:38:51  shomrat
  357. * added methods for gathering and formatting of source features
  358. *
  359. * Revision 1.2  2004/01/14 15:57:23  shomrat
  360. * removed commented code
  361. *
  362. * Revision 1.1  2003/12/17 19:46:43  shomrat
  363. * Initial revision (adapted from flat lib)
  364. *
  365. *
  366. * ===========================================================================
  367. */
  369. #endif  /* OBJTOOLS_FORMAT_ITEMS___FLAT_FEATURE__HPP */