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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: formatter.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:38:36  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.6
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJTOOLS_FORMAT___FORMATTER_HPP
  10. #define OBJTOOLS_FORMAT___FORMATTER_HPP
  11. /*  $Id: formatter.hpp,v 1000.1 2004/06/01 19:38:36 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. *           
  41. *
  42. */
  43. #include <corelib/ncbistd.hpp>
  44. #include <corelib/ncbiobj.hpp>
  45. BEGIN_NCBI_SCOPE
  46. BEGIN_SCOPE(objects)
  47. class IFlatItem;
  48. class IFlatTextOStream;
  49. class CLocusItem;
  50. class CDeflineItem;
  51. class CAccessionItem;
  52. class CVersionItem;
  53. class CKeywordsItem;
  54. class CSourceItem;
  55. class CReferenceItem;
  56. class CCommentItem;
  57. class CFeatHeaderItem;
  58. class CBaseCountItem;
  59. class CSequenceItem;
  60. class CPrimaryItem;
  61. class CSegmentItem;
  62. class CFeatureItemBase;
  63. class CContigItem;
  64. class CWGSItem;
  65. class CGenomeItem;
  66. class CEndSectionItem;
  67. class CFlatTextOStream;
  68. class CDateItem;
  69. class CDBSourceItem;
  70. class COriginItem;
  71. class CStartSectionItem;
  72. class CEndSectionItem;
  73. class IFormatter : public CObject
  74. {
  75. public:
  76.     
  77.     // control methods
  78.     virtual void Start       (IFlatTextOStream& text_os) = 0;
  79.     virtual void StartSection(const CStartSectionItem& ssec, IFlatTextOStream& text_os) = 0;
  80.     virtual void EndSection  (const CEndSectionItem& esec, IFlatTextOStream& text_os) = 0;
  81.     virtual void End         (IFlatTextOStream& text_os) = 0;
  82.     // format methods
  83.     virtual void Format(const IFlatItem& item, IFlatTextOStream& text_os) = 0;
  84.     virtual void FormatLocus(const CLocusItem& locus, IFlatTextOStream& text_os) = 0;
  85.     virtual void FormatDefline(const CDeflineItem& defline, IFlatTextOStream& text_os) = 0;
  86.     virtual void FormatAccession(const CAccessionItem& acc, IFlatTextOStream& text_os) = 0;
  87.     virtual void FormatVersion(const CVersionItem& version, IFlatTextOStream& text_os) = 0;
  88.     virtual void FormatKeywords(const CKeywordsItem& keys, IFlatTextOStream& text_os) = 0;
  89.     virtual void FormatSource(const CSourceItem& keys, IFlatTextOStream& text_os) = 0;
  90.     virtual void FormatReference(const CReferenceItem& keys, IFlatTextOStream& text_os) = 0;
  91.     virtual void FormatComment(const CCommentItem& comment, IFlatTextOStream& text_os) = 0;
  92.     virtual void FormatBasecount(const CBaseCountItem& bc, IFlatTextOStream& text_os) = 0;
  93.     virtual void FormatSequence(const CSequenceItem& seq, IFlatTextOStream& text_os) = 0;
  94.     virtual void FormatFeatHeader(const CFeatHeaderItem& fh, IFlatTextOStream& text_os) = 0;
  95.     virtual void FormatFeature(const CFeatureItemBase& feat, IFlatTextOStream& text_os) = 0;
  96.     virtual void FormatSegment(const CSegmentItem& seg, IFlatTextOStream& text_os) = 0;
  97.     virtual void FormatDate(const CDateItem& date, IFlatTextOStream& text_os) = 0;
  98.     virtual void FormatDBSource(const CDBSourceItem& dbs, IFlatTextOStream& text_os) = 0;
  99.     virtual void FormatPrimary(const CPrimaryItem& prim, IFlatTextOStream& text_os) = 0;
  100.     virtual void FormatContig(const CContigItem& contig, IFlatTextOStream& text_os) = 0;
  101.     virtual void FormatWGS(const CWGSItem& wgs, IFlatTextOStream& text_os) = 0;
  102.     virtual void FormatGenome(const CGenomeItem& genome, IFlatTextOStream& text_os) = 0;
  103.     virtual void FormatOrigin(const COriginItem& origin, IFlatTextOStream& text_os) = 0;
  104.     
  105.     virtual ~IFormatter(void) {}
  106. };
  107. END_SCOPE(objects)
  108. END_NCBI_SCOPE
  109. /*
  110. * ===========================================================================
  111. *
  112. * $Log: formatter.hpp,v $
  113. * Revision 1000.1  2004/06/01 19:38:36  gouriano
  114. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.6
  115. *
  116. * Revision 1.6  2004/04/22 15:43:27  shomrat
  117. * End/Start section changed
  118. *
  119. * Revision 1.5  2004/02/19 17:58:23  shomrat
  120. * Added method to format Origin item
  121. *
  122. * Revision 1.4  2004/02/12 20:24:22  shomrat
  123. * removed unnecessary include
  124. *
  125. * Revision 1.3  2004/02/11 22:46:45  shomrat
  126. * using types in flag file
  127. *
  128. * Revision 1.2  2004/01/14 15:53:12  shomrat
  129. * const removed
  130. *
  131. * Revision 1.1  2003/12/17 19:52:30  shomrat
  132. * Initial revision (adapted from flat lib)
  133. *
  134. *
  135. * ===========================================================================
  136. */
  137. #endif  /* OBJTOOLS_FORMAT___FORMATTER_HPP */