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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: flat_gff_formatter.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2003/11/05 15:27:25  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef OBJTOOLS_FLAT___FLAT_GFF_FORMATTER__HPP
  10. #define OBJTOOLS_FLAT___FLAT_GFF_FORMATTER__HPP
  11. /*  $Id: flat_gff_formatter.hpp,v 1000.1 2003/11/05 15:27:25 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.  * Authors:  Aaron Ucko, Wratko Hlavina
  37.  *
  38.  */
  39. /// @file flat_gff_formatter.hpp
  40. /// Flat formatter for Generic Feature Format (incl. Gene Transfer Format)
  41. ///
  42. /// These formats are somewhat loosely defined (for the record, at
  43. /// http://www.sanger.ac.uk/Software/formats/GFF/GFF_Spec.shtml and
  44. /// http://genes.cs.wustl.edu/GTF2.html respectively) so we default to
  45. /// GenBank/DDBJ/EMBL keys and qualifiers except as needed for GTF
  46. /// compatibility.
  47. #include <objtools/flat/flat_text_formatter.hpp>
  48. #include <objects/seqfeat/Seq_feat.hpp>
  49. /** @addtogroup Miscellaneous
  50.  *
  51.  * @{
  52.  */
  53. BEGIN_NCBI_SCOPE
  54. BEGIN_SCOPE(objects)
  55. class CFlatFeature;
  56. class NCBI_FLAT_EXPORT CFlatGFFFormatter : public IFlatFormatter
  57. {
  58. public:
  59.     enum EGFFFlags {
  60.         fGTFCompat = 0x1, ///< Represent CDSs (and exons) per GTF.
  61.         fGTFOnly   = 0x3, ///< Omit all other features.
  62.         fShowSeq   = 0x4, ///< Show the actual sequence in a "##" comment.
  63.     };
  64.     typedef int TGFFFlags; ///< Binary OR of EGFFFlags
  65.     CFlatGFFFormatter(IFlatTextOStream& stream, CScope& scope,
  66.                       EMode mode = eMode_Dump, TGFFFlags gff_flags = 0,
  67.                       EStyle style = eStyle_Master, TFlags flags = 0);
  68. protected: // mostly no-ops
  69.     EDatabase GetDatabase(void) const { return eDB_NCBI; }
  70.     void FormatHead      (const CFlatHead& head);
  71.     void FormatKeywords  (const CFlatKeywords& keys)   { }
  72.     void FormatSegment   (const CFlatSegment& seg)     { }
  73.     void FormatSource    (const CFlatSource& source)   { }
  74.     void FormatReference (const CFlatReference& ref)   { }
  75.     void FormatComment   (const CFlatComment& comment) { }
  76.     void FormatPrimary   (const CFlatPrimary& prim)    { }
  77.     void FormatFeatHeader(const CFlatFeatHeader& fh)   { }
  78.     void FormatFeature   (const IFlattishFeature& f);
  79.     void FormatDataHeader(const CFlatDataHeader& dh);
  80.     void FormatData      (const CFlatData& data);
  81.     void FormatContig    (const CFlatContig& contig)   { }
  82.     void FormatWGSRange  (const CFlatWGSRange& range)  { }
  83.     void FormatGenomeInfo(const CFlatGenomeInfo& g)    { }
  84.     void EndSequence     (void);
  85. private:
  86.     string x_GetGeneID(const CFlatFeature& feat, const string& gene_name);
  87.     string x_GetSourceName(const IFlattishFeature&);
  88.     void   x_AddFeature(list<string>& l, const CSeq_loc& loc,
  89.                         const string& source, const string& key,
  90.                         const string& score, int frame, const string& attrs,
  91.                         bool gtf);
  92.     TGFFFlags              m_GFFFlags;
  93.     CRef<IFlatTextOStream> m_Stream;
  94.     string                 m_SeqType;
  95.     string                 m_EndSequence;
  96.     /// Taken from head
  97.     string                 m_Date;
  98.     CSeq_inst::TStrand     m_Strandedness;
  99.     typedef vector<CConstRef<CSeq_feat> > TFeatVec;
  100.     map<string, TFeatVec>  m_Genes;
  101. };
  102. END_SCOPE(objects)
  103. END_NCBI_SCOPE
  104. /* @} */
  105. /*
  106.  * ===========================================================================
  107.  * $Log: flat_gff_formatter.hpp,v $
  108.  * Revision 1000.1  2003/11/05 15:27:25  gouriano
  109.  * PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.4
  110.  *
  111.  * Revision 1.4  2003/11/04 19:39:45  ucko
  112.  * Default style changed from normal to master now that the OM no longer
  113.  * splits remapped features.
  114.  *
  115.  * Revision 1.3  2003/10/17 21:01:54  ucko
  116.  * +x_AddFeature (helper factored out of FormatFeature)
  117.  *
  118.  * Revision 1.2  2003/10/09 17:01:48  dicuccio
  119.  * Added export specifiers
  120.  *
  121.  * Revision 1.1  2003/10/08 21:11:29  ucko
  122.  * New GFF/GTF formatter
  123.  *
  124.  * ===========================================================================
  125.  */
  126. #endif  /* OBJTOOLS_FLAT___FLAT_GFF_FORMATTER__HPP */