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

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

生物技术

开发平台：

C/C++

gbseq_formatter.cpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: gbseq_formatter.cpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:44:34  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. /*  $Id: gbseq_formatter.cpp,v 1000.1 2004/06/01 19:44:34 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:  Aaron Ucko, NCBI
  36. *          Mati Shomrat
  37. *
  38. * File Description:
  39. *   GBseq formatting        
  40. */
  41. #include <ncbi_pch.hpp>
  42. #include <corelib/ncbistd.hpp>
  43. #include <serial/objostr.hpp>
  45. #include <objects/gbseq/GBSet.hpp>
  46. #include <objects/gbseq/GBSeq.hpp>
  47. #include <objects/gbseq/GBReference.hpp>
  48. #include <objects/gbseq/GBKeyword.hpp>
  49. #include <objects/gbseq/GBSeqid.hpp>
  50. #include <objects/gbseq/GBFeature.hpp>
  51. #include <objects/gbseq/GBInterval.hpp>
  52. #include <objects/gbseq/GBQualifier.hpp>
  53. #include <objects/seq/Seqdesc.hpp>
  54. #include <objmgr/scope.hpp>
  55. #include <objmgr/impl/scope_info.hpp>
  56. #include <objmgr/seqdesc_ci.hpp>
  57. #include <objmgr/util/sequence.hpp>
  58. #include <objmgr/impl/synonyms.hpp>
  60. #include <objtools/format/text_ostream.hpp>
  61. #include <objtools/format/gbseq_formatter.hpp>
  62. #include <objtools/format/items/locus_item.hpp>
  63. #include <objtools/format/items/defline_item.hpp>
  64. #include <objtools/format/items/accession_item.hpp>
  65. #include <objtools/format/items/version_item.hpp>
  66. #include <objtools/format/items/keywords_item.hpp>
  67. #include <objtools/format/items/source_item.hpp>
  68. #include <objtools/format/items/reference_item.hpp>
  69. #include <objtools/format/items/comment_item.hpp>
  70. #include <objtools/format/items/feature_item.hpp>
  71. #include <objtools/format/items/sequence_item.hpp>
  72. #include <objtools/format/items/segment_item.hpp>
  73. #include <objtools/format/items/contig_item.hpp>
  74. #include "utils.hpp"
  77. BEGIN_NCBI_SCOPE
  78. BEGIN_SCOPE(objects)
  80. /////////////////////////////////////////////////////////////////////////////
  81. // static functions
  83. static void s_GBSeqStringCleanup(string& str, bool location = false)
  84. {
  85.     list<string> l;
  86.     NStr::Split(str, " nrtb", l);
  87.     str = NStr::Join(l, " ");
  88.     if ( location ) {
  89.         str = NStr::Replace(str, ", ", ",");
  90.     }
  91.     str = NStr::TruncateSpaces(str);
  92. }
  95. static void s_GBSeqQualCleanup(string& val)
  96. {
  97.     
  98.     val = NStr::Replace(val, """, " ");
  99.     s_GBSeqStringCleanup(val);
  100.     /*
  101.     if ( NStr::EndsWith(val, ".") ) {
  102.         val.erase(val.length() - 1);
  103.     }
  104.     */
  105. }
  107. /////////////////////////////////////////////////////////////////////////////
  108. // Public
  111. // constructor
  112. CGBSeqFormatter::CGBSeqFormatter(void)
  113. {
  114. }
  116. // detructor
  117. CGBSeqFormatter::~CGBSeqFormatter(void) 
  118. {
  119. }
  122. void CGBSeqFormatter::Start(IFlatTextOStream& text_os)
  123. {
  124.     x_WriteFileHeader(text_os);
  125.         
  126.     x_StartWriteGBSet(text_os);
  127. }
  130. void CGBSeqFormatter::StartSection(const CStartSectionItem&, IFlatTextOStream&)
  131. {
  132.     m_GBSeq.Reset(new CGBSeq);
  133.     _ASSERT(m_GBSeq);
  134. }
  137. void CGBSeqFormatter::EndSection(const CEndSectionItem&, IFlatTextOStream& text_os)
  138. {
  139.     x_WriteGBSeq(text_os);
  141.     m_GBSeq.Reset();
  142.     _ASSERT(!m_GBSeq);
  143. }
  146. void CGBSeqFormatter::End(IFlatTextOStream& text_os)
  147. {
  148.     x_EndWriteGBSet(text_os);
  149. }
  152. ///////////////////////////////////////////////////////////////////////////
  153. //
  154. // Locus
  155. //
  158. CGBSeq::TStrandedness s_GBSeqStrandedness(CSeq_inst::TStrand strand)
  159. {
  160.     switch ( strand ) {
  161.     case CSeq_inst::eStrand_ss:
  162.         return CGBSeq::eStrandedness_single_stranded;
  163.     case CSeq_inst::eStrand_ds:
  164.         return CGBSeq::eStrandedness_double_stranded;
  165.     case CSeq_inst::eStrand_mixed:
  166.         return CGBSeq::eStrandedness_mixed_stranded;
  167.     case CSeq_inst::eStrand_other:
  168.     case CSeq_inst::eStrand_not_set:
  169.     default:
  170.         break;
  171.     }
  173.     return CGBSeq::eStrandedness_not_set;
  174. }
  177. CGBSeq::TMoltype s_GBSeqMoltype(CMolInfo::TBiomol biomol)
  178. {
  179.     switch ( biomol ) {
  180.     case CMolInfo::eBiomol_unknown:
  181.         return CGBSeq::eMoltype_nucleic_acid;
  182.     case CMolInfo::eBiomol_genomic:
  183.     case CMolInfo::eBiomol_other_genetic:
  184.     case CMolInfo::eBiomol_genomic_mRNA:
  185.         return CGBSeq::eMoltype_dna;
  186.     case CMolInfo::eBiomol_pre_RNA:
  187.     case CMolInfo::eBiomol_cRNA:
  188.     case CMolInfo::eBiomol_transcribed_RNA:
  189.         return CGBSeq::eMoltype_rna;
  190.     case CMolInfo::eBiomol_mRNA:
  191.         return CGBSeq::eMoltype_mrna;
  192.     case CMolInfo::eBiomol_rRNA:
  193.         return CGBSeq::eMoltype_rrna;
  194.     case CMolInfo::eBiomol_tRNA:
  195.         return CGBSeq::eMoltype_trna;
  196.     case CMolInfo::eBiomol_snRNA:
  197.         return CGBSeq::eMoltype_urna;
  198.     case CMolInfo::eBiomol_scRNA:
  199.         return CGBSeq::eMoltype_snrna;
  200.     case CMolInfo::eBiomol_peptide:
  201.         return CGBSeq::eMoltype_peptide;
  202.     case CMolInfo::eBiomol_snoRNA:
  203.         return CGBSeq::eMoltype_snorna;
  204.     default:
  205.         break;
  206.     }
  207.     return CGBSeq::eMoltype_nucleic_acid;
  208. }
  211. CGBSeq::TTopology s_GBSeqTopology(CSeq_inst::TTopology topology)
  212. {
  213.     if ( topology == CSeq_inst::eTopology_circular ) {
  214.         return CGBSeq::eTopology_circular;
  215.     }
  216.     return CGBSeq::eTopology_linear;
  217. }
  220. string s_GetDate(const CBioseq_Handle& bsh, CSeqdesc::E_Choice choice)
  221. {
  222.     _ASSERT(choice == CSeqdesc::e_Update_date  ||
  223.             choice == CSeqdesc::e_Create_date);
  224.     CSeqdesc_CI desc(bsh, choice);
  225.     if ( desc ) {
  226.         string result;
  227.         if ( desc->IsUpdate_date() ) {
  228.             DateToString(desc->GetUpdate_date(), result);
  229.         } else {
  230.             DateToString(desc->GetCreate_date(), result);
  231.         }
  232.         return result;
  233.     }
  235.     return "01-JAN-1900";
  236. }
  239. void CGBSeqFormatter::FormatLocus
  240. (const CLocusItem& locus, 
  241.  IFlatTextOStream&)
  242. {
  243.     _ASSERT(m_GBSeq);
  244.     CBioseqContext& ctx = *locus.GetContext();
  246.     m_GBSeq->SetLocus(locus.GetName());
  247.     m_GBSeq->SetLength(locus.GetLength());
  248.     m_GBSeq->SetStrandedness(s_GBSeqStrandedness(locus.GetStrand()));
  249.     m_GBSeq->SetMoltype(s_GBSeqMoltype(locus.GetBiomol()));
  250.     m_GBSeq->SetTopology(s_GBSeqTopology(locus.GetTopology()));
  251.     m_GBSeq->SetDivision(locus.GetDivision());
  252.     m_GBSeq->SetUpdate_date(s_GetDate(ctx.GetHandle(), CSeqdesc::e_Update_date));
  253.     m_GBSeq->SetCreate_date(s_GetDate(ctx.GetHandle(), CSeqdesc::e_Create_date));
  254.     ITERATE (CBioseq::TId, it, ctx.GetBioseqIds()) {
  255.         m_GBSeq->SetOther_seqids().push_back(CGBSeqid((*it)->AsFastaString()));
  256.     }
  257. }
  260. ///////////////////////////////////////////////////////////////////////////
  261. //
  262. // Definition
  264. void CGBSeqFormatter::FormatDefline
  265. (const CDeflineItem& defline,
  266.  IFlatTextOStream&)
  267. {
  268.     _ASSERT(m_GBSeq);
  269.     m_GBSeq->SetDefinition(defline.GetDefline());
  270.     if ( NStr::EndsWith(m_GBSeq->GetDefinition(), ".") ) {
  271.         m_GBSeq->SetDefinition().resize(m_GBSeq->GetDefinition().length() - 1);
  272.     }
  273. }
  276. ///////////////////////////////////////////////////////////////////////////
  277. //
  278. // Accession
  280. void CGBSeqFormatter::FormatAccession
  281. (const CAccessionItem& acc, 
  282.  IFlatTextOStream&)
  283. {
  284.     m_GBSeq->SetPrimary_accession(acc.GetAccession());
  285.     ITERATE (CAccessionItem::TExtra_accessions, it, acc.GetExtraAccessions()) {
  286.         m_GBSeq->SetSecondary_accessions().push_back(CGBSecondary_accn(*it));
  287.     }
  288. }
  291. ///////////////////////////////////////////////////////////////////////////
  292. //
  293. // Version
  295. void CGBSeqFormatter::FormatVersion
  296. (const CVersionItem& version,
  297.  IFlatTextOStream&)
  298. {
  299.     m_GBSeq->SetAccession_version(version.GetAccession());
  300. }
  303. ///////////////////////////////////////////////////////////////////////////
  304. //
  305. // Segment
  307. void CGBSeqFormatter::FormatSegment
  308. (const CSegmentItem& seg,
  309.  IFlatTextOStream&)
  310. {
  311.     CNcbiOstrstream segment_line;
  313.     segment_line << seg.GetNum() << " of " << seg.GetCount();
  315.     m_GBSeq->SetSegment(CNcbiOstrstreamToString(segment_line));
  316. }
  319. ///////////////////////////////////////////////////////////////////////////
  320. //
  321. // Source
  323. void CGBSeqFormatter::FormatSource
  324. (const CSourceItem& source,
  325.  IFlatTextOStream&)
  326. {
  327.     _ASSERT(m_GBSeq);
  328.     CNcbiOstrstream source_line;
  329.     source_line << source.GetOrganelle() << source.GetTaxname();
  330.     if ( !source.GetCommon().empty() ) {
  331.         source_line << (source.IsUsingAnamorph() ? " (anamorph: " : " (") 
  332.                     << source.GetCommon() << ")";
  333.     }
  335.     m_GBSeq->SetSource(CNcbiOstrstreamToString(source_line));
  336.     m_GBSeq->SetOrganism(source.GetTaxname());
  337.     m_GBSeq->SetTaxonomy(source.GetLineage());
  338. }
  341. ///////////////////////////////////////////////////////////////////////////
  342. //
  343. // Keywords
  345. void CGBSeqFormatter::FormatKeywords
  346. (const CKeywordsItem& keys,
  347.  IFlatTextOStream&)
  348. {
  349.     ITERATE (CKeywordsItem::TKeywords, it, keys.GetKeywords()) {
  350.         m_GBSeq->SetKeywords().push_back(CGBKeyword(*it));
  351.     }
  352. }
  355. ///////////////////////////////////////////////////////////////////////////
  356. //
  357. // REFERENCE
  359. void CGBSeqFormatter::FormatReference
  360. (const CReferenceItem& ref,
  361.  IFlatTextOStream&)
  362. {
  363.     _ASSERT(m_GBSeq);
  364.     CBioseqContext& ctx = *ref.GetContext();
  366.     CRef<CGBReference> gbref(new CGBReference);
  367.     const CSeq_loc* loc = (ref.GetLoc() != 0) ?
  368.         ref.GetLoc() : &ctx.GetLocation();
  369.     CNcbiOstrstream refstr;
  370.     refstr << ref.GetSerial() << ' ';
  371.     x_FormatRefLocation(refstr, *loc, " to ", "; ", ctx);
  372.     gbref->SetReference(CNcbiOstrstreamToString(refstr));
  373.     list<string> authors;
  374.     CReferenceItem::GetAuthNames(authors, ref.GetAuthors());
  375.     ITERATE (list<string>, it, authors) {
  376.         CGBAuthor author(*it);
  377.         gbref->SetAuthors().push_back(author);
  378.     }
  379.     if ( !ref.GetConsortium().empty() ) {
  380.         gbref->SetConsortium(ref.GetConsortium());
  381.     }
  382.     if ( !ref.GetTitle().empty() ) {
  383.         if ( NStr::EndsWith(ref.GetTitle(), ".") ) {
  384.             string title = ref.GetTitle();
  385.             title.resize(title.length() - 1);
  386.             gbref->SetTitle(title);
  387.         } else {
  388.             gbref->SetTitle(ref.GetTitle());
  389.         }
  390.     }
  391.     string journal;
  392.     x_FormatRefJournal(journal, ref);
  393.     NON_CONST_ITERATE (string, it, journal) {
  394.         if ( (*it == 'n')  ||  (*it == 't')  ||  (*it == 'r') ) {
  395.             *it = ' ';
  396.         }
  397.     }
  398.     if ( !journal.empty() ) {
  399.         gbref->SetJournal(journal);
  400.     }
  401.     if ( ref.GetMUID() != 0 ) {
  402.         gbref->SetMedline(ref.GetMUID());
  403.     }
  404.     if ( ref.GetPMID() != 0 ) {
  405.         gbref->SetPubmed(ref.GetPMID());
  406.     }
  407.     if ( !ref.GetRemark().empty() ) {
  408.         gbref->SetRemark(ref.GetRemark());
  409.     }
  410.     m_GBSeq->SetReferences().push_back(gbref);
  411. }
  413. ///////////////////////////////////////////////////////////////////////////
  414. //
  415. // COMMENT
  418. void CGBSeqFormatter::FormatComment
  419. (const CCommentItem& comment,
  420.  IFlatTextOStream&)
  421. {
  422.     string str = comment.GetComment();
  423.     s_GBSeqStringCleanup(str);
  424.     
  425.     if ( !m_GBSeq->IsSetComment() ) {
  426.         m_GBSeq->SetComment(str);
  427.     } else {    
  428.         m_GBSeq->SetComment() += "; ";
  429.         m_GBSeq->SetComment() += str;
  430.     }
  431. }
  434. ///////////////////////////////////////////////////////////////////////////
  435. //
  436. // FEATURES
  438. static void s_SetIntervals(CGBFeature::TIntervals& intervals,
  439.                     const CSeq_loc& loc,
  440.                     CScope& scope)
  441. {
  442.     for (CSeq_loc_CI it(loc); it; ++it) {
  443.         CRef<CGBInterval> ival(new CGBInterval);
  444.         CSeq_loc_CI::TRange range = it.GetRange();
  445.         CConstRef<CSeq_id> best(&it.GetSeq_id());
  446.         if ( best->IsGi() ) {
  447.             CConstRef<CSynonymsSet> syns = scope.GetSynonyms(*best);
  448.             vector< CRef<CSeq_id> > ids;
  449.             ITERATE (CSynonymsSet, id_iter, *syns) {
  450.                 CConstRef<CSeq_id> id = (*id_iter)->first.GetSeqId();
  451.                 CRef<CSeq_id> sip(const_cast<CSeq_id*>(id.GetPointerOrNull()));
  452.                 ids.push_back(sip);
  453.             }
  454.             best.Reset(FindBestChoice(ids, CSeq_id::Score));
  455.         }
  456.         ival->SetAccession(best->GetSeqIdString(true));  
  457.         if ( range.GetLength() == 1 ) {  // point
  458.             ival->SetPoint(range.GetFrom() + 1);
  459.         } else {
  460.             TSeqPos from, to;
  461.             if ( range.IsWhole() ) {
  462.                 from = 1;
  463.                 to = sequence::GetLength(it.GetSeq_loc(), &scope);
  464.             } else {
  465.                 from = range.GetFrom() + 1;
  466.                 to = range.GetTo() + 1;
  467.             }
  468.             if ( it.GetStrand() == eNa_strand_minus ) {
  469.                 swap(from, to);
  470.             }
  471.             ival->SetFrom(from);
  472.             ival->SetTo(to);
  473.         }
  474.         
  475.         intervals.push_back(ival);
  476.     }
  477. }
  480. static void s_SetQuals(CGBFeature::TQuals& gbquals,
  481.                        const CFlatFeature::TQuals& quals)
  482. {
  483.     ITERATE (CFlatFeature::TQuals, it, quals) {
  484.         CRef<CGBQualifier> qual(new CGBQualifier);
  485.         qual->SetName((*it)->GetName());
  486.         if ((*it)->GetStyle() != CFormatQual::eEmpty) {
  487.             qual->SetValue((*it)->GetValue());
  488.             s_GBSeqQualCleanup(qual->SetValue());
  489.         }
  490.         gbquals.push_back(qual);
  491.     }
  492. }
  495. void CGBSeqFormatter::FormatFeature
  496. (const CFeatureItemBase& f,
  497.  IFlatTextOStream&)
  498. {
  499.     CConstRef<CFlatFeature> feat = f.Format();
  501.     CRef<CGBFeature>    gbfeat(new CGBFeature);
  502.     gbfeat->SetKey(feat->GetKey());
  503.     
  504.     string location = feat->GetLoc().GetString();
  505.     s_GBSeqStringCleanup(location, true);
  506.     gbfeat->SetLocation(location);
  507.     if ( feat->GetKey() != "source" ) {
  508.         s_SetIntervals(gbfeat->SetIntervals(), f.GetLoc(), 
  509.             f.GetContext()->GetScope());
  510.     }
  511.     if ( !feat->GetQuals().empty() ) {
  512.         s_SetQuals(gbfeat->SetQuals(), feat->GetQuals());
  513.     }
  514.     
  515.     m_GBSeq->SetFeature_table().push_back(gbfeat);
  516. }
  519. ///////////////////////////////////////////////////////////////////////////
  520. //
  521. // SEQUENCE
  523. void CGBSeqFormatter::FormatSequence
  524. (const CSequenceItem& seq,
  525.  IFlatTextOStream&)
  526. {
  527.     string data;
  529.     CSeqVector_CI vec_ci(seq.GetSequence());
  530.     vec_ci.GetSeqData(data, seq.GetSequence().size());
  532.     if ( !m_GBSeq->IsSetSequence() ) {
  533.         m_GBSeq->SetSequence(kEmptyStr);
  534.     }
  535.     m_GBSeq->SetSequence() += data;
  536. }
  539. ///////////////////////////////////////////////////////////////////////////
  540. //
  541. // CONTIG
  543. void CGBSeqFormatter::FormatContig
  544. (const CContigItem& contig,
  545.  IFlatTextOStream&)
  546. {
  547.     string assembly = CFlatSeqLoc(contig.GetLoc(), *contig.GetContext(), 
  548.         CFlatSeqLoc::eType_assembly).GetString();
  549.     s_GBSeqStringCleanup(assembly, true);
  550.     m_GBSeq->SetContig(assembly);
  551. }
  554. //=========================================================================//
  555. //                                Private                                  //
  556. //=========================================================================//
  559. void CGBSeqFormatter::x_WriteFileHeader(IFlatTextOStream& text_os)
  560. {
  561.     m_Out.reset(CObjectOStream::Open(eSerial_Xml, m_StrStream));
  562.     const CClassTypeInfo* gbset_info
  563.         = dynamic_cast<const CClassTypeInfo*>(CGBSet::GetTypeInfo());
  564.     m_Out->WriteFileHeader(gbset_info);
  565.     x_StrOStreamToTextOStream(text_os);
  566. }
  569. void CGBSeqFormatter::x_StartWriteGBSet(IFlatTextOStream& text_os)
  570. {
  571.     m_Cont.reset(new SOStreamContainer(*m_Out, CGBSet::GetTypeInfo()));
  572.     x_StrOStreamToTextOStream(text_os);
  573. }
  576. void CGBSeqFormatter::x_WriteGBSeq(IFlatTextOStream& text_os)
  577. {
  578.     m_Cont->WriteElement(ConstObjectInfo(*m_GBSeq));
  579.     x_StrOStreamToTextOStream(text_os);
  580. }
  583. void CGBSeqFormatter::x_EndWriteGBSet(IFlatTextOStream& text_os)
  584. {
  585.     m_Cont.reset();
  586.     x_StrOStreamToTextOStream(text_os);
  587. }
  590. void CGBSeqFormatter::x_StrOStreamToTextOStream(IFlatTextOStream& text_os)
  591. {
  592.     list<string> l;
  594.     // flush ObjectOutputStream to underlying strstream
  595.     m_Out->Flush();
  596.     // read text from strstream
  597.     NStr::Split(CNcbiOstrstreamToString(m_StrStream), "n", l);
  598.     // add text to TextOStream
  599.     text_os.AddParagraph(l);
  600.     // reset strstream
  601.     m_StrStream.seekp(0);
  602. }
  605. END_SCOPE(objects)
  606. END_NCBI_SCOPE
  609. /*
  610. * ===========================================================================
  611. *
  612. * $Log: gbseq_formatter.cpp,v $
  613. * Revision 1000.1  2004/06/01 19:44:34  gouriano
  614. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  615. *
  616. * Revision 1.4  2004/05/21 21:42:54  gorelenk
  617. * Added PCH ncbi_pch.hpp
  618. *
  619. * Revision 1.3  2004/05/06 17:52:53  shomrat
  620. * CFlatQual -> CFormatQual
  621. *
  622. * Revision 1.2  2004/04/22 15:53:26  shomrat
  623. * Changes in context
  624. *
  625. * Revision 1.1  2004/04/13 16:49:54  shomrat
  626. * Initial revision
  627. *
  628. *
  629. * ===========================================================================
  630. */