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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: genbank_formatter.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:38:52  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJTOOLS_FORMAT___GENBANK_FORMATTER__HPP
  10. #define OBJTOOLS_FORMAT___GENBANK_FORMATTER__HPP
  11. /*  $Id: genbank_formatter.hpp,v 1000.1 2004/06/01 19:38:52 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:  Aaron Ucko, NCBI
  37. *          Mati Shomrat
  38. *
  39. * File Description:
  40. *   new (early 2003) flat-file generator -- base class for items
  41. *   (which roughly correspond to blocks/paragraphs in the C version)
  42. *
  43. */
  44. #include <corelib/ncbistd.hpp>
  45. #include <objtools/format/item_formatter.hpp>
  46. BEGIN_NCBI_SCOPE
  47. BEGIN_SCOPE(objects)
  48. class CLocusItem;
  49. class CDeflineItem;
  50. class CAccessionItem;
  51. class CVersionItem;
  52. class CKeywordsItem;
  53. class CSourceItem;
  54. class CReferenceItem;
  55. class CCommentItem;
  56. class CFeatHeaderItem;
  57. class CBaseCountItem;
  58. class CSequenceItem;
  59. class CPrimaryItem;
  60. class CSegmentItem;
  61. class IFlattishFeature;
  62. class CContigItem;
  63. class CWGSItem;
  64. class CGenomeItem;
  65. class CFlatTextOStream;
  66. class CDateItem;
  67. class CDBSourceItem;
  68. class CBioseqContext;
  69. class COriginItem;
  70. class CGenbankFormatter : public CFlatItemFormatter
  71. {
  72. public:
  73.     CGenbankFormatter(void);
  74.     virtual SIZE_TYPE GetWidth(void) const { return 79; }
  75.     virtual void EndSection(const CEndSectionItem&, IFlatTextOStream& text_os);
  76.     virtual void FormatLocus(const CLocusItem& locus, IFlatTextOStream& text_os);
  77.     virtual void FormatDefline(const CDeflineItem& defline, IFlatTextOStream& text_os);
  78.     virtual void FormatAccession(const CAccessionItem& acc, IFlatTextOStream& text_os);
  79.     virtual void FormatVersion(const CVersionItem& version, IFlatTextOStream& text_os);
  80.     virtual void FormatKeywords(const CKeywordsItem& keys, IFlatTextOStream& text_os);
  81.     virtual void FormatSource(const CSourceItem& source, IFlatTextOStream& text_os);
  82.     virtual void FormatReference(const CReferenceItem& keys, IFlatTextOStream& text_os);
  83.     virtual void FormatComment(const CCommentItem& keys, IFlatTextOStream& text_os);
  84.     virtual void FormatBasecount(const CBaseCountItem& bc, IFlatTextOStream& text_os);
  85.     virtual void FormatSequence(const CSequenceItem& seq, IFlatTextOStream& text_os);
  86.     virtual void FormatFeatHeader(const CFeatHeaderItem& fh, IFlatTextOStream& text_os);
  87.     virtual void FormatFeature(const CFeatureItemBase& feat, IFlatTextOStream& text_os);
  88.     virtual void FormatSegment(const CSegmentItem& seg, IFlatTextOStream& text_os);
  89.     virtual void FormatDBSource(const CDBSourceItem& dbs, IFlatTextOStream& text_os);
  90.     virtual void FormatPrimary(const CPrimaryItem& prim, IFlatTextOStream& text_os);
  91.     virtual void FormatContig(const CContigItem& contig, IFlatTextOStream& text_os);
  92.     virtual void FormatWGS(const CWGSItem& wgs, IFlatTextOStream& text_os);
  93.     virtual void FormatGenome(const CGenomeItem& genome, IFlatTextOStream& text_os);
  94.     virtual void FormatOrigin(const COriginItem& origin, IFlatTextOStream& text_os);
  95. private:
  96.     // source
  97.     void x_FormatSourceLine(list<string>& l, const CSourceItem& source) const;
  98.     void x_FormatOrganismLine(list<string>& l, const CSourceItem& source) const;
  99.     // reference
  100.     void x_Reference(list<string>& l, const CReferenceItem& ref, CBioseqContext& ctx) const;
  101.     void x_Authors(list<string>& l, const CReferenceItem& ref, CBioseqContext& ctx) const;
  102.     void x_Consortium(list<string>& l, const CReferenceItem& ref, CBioseqContext& ctx) const;
  103.     void x_Title(list<string>& l, const CReferenceItem& ref, CBioseqContext& ctx) const;
  104.     void x_Journal(list<string>& l, const CReferenceItem& ref, CBioseqContext& ctx) const;
  105.     void x_Medline(list<string>& l, const CReferenceItem& ref, CBioseqContext& ctx) const;
  106.     void x_Pubmed(list<string>& l, const CReferenceItem& ref, CBioseqContext& ctx) const;
  107.     void x_Remark(list<string>& l, const CReferenceItem& ref, CBioseqContext& ctx) const;
  108. };
  109. END_SCOPE(objects)
  110. END_NCBI_SCOPE
  111. /*
  112. * ===========================================================================
  113. *
  114. * $Log: genbank_formatter.hpp,v $
  115. * Revision 1000.1  2004/06/01 19:38:52  gouriano
  116. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  117. *
  118. * Revision 1.4  2004/04/22 15:45:27  shomrat
  119. * Changes in context
  120. *
  121. * Revision 1.3  2004/02/19 17:58:41  shomrat
  122. * Added method to format Origin item
  123. *
  124. * Revision 1.2  2004/01/14 15:54:28  shomrat
  125. * const removed
  126. *
  127. * Revision 1.1  2003/12/17 19:53:06  shomrat
  128. * Initial revision (adapted from flat lib)
  129. *
  130. *
  131. * ===========================================================================
  132. */
  133. #endif  /* OBJTOOLS_FORMAT___GENBANK_FORMATTER__HPP */