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

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

生物技术

开发平台：

C/C++

cache.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: cache.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/12 17:27:03  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R6.13
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef NCBI_TAXON1_CACHE_HPP
  11. #define NCBI_TAXON1_CACHE_HPP
  13. /* $Id: cache.hpp,v 1000.1 2004/04/12 17:27:03 gouriano Exp $
  14.  * ===========================================================================
  15.  *
  16.  *                            PUBLIC DOMAIN NOTICE
  17.  *               National Center for Biotechnology Information
  18.  *
  19.  *  This software/database is a "United States Government Work" under the
  20.  *  terms of the United States Copyright Act.  It was written as part of
  21.  *  the author's official duties as a United States Government employee and
  22.  *  thus cannot be copyrighted.  This software/database is freely available
  23.  *  to the public for use. The National Library of Medicine and the U.S.
  24.  *  Government have not placed any restriction on its use or reproduction.
  25.  *
  26.  *  Although all reasonable efforts have been taken to ensure the accuracy
  27.  *  and reliability of the software and data, the NLM and the U.S.
  28.  *  Government do not and cannot warrant the performance or results that
  29.  *  may be obtained by using this software or data. The NLM and the U.S.
  30.  *  Government disclaim all warranties, express or implied, including
  31.  *  warranties of performance, merchantability or fitness for any particular
  32.  *  purpose.
  33.  *
  34.  *  Please cite the author in any work or product based on this material.
  35.  *
  36.  * ===========================================================================
  37.  *
  38.  * Author:  Vladimir Soussov, Michael Domrachev
  39.  *
  40.  * File Description:
  41.  *     NCBI Taxonomy information retreival library caching mechanism
  42.  *
  43.  */
  45. #include <objects/taxon1/taxon1.hpp>
  46. #include <objects/seqfeat/seqfeat__.hpp>
  47. #include "ctreecont.hpp"
  49. #include <map>
  52. BEGIN_NCBI_SCOPE
  53. BEGIN_objects_SCOPE
  56. class CTaxon1Node;
  59. class COrgRefCache
  60. {
  61. public:
  62.     COrgRefCache( CTaxon1& host );
  64.     bool Init( unsigned nCapacity = 10 );
  66.     bool Lookup( int tax_id, CTaxon1Node** ppNode );
  67.     bool LookupAndAdd( int tax_id, CTaxon1Node** ppData );
  68.     bool LookupAndInsert( int tax_id, CTaxon1_data** ppData );
  69.     bool LookupAndInsert( int tax_id, CTaxon2_data** ppData );
  70.     bool Lookup( int tax_id, CTaxon1_data** ppData );
  71.     bool Lookup( int tax_id, CTaxon2_data** ppData );
  73.     bool Insert1( CTaxon1Node& node );
  74.     bool Insert2( CTaxon1Node& node );
  76.     // Rank stuff
  77.     const char* GetRankName( int rank ) const;
  79.     int GetSuperkingdomRank() const { return m_nSuperkingdomRank; }
  80.     int GetFamilyRank() const { return m_nFamilyRank; }
  81.     int GetOrderRank() const { return m_nOrderRank; }
  82.     int GetClassRank() const { return m_nClassRank; }
  83.     int GetGenusRank() const { return m_nGenusRank; }
  84.     int GetSubgenusRank() const { return m_nSubgenusRank; }
  85.     int GetSpeciesRank() const { return m_nSpeciesRank; }
  86.     int GetSubspeciesRank() const { return m_nSubspeciesRank; }
  87.     int GetFormaRank() const { return m_nFormaRank; }
  88.     int GetVarietyRank() const { return m_nVarietyRank; }
  90.     const char* GetNameClassName( short nc ) const;
  91.     short GetPreferredCommonNameClass() const { return m_ncPrefCommon; }
  92.     short GetCommonNameClass() const { return m_ncCommon; }
  93.     short GetSynonymNameClass() const { return m_ncSynonym; }
  94.     short GetGBAcronymNameClass() const { return m_ncGBAcronym; }
  95.     short GetGBSynonymNameClass() const { return m_ncGBSynonym; }
  96.     short GetGBAnamorphNameClass() const { return m_ncGBAnamorph; }
  98.     const char* GetDivisionName( short div_id ) const;
  99.     const char* GetDivisionCode( short div_id ) const;
  100.     short GetVirusesDivision() const { return m_divViruses; }
  101.     short GetPhagesDivision() const { return m_divPhages; }
  103.     CTreeCont& GetTree() { return m_tPartTree; }
  104.     const CTreeCont& GetTree() const { return m_tPartTree; }
  106.     void  SetIndexEntry( int id, CTaxon1Node* pNode );
  108.     COrgMod::ESubtype GetSubtypeFromName( string& sName );
  110. private:
  111.     friend class CTaxon1Node;
  112.     struct SCacheEntry {
  113.         friend class CTaxon1Node;
  114.         CRef< CTaxon1_data > m_pTax1;
  115.         CRef< CTaxon2_data > m_pTax2;
  117.         CTaxon1Node*  m_pTreeNode;
  118.         //  COrg_ref* p_org_ref;
  119.         //  bool is_uncultured;
  120.         //  bool is_species;
  121.         //  bool has_modif;
  122.         //  list< string > blast_name;
  123.         CTaxon1_data* GetData1();
  124.         CTaxon2_data* GetData2();
  125.     };
  127.     CTaxon1&           m_host;
  129.     unsigned           m_nMaxTaxId;
  130.     CTaxon1Node**      m_ppEntries; // index by tax_id
  131.     CTreeCont          m_tPartTree; // Partial tree
  133.     unsigned           m_nCacheCapacity; // Max number of elements in cache
  134.     list<SCacheEntry*> m_lCache; // LRU list
  136.     bool             BuildOrgRef( CTaxon1Node& node, COrg_ref& org,
  137.                                   bool& is_species );
  138.     bool             BuildOrgModifier( CTaxon1Node* pNode,
  139.                                        COrgName& on,
  140.                                        CTaxon1Node* pParent = NULL );
  141.     bool             SetBinomialName( CTaxon1Node& node, COrgName& on );
  142.     bool             SetPartialName( CTaxon1Node& node, COrgName& on );
  143.     // Rank stuff
  144.     int m_nSuperkingdomRank;
  145.     int m_nFamilyRank;
  146.     int m_nOrderRank;
  147.     int m_nClassRank;
  148.     int m_nGenusRank;
  149.     int m_nSubgenusRank;
  150.     int m_nSpeciesRank;
  151.     int m_nSubspeciesRank;
  152.     int m_nFormaRank;
  153.     int m_nVarietyRank;
  155.     typedef map<int, string> TRankMap;
  156.     typedef TRankMap::const_iterator TRankMapCI;
  157.     typedef TRankMap::iterator TRankMapI;
  159.     TRankMap m_rankStorage;
  161.     bool     InitRanks();
  162.     int      FindRankByName( const char* pchName ) const;
  164.     // Name classes stuff
  165.     short m_ncPrefCommon; // now called "genbank common name"
  166.     short m_ncCommon;
  167.     short m_ncSynonym;
  168.     short m_ncGBAcronym;
  169.     short m_ncGBSynonym;
  170.     short m_ncGBAnamorph;
  172.     typedef map<short, string> TNameClassMap;
  173.     typedef TNameClassMap::const_iterator TNameClassMapCI;
  174.     typedef TNameClassMap::iterator TNameClassMapI;
  175.     TNameClassMap m_ncStorage;
  177.     bool     InitNameClasses();
  178.     short    FindNameClassByName( const char* pchName ) const;
  180.     // Division stuff
  181.     short m_divViruses;
  182.     short m_divPhages;
  183.     struct SDivision {
  184.         string m_sCode;
  185.         string m_sName;
  186.     };
  187.     typedef map<short, struct SDivision> TDivisionMap;
  188.     typedef TDivisionMap::const_iterator TDivisionMapCI;
  189.     typedef TDivisionMap::iterator TDivisionMapI;
  190.     TDivisionMap m_divStorage;
  192.     bool     InitDivisions();
  193.     short    FindDivisionByCode( const char* pchCode ) const;
  194. };
  197. class CTaxon1Node : public CTreeContNodeBase, public ITaxon1Node {
  198. public:
  199.     CTaxon1Node( const CRef< CTaxon1_name >& ref )
  200.         : m_ref( ref ), m_cacheEntry( NULL ), m_flags( 0 ) {}
  201.     explicit CTaxon1Node( const CTaxon1Node& node )
  202.         : CTreeContNodeBase(), m_ref( node.m_ref ),
  203.   m_cacheEntry( NULL ), m_flags( 0 ) {}
  204.     virtual ~CTaxon1Node() {}
  206.     virtual int           GetTaxId() const { return m_ref->GetTaxid(); }
  207.     virtual const string& GetName() const { return m_ref->GetOname(); }
  208.     virtual const string& GetBlastName() const
  209.     { return m_ref->CanGetUname() ? m_ref->GetUname() : kEmptyStr; }
  210.     virtual short         GetRank() const;
  211.     virtual short         GetDivision() const;
  212.     virtual short         GetGC() const;
  213.     virtual short         GetMGC() const;
  214.                        
  215.     virtual bool          IsUncultured() const;
  216.     virtual bool          IsGenBankHidden() const;
  218.     virtual bool          IsRoot() const
  219.     { return CTreeContNodeBase::IsRoot(); }
  221.     COrgRefCache::SCacheEntry* GetEntry() { return m_cacheEntry; }
  223.     bool                  IsJoinTerminal() const
  224.     { return m_flags&mJoinTerm ? true : false; }
  225.     void                  SetJoinTerminal() { m_flags |= mJoinTerm; }
  226.     bool                  IsSubtreeLoaded() const
  227.     { return m_flags&mSubtreeLoaded ? true : false; }
  228.     void                  SetSubtreeLoaded( bool b )
  229.     { if( b ) m_flags |= mSubtreeLoaded; else m_flags &= ~mSubtreeLoaded; }
  231.     CTaxon1Node*          GetParent()
  232.     { return static_cast<CTaxon1Node*>(Parent()); }
  233. private:
  234.     friend class COrgRefCache;
  235.     enum EFlags {
  236. mJoinTerm      = 0x1,
  237. mSubtreeLoaded = 0x2
  238.     };
  240.     CRef< CTaxon1_name >       m_ref;
  242.     COrgRefCache::SCacheEntry* m_cacheEntry;
  243.     unsigned                   m_flags;
  244. };
  246. class CTaxTreeConstIterator : public ITreeIterator {
  247. public:
  248.     CTaxTreeConstIterator( CTreeConstIterator* pIt, CTaxon1::EIteratorMode m )
  249. : m_it( pIt ), m_itMode( m )  {}
  250.     virtual ~CTaxTreeConstIterator() {
  251. delete m_it;
  252.     }
  254.     virtual CTaxon1::EIteratorMode GetMode() const { return m_itMode; }
  255.     virtual const ITaxon1Node* GetNode() const
  256.     { return CastCI(m_it->GetNode()); }
  257.     const ITaxon1Node* operator->() const { return GetNode(); }
  258.     virtual bool IsLastChild() const;
  259.     virtual bool IsFirstChild() const;
  260.     virtual bool IsTerminal() const;
  261.     // Navigation
  262.     virtual void GoRoot() { m_it->GoRoot(); }
  263.     virtual bool GoParent();
  264.     virtual bool GoChild();
  265.     virtual bool GoSibling();
  266.     virtual bool GoNode(const ITaxon1Node* pNode);
  267.     // move cursor to the nearest common ancestor
  268.     // between node pointed by cursor and the node
  269.     // with given node_id
  270.     virtual bool GoAncestor(const ITaxon1Node* pNode);
  271.     // check if node pointed by cursor
  272.     // is belong to subtree wich root node
  273.     // has given node_id
  274.     virtual bool BelongSubtree(const ITaxon1Node* subtree_root) const;
  275.     // check if node with given node_id belongs
  276.     // to subtree pointed by cursor
  277.     virtual bool AboveNode(const ITaxon1Node* node) const;
  278. protected:
  279.     virtual bool IsVisible( const CTreeContNodeBase* p ) const = 0;
  280.     // Moves m_it to the next visible for this parent
  281.     bool NextVisible( const CTreeContNodeBase* pParent ) const;
  283.     const ITaxon1Node* CastCI( const CTreeContNodeBase* p ) const
  284.     { return static_cast<const ITaxon1Node*>
  285.   (static_cast<const CTaxon1Node*>(p)); }
  286.     const CTreeContNodeBase* CastIC( const ITaxon1Node* p ) const
  287.     { return static_cast<const CTreeContNodeBase*>
  288.   (static_cast<const CTaxon1Node*>(p)); }
  289.     mutable CTreeConstIterator* m_it;
  290.     CTaxon1::EIteratorMode      m_itMode;
  291. };
  293. class CFullTreeConstIterator : public CTaxTreeConstIterator {
  294. public:
  295.     CFullTreeConstIterator( CTreeConstIterator* pIt )
  296. : CTaxTreeConstIterator( pIt, CTaxon1::eIteratorMode_FullTree ) {}
  297.     virtual ~CFullTreeConstIterator() {}
  299.     virtual bool IsLastChild() const
  300.     { return m_it->GetNode() && m_it->GetNode()->IsLastChild(); }
  301.     virtual bool IsFirstChild() const
  302.     { return m_it->GetNode() && m_it->GetNode()->IsFirstChild(); }
  303.     virtual bool IsTerminal() const
  304.     { return m_it->GetNode() && m_it->GetNode()->IsTerminal(); }
  305.     // Navigation
  306.     virtual bool GoParent() { return m_it->GoParent(); }
  307.     virtual bool GoChild() { return m_it->GoChild(); }
  308.     virtual bool GoSibling() { return m_it->GoSibling(); }
  309.     virtual bool GoNode(const ITaxon1Node* pNode)
  310.     { return m_it->GoNode(CastIC(pNode)); }
  311.     // move cursor to the nearest common ancestor
  312.     // between node pointed by cursor and the node
  313.     // with given node_id
  314.     virtual bool GoAncestor(const ITaxon1Node* pNode)
  315.     { return m_it->GoAncestor(CastIC(pNode)); }
  316.     // check if node pointed by cursor
  317.     // is belong to subtree wich root node
  318.     // has given node_id
  319.     virtual bool BelongSubtree(const ITaxon1Node* subtree_root) const
  320.     { return m_it->BelongSubtree(CastIC(subtree_root)); }
  321.     // check if node with given node_id belongs
  322.     // to subtree pointed by cursor
  323.     virtual bool AboveNode(const ITaxon1Node* node) const
  324.     { return m_it->AboveNode(CastIC(node)); }
  325. protected:
  326.     virtual bool IsVisible( const CTreeContNodeBase* ) const { return true; }
  327. };
  329. class CTreeLeavesBranchesIterator : public CTaxTreeConstIterator {
  330. public:
  331.     CTreeLeavesBranchesIterator( CTreeConstIterator* pIt ) :
  332. CTaxTreeConstIterator( pIt, CTaxon1::eIteratorMode_LeavesBranches ) {}
  333.     virtual ~CTreeLeavesBranchesIterator() {}
  335.     virtual bool IsTerminal() const
  336.     { return m_it->GetNode() && m_it->GetNode()->IsTerminal(); }
  337. protected:
  338.     virtual bool IsVisible( const CTreeContNodeBase* p ) const;
  339. };
  341. class CTreeBestIterator : public CTaxTreeConstIterator {
  342. public:
  343.     CTreeBestIterator( CTreeConstIterator* pIt ) :
  344. CTaxTreeConstIterator( pIt, CTaxon1::eIteratorMode_Best ) {}
  345.     virtual ~CTreeBestIterator() {}
  347.     virtual bool IsTerminal() const
  348.     { return m_it->GetNode() && m_it->GetNode()->IsTerminal(); }
  349. protected:
  350.     virtual bool IsVisible( const CTreeContNodeBase* p ) const;
  351. };
  353. class CTreeBlastIterator : public CTaxTreeConstIterator {
  354. public:
  355.     CTreeBlastIterator( CTreeConstIterator* pIt ) :
  356. CTaxTreeConstIterator( pIt, CTaxon1::eIteratorMode_Blast ) {}
  357.     virtual ~CTreeBlastIterator() {}
  359. protected:
  360.     virtual bool IsVisible( const CTreeContNodeBase* p ) const;
  361. };
  363. END_objects_SCOPE
  364. END_NCBI_SCOPE
  368. /*
  369.  * $Log: cache.hpp,v $
  370.  * Revision 1000.1  2004/04/12 17:27:03  gouriano
  371.  * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R6.13
  372.  *
  373.  * Revision 6.13  2004/02/04 16:14:44  domrach
  374.  * New iterator types (modes of operation) are introduced. They include:
  375.  * full tree, branches'n'leaves, best, and blast. Position inquiry f-ns
  376.  * IsTerminal(), IsFirstChild(), and IsLastChild() has been moved from
  377.  * ITreeNode to ITreeIterator. Node loading f-ns() now return the ITreeNode
  378.  * for tax id.
  379.  *
  380.  * Revision 6.12  2003/06/23 20:42:08  domrach
  381.  * New treatment of subspecies names introduced
  382.  *
  383.  * Revision 6.11  2003/06/05 20:44:01  domrach
  384.  * Adjusted to the new CanGetXxx verification methods
  385.  *
  386.  * Revision 6.10  2003/05/31 15:55:48  lavr
  387.  * Explicit 'int'->'bool' casts to avoid compiler warnings
  388.  *
  389.  * Revision 6.9  2003/05/06 19:53:53  domrach
  390.  * New functions and interfaces for traversing the cached partial taxonomy tree introduced. Convenience functions GetDivisionName() and GetRankName() were added
  391.  *
  392.  * Revision 6.8  2003/03/05 21:33:52  domrach
  393.  * Enhanced orgref processing. Orgref cache capacity control added.
  394.  *
  395.  * Revision 6.7  2003/01/21 19:36:23  domrach
  396.  * Secondary tax id support added. New copy constructor for partial tree support added.
  397.  *
  398.  * Revision 6.6  2003/01/10 19:58:46  domrach
  399.  * Function GetPopsetJoin() added to CTaxon1 class
  400.  *
  401.  * Revision 6.5  2002/11/08 14:39:52  domrach
  402.  * Member function GetSuperkingdom() added
  403.  *
  404.  * Revision 6.4  2002/08/06 15:09:46  domrach
  405.  * Introducing new genbank name classes
  406.  *
  407.  * Revision 6.3  2002/02/14 22:44:50  vakatov
  408.  * Use STimeout instead of time_t.
  409.  * Get rid of warnings and extraneous #include's, shuffled code a little.
  410.  *
  411.  * Revision 6.2  2002/01/31 00:31:26  vakatov
  412.  * Follow the renaming of "CTreeCont.hpp" to "ctreecont.hpp".
  413.  * Get rid of "std::" which is unnecessary and sometimes un-compilable.
  414.  * Also done some source identation/beautification.
  415.  *
  416.  * Revision 6.1  2002/01/28 19:56:10  domrach
  417.  * Initial checkin of the library implementation files
  418.  *
  419.  * ===========================================================================
  420.  */
  422. #endif // NCBI_TAXON1_CACHE_HPP