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

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

生物技术

开发平台：

C/C++

locus_item.cpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: locus_item.cpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 19:45:04  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.9
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. /*  $Id: locus_item.cpp,v 1000.2 2004/06/01 19:45:04 gouriano Exp $
  11. * ===========================================================================
  12. *
  13. *                            PUBLIC DOMAIN NOTICE
  14. *               National Center for Biotechnology Information
  15. *
  16. *  This software/database is a "United States Government Work" under the
  17. *  terms of the United States Copyright Act.  It was written as part of
  18. *  the author's official duties as a United States Government employee and
  19. *  thus cannot be copyrighted.  This software/database is freely available
  20. *  to the public for use. The National Library of Medicine and the U.S.
  21. *  Government have not placed any restriction on its use or reproduction.
  22. *
  23. *  Although all reasonable efforts have been taken to ensure the accuracy
  24. *  and reliability of the software and data, the NLM and the U.S.
  25. *  Government do not and cannot warrant the performance or results that
  26. *  may be obtained by using this software or data. The NLM and the U.S.
  27. *  Government disclaim all warranties, express or implied, including
  28. *  warranties of performance, merchantability or fitness for any particular
  29. *  purpose.
  30. *
  31. *  Please cite the author in any work or product based on this material.
  32. *
  33. * ===========================================================================
  34. *
  35. * Author:  Mati Shomrat, NCBI
  36. *
  37. * File Description:
  38. *   flat-file generator -- locus item implementation
  39. *
  40. */
  41. #include <ncbi_pch.hpp>
  42. #include <corelib/ncbistd.hpp>
  44. #include <objects/general/Date.hpp>
  45. #include <objects/seq/Bioseq.hpp>
  46. #include <objects/seq/MolInfo.hpp>
  47. #include <objects/seqloc/Textseq_id.hpp>
  48. #include <objects/seqblock/GB_block.hpp>
  49. #include <objects/seqblock/EMBL_block.hpp>
  50. #include <objects/seqblock/SP_block.hpp>
  51. #include <objects/seqblock/PDB_block.hpp>
  52. #include <objects/seqblock/PDB_replace.hpp>
  53. #include <objects/seqfeat/BioSource.hpp>
  54. #include <objects/seqfeat/Org_ref.hpp>
  55. #include <objects/seqfeat/OrgName.hpp>
  56. #include <objects/seqfeat/SubSource.hpp>
  58. #include <objmgr/scope.hpp>
  59. #include <objmgr/seqdesc_ci.hpp>
  60. #include <objmgr/feat_ci.hpp>
  61. #include <objmgr/bioseq_handle.hpp>
  62. #include <objmgr/util/sequence.hpp>
  64. #include <objtools/format/formatter.hpp>
  65. #include <objtools/format/text_ostream.hpp>
  66. #include <objtools/format/items/locus_item.hpp>
  67. #include <objtools/format/context.hpp>
  68. #include "utils.hpp"
  71. BEGIN_NCBI_SCOPE
  72. BEGIN_SCOPE(objects)
  73. USING_SCOPE(sequence);
  76. CLocusItem::CLocusItem(CBioseqContext& ctx) :
  77.     CFlatItem(&ctx),
  78.     m_Length(0), m_Biomol(CMolInfo::eBiomol_unknown), m_Date("01-JAN-1900")
  79. {
  80.    x_GatherInfo(ctx);
  81. }
  84. void CLocusItem::Format
  85. (IFormatter& formatter,
  86.  IFlatTextOStream& text_os) const
  87. {
  88.     formatter.FormatLocus(*this, text_os); 
  89. }
  92. const string& CLocusItem::GetName(void) const
  93. {
  94.     return m_Name;
  95. }
  98. size_t CLocusItem::GetLength(void) const
  99. {
  100.     return m_Length;
  101. }
  104. CLocusItem::TStrand CLocusItem::GetStrand(void) const
  105. {
  106.     return m_Strand;
  107. }
  110. CLocusItem::TBiomol CLocusItem::GetBiomol(void) const
  111. {
  112.     return m_Biomol;
  113. }
  116. CLocusItem::TTopology CLocusItem::GetTopology (void) const
  117. {
  118.     return m_Topology;
  119. }
  122. const string& CLocusItem::GetDivision(void) const
  123. {
  124.     return m_Division;
  125. }
  128. const string& CLocusItem::GetDate(void) const
  129. {
  130.     return m_Date;
  131. }
  134. /***************************************************************************/
  135. /*                                  PRIVATE                                */
  136. /***************************************************************************/
  139. void CLocusItem::x_GatherInfo(CBioseqContext& ctx)
  140. {
  141.     CSeqdesc_CI mi_desc(ctx.GetHandle(), CSeqdesc::e_Molinfo);
  142.     if ( mi_desc ) {
  143.         x_SetObject(mi_desc->GetMolinfo());
  144.     }
  146.     // NB: order of execution is important, as some values depend on others
  147.     x_SetName(ctx);
  148.     x_SetLength(ctx);
  149.     x_SetBiomol(ctx);   // must come befoer x_SetStrand
  150.     x_SetStrand(ctx);
  151.     x_SetTopology(ctx);
  152.     x_SetDivision(ctx);
  153.     x_SetDate(ctx);
  154. }
  157. // Name
  159. void CLocusItem::x_SetName(CBioseqContext& ctx)
  160. {
  161.     CBioseq_Handle::TBioseqCore seq  = ctx.GetHandle().GetBioseqCore();
  163.     CConstRef<CSeq_id> id = FindBestChoice(seq->GetId(), CSeq_id::Score);
  164.     const CTextseq_id* tsid = id->GetTextseq_Id();
  165.     if ( tsid  &&  tsid->CanGetName() ) {
  166.         m_Name = tsid->GetName();
  167.     }
  168.     if ( m_Name.empty()  ||  x_NameHasBadChars(m_Name) ) {
  169.         m_Name = id->GetSeqIdString();
  170.     }
  171. }
  174. bool CLocusItem::x_NameHasBadChars(const string& name) const
  175. {
  176.     ITERATE(string, iter, name) {
  177.         if ( !isalnum(*iter) ) {
  178.             return true;
  179.         }
  180.     }
  181.     return false;
  182. }
  185. // Length
  187. void CLocusItem::x_SetLength(CBioseqContext& ctx)
  188. {
  189.     m_Length = sequence::GetLength(ctx.GetLocation(), &ctx.GetScope());
  190. }
  193. // Strand
  195. void CLocusItem::x_SetStrand(CBioseqContext& ctx)
  196. {
  197.     const CBioseq_Handle& bsh = ctx.GetHandle();
  198.     
  199.     CSeq_inst::TMol bmol = bsh.IsSetInst_Mol() ?
  200.         bsh.GetInst_Mol() : CSeq_inst::eMol_not_set;
  202.     m_Strand = bsh.IsSetInst_Strand() ?
  203.         bsh.GetInst_Strand() : CSeq_inst::eStrand_not_set;
  204.     if ( m_Strand == CSeq_inst::eStrand_other ) {
  205.         m_Strand = CSeq_inst::eStrand_not_set;
  206.     }
  208.     // cleanup for formats other than GBSeq
  209.     if ( !ctx.Config().IsFormatGBSeq() ) {
  210.         // if ds-DNA don't show ds
  211.         if ( bmol == CSeq_inst::eMol_dna  &&  m_Strand == CSeq_inst::eStrand_ds ) {
  212.             m_Strand = CSeq_inst::eStrand_not_set;
  213.         }
  214.         
  215.         // ss-any RNA don't show ss
  216.         if ( (bmol > CSeq_inst::eMol_rna  ||  
  217.             (m_Biomol >= CMolInfo::eBiomol_mRNA     &&
  218.             m_Biomol <= CMolInfo::eBiomol_peptide))  &&
  219.             m_Strand == CSeq_inst::eStrand_ss ) {
  220.             m_Strand = CSeq_inst::eStrand_not_set;
  221.         }
  222.     }
  223. }
  226. // Biomol
  228. void CLocusItem::x_SetBiomol(CBioseqContext& ctx)
  229. {
  230.     if ( ctx.IsProt() ) {
  231.         return;
  232.     }
  234.     CSeq_inst::TMol bmol = ctx.GetHandle().GetBioseqMolType();
  235.     
  236.     if ( bmol > CSeq_inst::eMol_aa ) {
  237.         bmol = CSeq_inst::eMol_not_set;
  238.     }
  240.     const CMolInfo* molinfo = dynamic_cast<const CMolInfo*>(GetObject());
  241.     if ( molinfo  &&  molinfo->GetBiomol() <= CMolInfo::eBiomol_transcribed_RNA ) {
  242.         m_Biomol = molinfo->GetBiomol();
  243.     }
  245.     if ( m_Biomol <= CMolInfo::eBiomol_genomic ) {
  246.         if ( bmol == CSeq_inst::eMol_aa ) {
  247.             m_Biomol = CMolInfo::eBiomol_peptide;
  248.         } else if ( bmol == CSeq_inst::eMol_na ) {
  249.             m_Biomol = CMolInfo::eBiomol_unknown;
  250.         } else if ( bmol == CSeq_inst::eMol_rna ) {
  251.             m_Biomol = CMolInfo::eBiomol_pre_RNA;
  252.         } else {
  253.             m_Biomol = CMolInfo::eBiomol_genomic;
  254.         }
  255.     } else if ( m_Biomol == CMolInfo::eBiomol_other_genetic ) {
  256.         if ( bmol == CSeq_inst::eMol_rna ) {
  257.             m_Biomol = CMolInfo::eBiomol_pre_RNA;
  258.         }
  259.     }
  260. }
  263. // Topology
  265. void CLocusItem::x_SetTopology(CBioseqContext& ctx)
  266. {
  267.     const CBioseq_Handle& bsh = ctx.GetHandle();
  268.     
  269.     m_Topology = bsh.GetInst_Topology();
  270.     // an interval is always linear
  271.     if ( !ctx.GetLocation().IsWhole() ) {
  272.         m_Topology = CSeq_inst::eTopology_linear;
  273.     }
  274. }
  277. // Division
  279. void CLocusItem::x_SetDivision(CBioseqContext& ctx)
  280. {
  281.     // contig style (old genome_view flag) forces CON division
  282.     if ( ctx.DoContigStyle() ) {
  283.         m_Division = "CON";
  284.         return;
  285.     }
  286.     // "genome view" forces CON division
  287.     if ( (ctx.IsSegmented()  &&  !ctx.HasParts())  ||
  288.          (ctx.IsDelta()  &&  !ctx.IsDeltaLitOnly()) ) {
  289.         m_Division = "CON";
  290.         return;
  291.     }
  293.     const CBioseq_Handle& bsh = ctx.GetHandle();
  294.     const CBioSource* bsrc = 0;
  296.     // Find the BioSource object for this sequnece.
  297.     CSeqdesc_CI src_desc(bsh, CSeqdesc::e_Source);
  298.     if ( src_desc ) {
  299.         bsrc = &(src_desc->GetSource());
  300.     } else {
  301.         CFeat_CI feat(bsh, 0, 0, CSeqFeatData::e_Biosrc);
  302.         if ( feat ) {
  303.             bsrc = &(feat->GetData().GetBiosrc());
  304.         } else if ( ctx.IsProt() ) {
  305.             // if protein with no sources, get sources applicable to 
  306.             // DNA location of CDS
  307.             const CSeq_feat* cds = GetCDSForProduct(bsh);
  308.             if ( cds ) {
  309.                 CConstRef<CSeq_feat> nuc_fsrc = GetBestOverlappingFeat(
  310.                     cds->GetLocation(),
  311.                     CSeqFeatData::e_Biosrc,
  312.                     eOverlap_Contains,
  313.                     bsh.GetScope());
  314.                 if ( nuc_fsrc ) {
  315.                     bsrc = &(nuc_fsrc->GetData().GetBiosrc());
  316.                 } else {
  317.                     CBioseq_Handle nuc = 
  318.                         bsh.GetScope().GetBioseqHandle(cds->GetLocation());
  319.                     CSeqdesc_CI nuc_dsrc(nuc, CSeqdesc::e_Source);
  320.                     if ( nuc_dsrc ) {
  321.                         bsrc = &(nuc_dsrc->GetSource());
  322.                     }
  323.                 }
  324.             }
  325.         }
  326.     }
  328.     bool is_transgenic = false;
  330.     if ( bsrc ) {
  331.         CBioSource::TOrigin origin = bsrc->GetOrigin();
  332.         if ( bsrc->CanGetOrg() ) {
  333.             const COrg_ref& org = bsrc->GetOrg();
  334.             if ( org.CanGetOrgname()  &&  org.GetOrgname().CanGetDiv() ) {
  335.                 m_Division = org.GetOrgname().GetDiv();
  336.             }
  337.         }
  339.         ITERATE(CBioSource::TSubtype, subsource, bsrc->GetSubtype() ) {
  340.             if ( (*subsource)->CanGetSubtype()  &&
  341.                 (*subsource)->GetSubtype() == CSubSource::eSubtype_transgenic ) {
  342.                 is_transgenic = true;
  343.             }
  344.         }
  345.         
  346.         switch ( ctx.GetTech() ) {
  347.         case CMolInfo::eTech_est:
  348.             m_Division = "EST";
  349.             break;
  350.         case CMolInfo::eTech_sts:
  351.             m_Division = "STS";
  352.             break;
  353.         case CMolInfo::eTech_survey:
  354.             m_Division = "GSS";
  355.             break;
  356.         case CMolInfo::eTech_htgs_0:
  357.         case CMolInfo::eTech_htgs_1:
  358.         case CMolInfo::eTech_htgs_2:
  359.             m_Division = "HTG";
  360.             break;
  361.         case CMolInfo::eTech_htc:
  362.             m_Division = "HTC";
  363.             break;
  364.         default:
  365.             break;
  366.         }
  368.         if ( origin == CBioSource::eOrigin_synthetic  ||  is_transgenic ) {
  369.             m_Division = "SYN";
  370.         }
  372.         ITERATE( CBioseq::TId, id, bsh.GetBioseqCore()->GetId() ) {
  373.             if ( (*id)->IdentifyAccession() == CSeq_id::eAcc_patent ) {
  374.                 m_Division = "PAT";
  375.                 break;
  376.             }
  377.         }
  379.         // more complicated code for division, if necessary, goes here
  380.         
  381.         for ( CSeqdesc_CI gb_desc(bsh, CSeqdesc::e_Genbank); gb_desc; ++gb_desc ) {
  382.             const CGB_block& gb = gb_desc->GetGenbank();
  383.             if ( gb.CanGetDiv() ) {
  384.                 if ( m_Division.empty()    ||
  385.                      gb.GetDiv() == "SYN"  ||
  386.                      gb.GetDiv() == "PAT" ) {
  387.                     m_Division = gb.GetDiv();
  388.                 }
  389.             }
  390.         }
  392.         const CMolInfo* molinfo = dynamic_cast<const CMolInfo*>(GetObject());
  393.         if ( ctx.Config().IsFormatEMBL() ) {
  394.             for ( CSeqdesc_CI embl_desc(bsh, CSeqdesc::e_Embl); 
  395.                   embl_desc; 
  396.                   ++embl_desc ) {
  397.                 const CEMBL_block& embl = embl_desc->GetEmbl();
  398.                 if ( embl.CanGetDiv() ) {
  399.                     if ( embl.GetDiv() == CEMBL_block::eDiv_other  &&
  400.                          molinfo == 0 ) {
  401.                         m_Division = "HUM";
  402.                     } else {
  403.                         m_Division = embl.GetDiv();
  404.                     }
  405.                 }
  406.             }
  407.         }
  408.     }
  410.     // Set a default value (3 spaces)
  411.     if ( m_Division.empty() ) {
  412.         m_Division = "   ";
  413.     }
  414. }
  417. // Date
  419. void CLocusItem::x_SetDate(CBioseqContext& ctx)
  420. {
  421.     const CBioseq_Handle& bsh = ctx.GetHandle();
  423.     const CDate* date = x_GetDateForBioseq(bsh);
  424.     if ( date == 0 ) {
  425.         // if bioseq is product of CDS or mRNA feature, get 
  426.         // date from parent bioseq.
  427.         CBioseq_Handle parent = GetNucleotideParent(bsh);
  428.         if ( parent ) {
  429.             date = x_GetDateForBioseq(parent);
  430.         }
  431.     }
  433.     if ( date ) {
  434.         m_Date.erase();
  435.         DateToString(*date, m_Date);
  436.     }
  437. }
  440. const CDate* CLocusItem::x_GetDateForBioseq(const CBioseq_Handle& bsh) const
  441. {
  442.     const CDate* result = 0;
  444.     {{
  445.         CSeqdesc_CI desc(bsh, CSeqdesc::e_Update_date);
  446.         if ( desc ) {
  447.             result = &(desc->GetUpdate_date());
  448.         }
  449.     }}
  451.     {{
  452.         // temporarily (???) also look at genbank block entry date 
  453.         CSeqdesc_CI desc(bsh, CSeqdesc::e_Genbank);
  454.         if ( desc ) {
  455.             const CGB_block& gb = desc->GetGenbank();
  456.             if ( gb.CanGetEntry_date() ) {
  457.                 result = x_GetLaterDate(result, &gb.GetEntry_date());
  458.             }
  459.         }
  460.     }}
  462.     {{
  463.         CSeqdesc_CI desc(bsh, CSeqdesc::e_Embl);
  464.         if ( desc ) {
  465.             const CEMBL_block& embl = desc->GetEmbl();
  466.             if ( embl.CanGetCreation_date() ) {
  467.                 result = x_GetLaterDate(result, &embl.GetCreation_date());
  468.             }
  469.             if ( embl.CanGetUpdate_date() ) {
  470.                 result = x_GetLaterDate(result, &embl.GetUpdate_date());
  471.             }
  472.         }
  473.     }}
  475.     {{
  476.         CSeqdesc_CI desc(bsh, CSeqdesc::e_Sp);
  477.         if ( desc ) {
  478.             const CSP_block& sp = desc->GetSp();
  479.             if ( sp.CanGetCreated()  &&  sp.GetCreated().IsStd() ) {
  480.                 result = x_GetLaterDate(result, &sp.GetCreated());
  481.             }
  482.             if ( sp.CanGetSequpd()  &&  sp.GetSequpd().IsStd() ) {
  483.                 result = x_GetLaterDate(result, &sp.GetSequpd());
  484.             }
  485.             if ( sp.CanGetAnnotupd()  &&  sp.GetAnnotupd().IsStd() ) {
  486.                 result = x_GetLaterDate(result, &sp.GetAnnotupd());
  487.             }
  488.         }
  489.     }}
  491.     {{
  492.         CSeqdesc_CI desc(bsh, CSeqdesc::e_Pdb);
  493.         if ( desc ) {
  494.             const CPDB_block& pdb = desc->GetPdb();
  495.             if ( pdb.CanGetDeposition()  &&  pdb.GetDeposition().IsStd() ) {
  496.                 result = x_GetLaterDate(result, &pdb.GetDeposition());
  497.             }
  498.             if ( pdb.CanGetReplace() ) {
  499.                 const CPDB_replace& replace = pdb.GetReplace();
  500.                 if ( replace.CanGetDate()  &&   replace.GetDate().IsStd() ) {
  501.                     result = x_GetLaterDate(result, &replace.GetDate());
  502.                 }
  503.             }
  504.         }
  505.     }}
  507.     {{
  508.         CSeqdesc_CI desc(bsh, CSeqdesc::e_Create_date);
  509.         if ( desc ) {
  510.             result = x_GetLaterDate(result, &(desc->GetCreate_date()));
  511.         }
  512.     }}
  514.     return result;
  515. }
  518. const CDate* CLocusItem::x_GetLaterDate(const CDate* d1, const CDate* d2) const
  519. {
  520.     if ( d1 == 0 ) {
  521.         return d2;
  522.     }
  524.     if ( d2 == 0 ) {
  525.         return d1;
  526.     }
  528.     return (d1->Compare(*d2) == CDate::eCompare_after) ? d1 : d2;
  529. }
  532. END_SCOPE(objects)
  533. END_NCBI_SCOPE
  536. /*
  537. * ===========================================================================
  538. *
  539. * $Log: locus_item.cpp,v $
  540. * Revision 1000.2  2004/06/01 19:45:04  gouriano
  541. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.9
  542. *
  543. * Revision 1.9  2004/05/21 21:42:54  gorelenk
  544. * Added PCH ncbi_pch.hpp
  545. *
  546. * Revision 1.8  2004/04/22 15:58:51  shomrat
  547. * Changes in context
  548. *
  549. * Revision 1.7  2004/04/13 16:49:01  shomrat
  550. * GBSeq format changes
  551. *
  552. * Revision 1.6  2004/03/25 20:45:05  shomrat
  553. * Use handles
  554. *
  555. * Revision 1.5  2004/03/05 18:41:14  shomrat
  556. * bug fix
  557. *
  558. * Revision 1.4  2004/02/13 14:23:08  shomrat
  559. * force CON division for contig style and genome view
  560. *
  561. * Revision 1.3  2004/02/11 22:55:12  shomrat
  562. * use IsFormatEMBL method
  563. *
  564. * Revision 1.2  2003/12/18 17:43:35  shomrat
  565. * context.hpp moved
  566. *
  567. * Revision 1.1  2003/12/17 20:23:35  shomrat
  568. * Initial Revision (adapted from flat lib)
  569. *
  570. *
  571. * ===========================================================================
  572. */