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

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

生物技术

开发平台：

C/C++

comment_item.cpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: comment_item.cpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 19:43:50  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.8
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. /*  $Id: comment_item.cpp,v 1000.2 2004/06/01 19:43:50 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 -- comment item implementation
  39. *
  40. */
  41. #include <ncbi_pch.hpp>
  42. #include <corelib/ncbistd.hpp>
  44. #include <objects/seqfeat/Seq_feat.hpp>
  45. #include <objects/seq/Bioseq.hpp>
  46. #include <objects/seq/Seq_inst.hpp>
  47. #include <objects/seq/Seq_ext.hpp>
  48. #include <objects/seq/Delta_ext.hpp>
  49. #include <objects/seq/Delta_seq.hpp>
  50. #include <objects/seq/Seq_literal.hpp>
  51. #include <objects/seq/Seq_hist.hpp>
  52. #include <objects/seq/Seq_hist_rec.hpp>
  53. #include <objects/seq/Seqdesc.hpp>
  54. #include <objects/seq/MolInfo.hpp>
  55. #include <objects/seqfeat/BioSource.hpp>
  56. #include <objects/seqfeat/Org_ref.hpp>
  57. #include <objects/general/User_object.hpp>
  58. #include <objects/general/User_field.hpp>
  59. #include <objects/general/Object_id.hpp>
  60. #include <objects/general/Date.hpp>
  61. #include <objects/general/Dbtag.hpp>
  62. #include <objmgr/seqdesc_ci.hpp>
  64. #include <objtools/format/formatter.hpp>
  65. #include <objtools/format/text_ostream.hpp>
  66. #include <objtools/format/items/comment_item.hpp>
  67. #include <objtools/format/context.hpp>
  68. #include "utils.hpp"
  71. BEGIN_NCBI_SCOPE
  72. BEGIN_SCOPE(objects)
  75. // static variables initialization
  76. bool CCommentItem::sm_FirstComment = true;
  77. const string CCommentItem::kNsAreGaps = "The strings of n's in this record " 
  78. "represent gaps between contigs, and the length of each string corresponds " 
  79. "to the length of the gap.";
  82. /////////////////////////////////////////////////////////////////////////////
  83. //
  84. //  CCommentItem
  86. CCommentItem::CCommentItem(CBioseqContext& ctx) :
  87.     CFlatItem(&ctx), m_First(false)
  88. {
  89.     swap(m_First, sm_FirstComment);
  90. }
  93. CCommentItem::CCommentItem
  94. (const string& comment,
  95.  CBioseqContext& ctx,
  96.  const CSerialObject* obj) :
  97.     CFlatItem(&ctx), m_Comment(comment)
  98. {
  99.     swap(m_First, sm_FirstComment);
  100.     if ( obj != 0 ) {
  101.         x_SetObject(*obj);
  102.     }
  103. }
  105.     
  106. CCommentItem::CCommentItem(const CSeqdesc&  desc, CBioseqContext& ctx) :
  107.     CFlatItem(&ctx)
  108. {
  109.     swap(m_First, sm_FirstComment);
  110.     x_SetObject(desc);
  111.     x_GatherInfo(ctx);
  112.     if ( m_Comment.empty() ) {
  113.         x_SetSkip();
  114.     }
  115. }
  118. void CCommentItem::Format
  119. (IFormatter& formatter,
  120.  IFlatTextOStream& text_os) const
  121. {
  122.     formatter.FormatComment(*this, text_os);
  123. }
  126. string CCommentItem::GetStringForTPA
  127. (const CUser_object& uo,
  128.  CBioseqContext& ctx)
  129. {
  130.     static const string tpa_string = 
  131.         "THIRD PARTY ANNOTATION DATABASE: This TPA record uses data from DDBJ/EMBL/GenBank ";
  133.     if ( !ctx.IsTPA()  ||  ctx.IsRefSeq() ) {
  134.         return kEmptyStr;
  135.     }
  136.     if ( !uo.CanGetType()  ||  !uo.GetType().IsStr()  ||  
  137.          uo.GetType().GetStr() != "TpaAssembly" ) {
  138.         return kEmptyStr;
  139.     }
  140.     const CSeq_inst& inst = ctx.GetHandle().GetInst();
  141.     if ( inst.CanGetHist()  &&  inst.GetHist().CanGetAssembly() ) {
  142.         return kEmptyStr;
  143.     }
  145.     string id;
  146.     vector<string> accessions;
  147.     ITERATE (CUser_object::TData, curr, uo.GetData()) {
  148.         const CUser_field& uf = **curr;
  149.         if ( !uf.CanGetData()  ||  !uf.GetData().IsFields() ) {
  150.             continue;
  151.         }
  153.         ITERATE (CUser_field::C_Data::TFields, ufi, uf.GetData().GetFields()) {
  154.             if( !(*ufi)->CanGetData()  ||  !(*ufi)->GetData().IsStr()  ||
  155.                 !(*ufi)->CanGetLabel() ) {
  156.                 continue;
  157.             }
  158.             const CObject_id& oid = (*ufi)->GetLabel();
  159.             if ( oid.IsStr()  &&  
  160.                  (NStr::CompareNocase(oid.GetStr(), "accession") == 0) ) {
  161.                 string acc = (*ufi)->GetData().GetStr();
  162.                 if ( !acc.empty() ) {
  163.                     accessions.push_back(NStr::ToUpper(acc));
  164.                 }
  165.             }
  166.         }
  167.     }
  168.     if ( accessions.empty() ) {
  169.         return kEmptyStr;
  170.     }
  172.     CNcbiOstrstream text;
  173.     text << tpa_string << ((accessions.size() > 1) ? "entries " : "entry ");
  175.     size_t size = accessions.size();
  176.     size_t last = size - 1;
  178.     for ( size_t i = 0; i < size; ) {
  179.         text << accessions[i];
  180.         ++i;
  181.         if ( i < size ) {
  182.             text << ((i == last) ? " and " : ", ");
  183.         }
  184.     }
  186.     return CNcbiOstrstreamToString(text);
  187. }
  190. string CCommentItem::GetStringForBankIt(const CUser_object& uo)
  191. {
  192.     if ( !uo.CanGetType()  ||  !uo.GetType().IsStr()  ||
  193.          uo.GetType().GetStr() != "Submission" ) {
  194.         return kEmptyStr;
  195.     }
  197.     const string* uvc = 0, *bic = 0;
  198.     if ( uo.HasField("UniVecComment") ) {
  199.         const CUser_field& uf = uo.GetField("UniVecComment");
  200.         if ( uf.CanGetData()  &&  uf.GetData().IsStr() ) {
  201.             uvc = &(uf.GetData().GetStr());
  202.         } 
  203.     }
  204.     if ( uo.HasField("AdditionalComment") ) {
  205.         const CUser_field& uf = uo.GetField("AdditionalComment");
  206.         if ( uf.CanGetData()  &&  uf.GetData().IsStr() ) {
  207.             bic = &(uf.GetData().GetStr());
  208.         } 
  209.     }
  211.     CNcbiOstrstream text;
  212.     if ( uvc != 0  &&  bic != 0 ) {
  213.         text << "Vector Explanation: " << *uvc << "~Bankit Comment: " << *bic;
  214.     } else if ( uvc != 0 ) {
  215.         text << "Vector Explanation: " << *uvc;
  216.     } else if ( bic != 0 ) {
  217.          text << "Bankit Comment: " << *bic;
  218.     }
  220.     return CNcbiOstrstreamToString(text);
  221. }
  224. CCommentItem::TRefTrackStatus CCommentItem::GetRefTrackStatus
  225. (const CUser_object& uo,
  226.  string* st)
  227. {
  228.     TRefTrackStatus retval = eRefTrackStatus_Unknown;
  229.     if ( st != 0 ) {
  230.         st->erase();
  231.     }
  232.     if ( !uo.HasField("Status") ) {
  233.         return retval;
  234.     }
  236.     const CUser_field& field = uo.GetField("Status");
  237.     if ( field.GetData().IsStr() ) {
  238.         string status = field.GetData().GetStr();
  239.         if ( status == "Inferred" ) { 
  240.             retval = eRefTrackStatus_Inferred;
  241.         } else if ( status == "Provisional" ) {
  242.             retval = eRefTrackStatus_Provisional;
  243.         } else if ( status == "Predicted" ) {
  244.             retval = eRefTrackStatus_Predicted;
  245.         } else if ( status == "Validated" ) {
  246.             retval = eRefTrackStatus_Validated;
  247.         } else if ( status == "Reviewed" ) {
  248.             retval = eRefTrackStatus_Reviewd;
  249.         } else if ( status == "Model" ) {
  250.             retval = eRefTrackStatus_Model;
  251.         } else if ( status == "WGS" ) {
  252.             retval = eRefTrackStatus_WGS;
  253.         }
  255.         if ( st != 0  &&  retval != eRefTrackStatus_Unknown ) {
  256.             *st = NStr::ToUpper(status);
  257.         }
  258.     }
  260.     return retval;
  261. }
  264. string CCommentItem::GetStringForRefTrack(const CUser_object& uo)
  265. {
  266.     if ( !uo.CanGetType()  ||  !uo.GetType().IsStr()  ||
  267.          uo.GetType().GetStr() != "RefGeneTracking" ) {
  268.         return kEmptyStr;
  269.     }
  271.     string status_str;
  272.     TRefTrackStatus status = GetRefTrackStatus(uo, &status_str);
  273.     if ( status == eRefTrackStatus_Unknown ) {
  274.         return kEmptyStr;
  275.     }
  277.     string collaborator;
  278.     if ( uo.HasField("Collaborator") ) {
  279.         const CUser_field& colab_field = uo.GetField("Collaborator");
  280.         if ( colab_field.GetData().IsStr() ) {
  281.             collaborator = colab_field.GetData().GetStr();
  282.         }
  283.     }
  285.     string source;
  286.     if ( uo.HasField("GenomicSource") ) {
  287.         const CUser_field& source_field = uo.GetField("GenomicSource");
  288.         if ( source_field.GetData().IsStr() ) {
  289.             source = source_field.GetData().GetStr();
  290.         }
  291.     }
  293.     CNcbiOstrstream oss;
  294.     oss << status_str << " REFSEQ: ";
  295.     switch ( status ) {
  296.     case eRefTrackStatus_Inferred:
  297.         oss << "This record is predicted by genome sequence analysis and is "
  298.             << "not yet supported by experimental evidence.";
  299.         break;
  300.     case eRefTrackStatus_Provisional:
  301.         oss << "This record has not yet been subject to final NCBI review.";
  302.         break;
  303.     case eRefTrackStatus_Predicted:
  304.         oss << "The mRNA record is supported by experimental evidence;"
  305.             << "however, the coding sequence is predicted.";
  306.         break;
  307.     case eRefTrackStatus_Validated:
  308.         oss << "This record has undergone preliminary review of the sequence,"
  309.             << "but has not yet been subject to final review.";
  310.         break;
  311.     case eRefTrackStatus_Reviewd:
  312.         oss << "This record has been curated by " 
  313.             << (collaborator.empty() ? "NCBI staff" : collaborator) << '.';
  314.         break;
  315.     case eRefTrackStatus_Model:
  316.         oss << "This record is predicted by automated computational analysis.";
  317.         break;
  318.     case eRefTrackStatus_WGS:
  319.         oss << "This record is provided to represent a collection of "
  320.             << "whole genome shotgun sequences.";
  321.         break;
  322.     default:
  323.         break;
  324.     }
  326.     if ( status != eRefTrackStatus_Reviewd  &&  !collaborator.empty() ) {
  327.         oss << "This record has been curated by " << collaborator << '.';
  328.     }
  330.     if ( !source.empty() ) {
  331.         oss << "This record is derived from an annotated genomic sequence ("
  332.             << source << ").";
  333.     }
  335.     vector < pair<const string*, bool> > assembly;
  336.     if ( uo.HasField("Assembly") ) {
  337.         const CUser_field& field = uo.GetField("Assembly");
  338.         if ( field.GetData().IsFields() ) {
  339.             ITERATE (CUser_field::C_Data::TFields, fit, field.GetData().GetFields()) {
  340.                 if ( !(*fit)->GetData().IsFields() ) {
  341.                     continue;
  342.                 }
  343.                 ITERATE (CUser_field::C_Data::TFields, it, (*fit)->GetData().GetFields()) {
  344.                     const CUser_field& uf = **it;
  345.                     if ( !uf.CanGetLabel()  ||  !uf.GetLabel().IsStr() ) {
  346.                         continue;
  347.                     }
  348.                     const string& label = uf.GetLabel().GetStr();
  349.                     if ( label == "accession"  ||  label == "name" ) {
  350.                         bool is_accn = (label == "accession");
  351.                         if ( uf.GetData().IsStr()  &&  !uf.GetData().GetStr().empty() ) {
  352.                             assembly.push_back(make_pair(&uf.GetData().GetStr(), is_accn));
  353.                         }
  354.                     }
  355.                 }
  356.             }
  357.         }
  358.     }
  359.     if ( assembly.size() > 0 ) {
  360.         oss << " The reference sequence was derived from ";
  361.         size_t assembly_size = assembly.size();
  362.         for ( size_t i = 0; i < assembly_size; ++i ) {
  363.             if ( i > 0  ) {
  364.                 oss << ((i < assembly_size - 1) ? ", " : " and ");
  365.             }
  366.             oss << *(assembly[i].first);
  367.         }
  368.         oss << '.';
  369.     }
  371.     return CNcbiOstrstreamToString(oss);
  372. }
  376. bool CCommentItem::NsAreGaps(const CBioseq_Handle& seq, CBioseqContext& ctx)
  377. {
  378.     if ( !seq.IsSetInst()  ||  !seq.IsSetInst_Ext() ) {
  379.         return false;
  380.     }
  382.     if ( ctx.GetRepr() == CSeq_inst::eRepr_delta  &&  ctx.IsWGS()  &&
  383.          seq.GetInst_Ext().IsDelta() ) {
  384.         ITERATE (CDelta_ext::Tdata, iter, seq.GetInst_Ext().GetDelta().Get()) {
  385.             const CDelta_seq& dseg = **iter;
  386.             if ( dseg.IsLiteral() ) {
  387.                 const CSeq_literal& lit = dseg.GetLiteral();
  388.                 if ( !lit.CanGetSeq_data()  &&  lit.CanGetLength()  &&
  389.                       lit.GetLength() > 0 ) {
  390.                     return true;
  391.                 }
  392.             }
  393.         }
  394.     }
  396.     return false;
  397. }
  400. string CCommentItem::GetStringForWGS(CBioseqContext& ctx)
  401. {
  402.     static const string default_str = "?";
  404.     if ( !ctx.IsWGSMaster()  ||  ctx.GetWGSMasterAccn().empty() ) {
  405.         return kEmptyStr;
  406.     }
  407.     const string& wgsaccn = ctx.GetWGSMasterAccn();
  409.     const string* taxname = 0;
  410.     for (CSeqdesc_CI it(ctx.GetHandle(), CSeqdesc::e_Source); it; ++it) {
  411.         const CBioSource& src = it->GetSource();
  412.         if ( src.CanGetOrg()  &&  src.GetOrg().CanGetTaxname() ) {
  413.             taxname = &(src.GetOrg().GetTaxname());
  414.         }
  415.     }
  417.     const string* first = 0, *last = 0;
  418.     for (CSeqdesc_CI it(ctx.GetHandle(), CSeqdesc::e_User); it; ++it) {
  419.         const CUser_object& uo = it->GetUser();
  420.         if ( uo.CanGetType()  &&  uo.GetType().IsStr()  &&
  421.              NStr::CompareNocase(uo.GetType().GetStr(), "WGSProjects") == 0 ) {
  422.             if ( uo.HasField("WGS_accession_first") ) {
  423.                 const CUser_field& uf = uo.GetField("WGS_accession_first");
  424.                 if ( uf.CanGetData()  &&  uf.GetData().IsStr() ) {
  425.                     first = &(uf.GetData().GetStr());
  426.                 }
  427.             }
  428.             if ( uo.HasField("WGS_accession_last") ) {
  429.                 const CUser_field& uf = uo.GetField("WGS_accession_last");
  430.                 if ( uf.CanGetData()  &&  uf.GetData().IsStr() ) {
  431.                     last = &(uf.GetData().GetStr());
  432.                 }
  433.             }
  434.         }
  435.     }
  437.     if ( taxname == 0  ||  taxname->empty() ) {
  438.         taxname = &default_str;
  439.     }
  440.     if ( first == 0  ||  first->empty() ) {
  441.         first = &default_str;
  442.     }
  443.     if ( last == 0  ||  last->empty() ) {
  444.         last = &default_str;
  445.     }
  447.     string version = (wgsaccn.length() == 15) ? wgsaccn.substr(4) :
  448.                                                 wgsaccn.substr(7);
  450.     CNcbiOstrstream text;
  451.     text << "The " << *taxname 
  452.          << "whole genome shotgun (WGS) project has the project accession " 
  453.          << wgsaccn << ".  This version of the project (" << version 
  454.          << ") has the accession number " << ctx.GetWGSMasterName() << ",";
  455.     if ( (*first != *last) ) {
  456.         text << " and consists of sequences " << *first << "-" << *last;
  457.     } else {
  458.         text << " and consists of sequence " << *first;
  459.     }
  461.     return CNcbiOstrstreamToString(text);
  462. }
  465. string CCommentItem::GetStringForMolinfo(const CMolInfo& mi, CBioseqContext& ctx)
  466. {
  467.     _ASSERT(mi.CanGetCompleteness());
  469.     bool is_prot = ctx.IsProt();
  471.     switch ( mi.GetCompleteness() ) {
  472.     case CMolInfo::eCompleteness_complete:
  473.         return "COMPLETENESS: full length";
  475.     case CMolInfo::eCompleteness_partial:
  476.         return "COMPLETENESS: not full length";
  478.     case CMolInfo::eCompleteness_no_left:
  479.         return (is_prot ? "COMPLETENESS: incomplete on the amino end" :
  480.                           "COMPLETENESS: incomplete on the 5' end");
  482.     case CMolInfo::eCompleteness_no_right:
  483.         return (is_prot ? "COMPLETENESS: incomplete on the carboxy end" :
  484.                           "COMPLETENESS: incomplete on the 3' end");
  486.     case CMolInfo::eCompleteness_no_ends:
  487.         return "COMPLETENESS: incomplete on both ends";
  489.     case CMolInfo::eCompleteness_has_left:
  490.         return (is_prot ? "COMPLETENESS: complete on the amino end" :
  491.                           "COMPLETENESS: complete on the 5' end");
  493.     case CMolInfo::eCompleteness_has_right:
  494.         return (is_prot ? "COMPLETENESS: complete on the carboxy end" :
  495.                           "COMPLETENESS: complete on the 3' end");
  497.     default:
  498.         return "COMPLETENESS: unknown";
  499.     }
  501.     return kEmptyStr;
  502. }
  505. string CCommentItem::GetStringForHTGS(CBioseqContext& ctx)
  506. {
  507.     SDeltaSeqSummary summary;
  508.     if ( ctx.GetRepr() == CSeq_inst::eRepr_delta ) {
  509.         GetDeltaSeqSummary(ctx.GetHandle(), summary);
  510.     }
  512.     CMolInfo::TTech tech = ctx.GetTech();
  514.     CNcbiOstrstream text;
  516.     if ( tech == CMolInfo::eTech_htgs_0 ) {
  517.         if ( summary.num_segs > 0 ) {
  518.             text << "* NOTE: This record contains " << (summary.num_gaps + 1) << " individual~"
  519.                  << "* sequencing reads that have not been assembled into~"
  520.                  << "* contigs. Runs of N are used to separate the reads~"
  521.                  << "* and the order in which they appear is completely~"
  522.                  << "* arbitrary. Low-pass sequence sampling is useful for~"
  523.                  << "* identifying clones that may be gene-rich and allows~"
  524.                  << "* overlap relationships among clones to be deduced.~"
  525.                  << "* However, it should not be assumed that this clone~"
  526.                  << "* will be sequenced to completion. In the event that~"
  527.                  << "* the record is updated, the accession number will~"
  528.                  << "* be preserved.";
  529.         }
  530.         text << "~";
  531.         text << summary.text;
  532.     } else if ( tech == CMolInfo::eTech_htgs_1 ) {
  533.         text << "* NOTE: This is a "working draft" sequence.";
  534.         if ( summary.num_segs > 0 ) {
  535.             text << " It currently~"
  536.                  << "* consists of " << (summary.num_gaps + 1) << " contigs. The true order of the pieces~"
  537.                  << "* is not known and their order in this sequence record is~"
  538.                  << "* arbitrary. Gaps between the contigs are represented as~"
  539.                  << "* runs of N, but the exact sizes of the gaps are unknown.";
  540.         }
  541.         text << "~* This record will be updated with the finished sequence~"
  542.              << "* as soon as it is available and the accession number will~"
  543.              << "* be preserved."
  544.              << "~"
  545.              << summary.text;
  546.     } else if ( tech == CMolInfo::eTech_htgs_2 ) {
  547.         text << "* NOTE: This is a "working draft" sequence.";
  548.         if ( summary.num_segs > 0 ) {
  549.             text << " It currently~* consists of " << (summary.num_gaps + 1) 
  550.                  << " contigs. Gaps between the contigs~"
  551.                  << "* are represented as runs of N. The order of the pieces~"
  552.                  << "* is believed to be correct as given, however the sizes~"
  553.                  << "* of the gaps between them are based on estimates that have~"
  554.                  << "* provided by the submittor.";
  555.         }
  556.         text << "~* This sequence will be replaced~"
  557.              << "* by the finished sequence as soon as it is available and~"
  558.              << "* the accession number will be preserved."
  559.              << "~"
  560.              << summary.text;
  561.     } else if ( !GetTechString(tech).empty() ) {
  562.         text << "Method: " << GetTechString(tech) << ".";
  563.     }
  565.     return CNcbiOstrstreamToString(text);
  566. }
  569. string CCommentItem::GetStringForModelEvidance(const SModelEvidance& me)
  570. {
  571.     CNcbiOstrstream text;
  573.     text << "MODEL " << "REFSEQ" << ":  " << "This record is predicted by "
  574.          << "automated computational analysis. This record is derived from"
  575.          << "an annotated genomic sequence (" << me.name << ")";
  576.     if ( !me.method.empty() ) {
  577.         text << " using gene prediction method: " << me.method;
  578.     }
  580.     if ( me.mrnaEv  ||  me.estEv ) {
  581.         text << ", supported by ";
  582.         if ( me.mrnaEv  &&  me.estEv ) {
  583.             text << "mRNA and EST ";
  584.         } else if ( me.mrnaEv ) {
  585.             text << "mRNA ";
  586.         } else {
  587.             text << "EST ";
  588.         }
  589.         // !!! for html we need much more !!!
  590.         text << "evidence";
  591.     }
  593.     text << "." << ExpandTildes("~Also see:~    ", eTilde_newline) 
  594.          << "Documentation" 
  595.          << ExpandTildes(" of NCBI's Annotation Process~    ", eTilde_newline);
  597.     return CNcbiOstrstreamToString(text);
  598. }
  601. /***************************************************************************/
  602. /*                                 PROTECTED                               */
  603. /***************************************************************************/
  606. void CCommentItem::x_GatherInfo(CBioseqContext& ctx)
  607. {
  608.     const CSeqdesc* desc = dynamic_cast<const CSeqdesc*>(GetObject());
  609.     if ( desc != 0 ) {
  610.         x_GatherDescInfo(*desc);
  611.         return;
  612.     }
  614.     const CSeq_feat* feat = dynamic_cast<const CSeq_feat*>(GetObject());
  615.     if ( feat != 0 ) {
  616.         x_GatherFeatInfo(*feat, ctx);
  617.     }
  618. }
  621. void CCommentItem::x_GatherDescInfo(const CSeqdesc& desc)
  622. {
  623.     string prefix, str, suffix;
  624.     switch ( desc.Which() ) {
  625.     case CSeqdesc::e_Comment:
  626.         {{
  627.             str = desc.GetComment();
  628.         }}
  629.         break;
  631.     case CSeqdesc::e_Maploc:
  632.         {{
  633.             const CDbtag& dbtag = desc.GetMaploc();
  634.             if ( dbtag.CanGetTag() ) {
  635.                 const CObject_id& oid = dbtag.GetTag();
  636.                 if ( oid.IsStr() ) {
  637.                     prefix = "Map location: ";
  638.                     str = oid.GetStr();
  639.                 } else if ( oid.IsId()  &&  dbtag.CanGetDb() ) {
  640.                     prefix = "Map location: (Database ";
  641.                     str = dbtag.GetDb();
  642.                     suffix = "; id # " + NStr::IntToString(oid.GetId()) + ").";
  643.                 }
  644.             }
  645.         }}
  646.         break;
  648.     case CSeqdesc::e_Region:
  649.         {{
  650.             prefix = "Region: ";
  651.             str = desc.GetRegion();
  652.         }}
  653.         break;
  654.     default:
  655.         break;
  656.     }
  658.     if ( str.empty() ) {
  659.         return;
  660.     }
  661.     x_SetCommentWithURLlinks(prefix, str, suffix);
  662.     
  663. }
  666. void CCommentItem::x_GatherFeatInfo(const CSeq_feat&, CBioseqContext&)
  667. {
  668.     // !!!
  669. }
  672. void CCommentItem::x_SetSkip(void)
  673. {
  674.     CFlatItem::x_SetSkip();
  675.     swap(m_First, sm_FirstComment);
  676. }
  679. void CCommentItem::x_SetCommentWithURLlinks
  680. (const string& prefix,
  681.  const string& str,
  682.  const string& suffix)
  683. {
  684.     // !!! test for html - find links within the comment string
  685.     string comment = ExpandTildes(prefix + str + suffix, eTilde_newline);
  686.     size_t pos = comment.find_last_not_of(" ntr");
  687.     if ( pos != NPOS ) {
  688.         comment.erase(pos + 1);
  689.     }
  690.     if ( NStr::EndsWith(str, "..")  &&  !NStr::EndsWith(str, "...") ) {
  691.         comment.erase(str.length() - 1);
  692.     }
  693.     if ( !NStr::EndsWith(str, ".") ) {
  694.         comment += ".";
  695.     }
  696.     
  697.     m_Comment =  comment;
  698. }
  701. /////////////////////////////////////////////////////////////////////////////
  702. //
  703. // Derived Classes
  705. // --- CGenomeAnnotComment
  707. CGenomeAnnotComment::CGenomeAnnotComment
  708. (CBioseqContext& ctx,
  709.  const string& build_num) :
  710.     CCommentItem(ctx), m_GenomeBuildNumber(build_num)
  711. {
  712.     x_GatherInfo(ctx);
  713. }
  716. void CGenomeAnnotComment::x_GatherInfo(CBioseqContext&)
  717. {
  718.     CNcbiOstrstream text;
  720.     text << "GENOME ANNOTATION " << "REFSEQ" << ":  ";
  721.     if ( !m_GenomeBuildNumber.empty() ) {
  722.          text << "Features on this sequence have been produced for build "
  723.               << m_GenomeBuildNumber << " of the NCBI's genome annotation"
  724.               << " [see " << "documentation" << "].";
  725.     } else {
  726.         text << "NCBI contigs are derived from assembled genomic sequence data."
  727.              << "~Also see:~    " << "Documentation" 
  728.              << " of NCBI's Annotation Process~ ";
  729.     }
  730.     
  731.     x_SetComment(ExpandTildes(CNcbiOstrstreamToString(text), eTilde_newline));
  732. }
  735. // --- CHistComment
  737. CHistComment::CHistComment
  738. (EType type,
  739.  const CSeq_hist& hist,
  740.  CBioseqContext& ctx) : 
  741.     CCommentItem(ctx), m_Type(type), m_Hist(&hist)
  742. {
  743.     x_GatherInfo(ctx);
  744.     m_Hist.Reset();
  745. }
  748. string s_CreateHistCommentString
  749. (const string& prefix,
  750.  const string& suffix,
  751.  const CSeq_hist_rec& hist)
  752. {
  753.     _ASSERT(hist.CanGetDate());
  754.     _ASSERT(hist.CanGetIds());
  756.     string date;
  757.     hist.GetDate().GetDate(&date, "%3N %2D, %4Y");
  759.     vector<int> gis;
  760.     ITERATE (CSeq_hist_rec::TIds, id, hist.GetIds()) {
  761.         if ( (*id)->IsGi() ) {
  762.             gis.push_back((*id)->GetGi());
  763.         }
  764.     }
  766.     CNcbiOstrstream text;
  768.     text << prefix << ((gis.size() > 1) ? " or before " : " ") << date 
  769.          << ' ' << suffix;
  771.     if ( gis.empty() ) {
  772.         text << " gi:?";
  773.         return CNcbiOstrstreamToString(text);
  774.     }
  776.     for ( size_t count = 0; count < gis.size(); ++count ) {
  777.         if ( count != 0 ) {
  778.             text << ",";
  779.         }
  780.         text << " gi:" << NStr::IntToString(gis[count]);
  781.     }
  782.     text << '.';
  784.     return CNcbiOstrstreamToString(text);
  785. }
  787. void CHistComment::x_GatherInfo(CBioseqContext&)
  788. {
  789.     _ASSERT(m_Hist);
  791.     switch ( m_Type ) {
  792.     case eReplaced_by:
  793.         x_SetComment(s_CreateHistCommentString(
  794.             "[WARNING] On",
  795.             "this sequence was replaced by a newer version",
  796.             m_Hist->GetReplaced_by()));
  797.         break;
  798.     case eReplaces:
  799.         x_SetComment(s_CreateHistCommentString(
  800.             "On",
  801.             "this sequence version replaced",
  802.             m_Hist->GetReplaces()));
  803.         break;
  804.     }
  805. }
  808. // --- CGsdbComment
  810. CGsdbComment::CGsdbComment(const CDbtag& dbtag, CBioseqContext& ctx) :
  811.     CCommentItem(ctx), m_Dbtag(&dbtag)
  812. {
  813.     x_GatherInfo(ctx);
  814. }
  817. void CGsdbComment::x_GatherInfo(CBioseqContext&)
  818. {
  819.     x_SetComment("GSDB:S:" + m_Dbtag->GetTag().GetId());
  820. }
  823. // --- CLocalIdComment
  825. CLocalIdComment::CLocalIdComment(const CObject_id& oid, CBioseqContext& ctx) :
  826.     CCommentItem(ctx), m_Oid(&oid)
  827. {
  828.     x_GatherInfo(ctx);
  829. }
  832. void CLocalIdComment::x_GatherInfo(CBioseqContext&)
  833. {
  834.     CNcbiOstrstream msg;
  836.     switch ( m_Oid->Which() ) {
  837.     case CObject_id::e_Id:
  838.         msg << "LocalID: " << m_Oid->GetId();    
  839.         break;
  840.     case CObject_id::e_Str:
  841.         if ( m_Oid->GetStr().length() < 100 ) {
  842.             msg << "LocalID: " << m_Oid->GetStr();
  843.         } else {
  844.             msg << "LocalID string too large";
  845.         }
  846.         break;
  847.     default:
  848.         break;
  849.     }
  850.     x_SetComment(CNcbiOstrstreamToString(msg));
  851. }
  854. END_SCOPE(objects)
  855. END_NCBI_SCOPE
  858. /*
  859. * ===========================================================================
  860. *
  861. * $Log: comment_item.cpp,v $
  862. * Revision 1000.2  2004/06/01 19:43:50  gouriano
  863. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.8
  864. *
  865. * Revision 1.8  2004/05/21 21:42:54  gorelenk
  866. * Added PCH ncbi_pch.hpp
  867. *
  868. * Revision 1.7  2004/05/06 17:45:43  shomrat
  869. * + CLocalIdComment
  870. *
  871. * Revision 1.6  2004/04/22 15:51:13  shomrat
  872. * Changes in context
  873. *
  874. * Revision 1.5  2004/04/13 16:45:22  shomrat
  875. * Fixed comment cleanup
  876. *
  877. * Revision 1.4  2004/03/26 17:22:51  shomrat
  878. * Minor fixes to comment string
  879. *
  880. * Revision 1.3  2004/03/05 18:44:05  shomrat
  881. * fixed RefTRack comments
  882. *
  883. * Revision 1.2  2003/12/18 17:43:31  shomrat
  884. * context.hpp moved
  885. *
  886. * Revision 1.1  2003/12/17 20:18:17  shomrat
  887. * Initial Revision (adapted from flat lib)
  888. *
  889. *
  890. * ===========================================================================
  891. */