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

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

生物技术

开发平台：

C/C++

object_manager.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: object_manager.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/12 17:27:18  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.20
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef OBJECT_MANAGER__HPP
  11. #define OBJECT_MANAGER__HPP
  13. /*  $Id: object_manager.hpp,v 1000.1 2004/04/12 17:27:18 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. * Authors:
  39. *           Andrei Gourianov
  40. *           Aleksey Grichenko
  41. *           Michael Kimelman
  42. *           Denis Vakatov
  43. *
  44. * File Description:
  45. *           Object manager manages data objects,
  46. *           provides them to Scopes when needed
  47. *
  48. * ---------------------------------------------------------------------------
  49. * $Log: object_manager.hpp,v $
  50. * Revision 1000.1  2004/04/12 17:27:18  gouriano
  51. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.20
  52. *
  53. * Revision 1.20  2004/03/24 18:30:28  vasilche
  54. * Fixed edit API.
  55. * Every *_Info object has its own shallow copy of original object.
  56. *
  57. * Revision 1.19  2004/03/16 15:47:26  vasilche
  58. * Added CBioseq_set_Handle and set of EditHandles
  59. *
  60. * Revision 1.18  2003/09/30 16:21:59  vasilche
  61. * Updated internal object manager classes to be able to load ID2 data.
  62. * SNP blobs are loaded as ID2 split blobs - readers convert them automatically.
  63. * Scope caches results of requests for data to data loaders.
  64. * Optimized CSeq_id_Handle for gis.
  65. * Optimized bioseq lookup in scope.
  66. * Reduced object allocations in annotation iterators.
  67. * CScope is allowed to be destroyed before other objects using this scope are
  68. * deleted (feature iterators, bioseq handles etc).
  69. * Optimized lookup for matching Seq-ids in CSeq_id_Mapper.
  70. * Added 'adaptive' option to objmgr_demo application.
  71. *
  72. * Revision 1.17  2003/08/04 17:04:27  grichenk
  73. * Added default data-source priority assignment.
  74. * Added support for iterating all annotations from a
  75. * seq-entry or seq-annot.
  76. *
  77. * Revision 1.16  2003/06/30 18:41:05  vasilche
  78. * Removed unused commented code.
  79. *
  80. * Revision 1.15  2003/06/19 18:23:44  vasilche
  81. * Added several CXxx_ScopeInfo classes for CScope related information.
  82. * CBioseq_Handle now uses reference to CBioseq_ScopeInfo.
  83. * Some fine tuning of locking in CScope.
  84. *
  85. * Revision 1.13  2003/04/09 16:04:29  grichenk
  86. * SDataSourceRec replaced with CPriorityNode
  87. * Added CScope::AddScope(scope, priority) to allow scope nesting
  88. *
  89. * Revision 1.12  2003/03/26 20:59:22  grichenk
  90. * Removed commented-out code
  91. *
  92. * Revision 1.11  2003/03/11 14:15:49  grichenk
  93. * +Data-source priority
  94. *
  95. * Revision 1.10  2003/01/29 22:03:43  grichenk
  96. * Use single static CSeq_id_Mapper instead of per-OM model.
  97. *
  98. * Revision 1.9  2002/12/26 20:51:35  dicuccio
  99. * Added Win32 export specifier
  100. *
  101. * Revision 1.8  2002/08/28 17:05:13  vasilche
  102. * Remove virtual inheritance
  103. *
  104. * Revision 1.7  2002/06/04 17:18:32  kimelman
  105. * memory cleanup :  new/delete/Cref rearrangements
  106. *
  107. * Revision 1.6  2002/05/28 18:01:10  gouriano
  108. * DebugDump added
  109. *
  110. * Revision 1.5  2002/05/06 03:30:36  vakatov
  111. * OM/OM1 renaming
  112. *
  113. * Revision 1.4  2002/02/21 19:27:00  grichenk
  114. * Rearranged includes. Added scope history. Added searching for the
  115. * best seq-id match in data sources and scopes. Updated tests.
  116. *
  117. * Revision 1.3  2002/01/23 21:59:29  grichenk
  118. * Redesigned seq-id handles and mapper
  119. *
  120. * Revision 1.2  2002/01/16 16:26:36  gouriano
  121. * restructured objmgr
  122. *
  123. * Revision 1.1  2002/01/11 19:04:02  gouriano
  124. * restructured objmgr
  125. *
  126. *
  127. * ===========================================================================
  128. */
  130. #include <corelib/ncbiobj.hpp>
  131. #include <corelib/ncbimtx.hpp>
  133. #include <objmgr/data_loader_factory.hpp>
  135. #include <set>
  136. #include <map>
  138. BEGIN_NCBI_SCOPE
  139. BEGIN_SCOPE(objects)
  142. class CDataSource;
  143. class CDataLoader;
  144. class CDataLoaderFactory;
  145. class CSeq_entry;
  146. class CBioseq;
  147. class CSeq_id;
  148. class CScope;
  149. class CScope_Impl;
  152. /////////////////////////////////////////////////////////////////////////////
  153. // CObjectManager
  156. class NCBI_XOBJMGR_EXPORT CObjectManager : public CObject
  157. {
  158. public:
  159.     CObjectManager(void);
  160.     virtual ~CObjectManager(void);
  162. public:
  163.     typedef CRef<CDataSource> TDataSourceLock;
  164.     typedef int TPriority;
  166. // configuration functions
  167. // this data is always available to scopes -
  168. // by name - in case of data loader
  169. // or by address - in case of Seq_entry
  171.     // whether to put data loader or TSE to the default group or not
  172.     enum EIsDefault {
  173.         eDefault,
  174.         eNonDefault
  175.     };
  176.     enum EPriority {
  177.         kPriority_NotSet = -1
  178.     };
  180.     // Register existing data loader.
  181.     // NOTE:  data loader must be created in the heap (ie using operator new).
  182.     void RegisterDataLoader(CDataLoader& loader,
  183.                             EIsDefault   is_default = eNonDefault,
  184.                             TPriority priority = kPriority_NotSet);
  186.     // Register data loader factory.
  187.     // NOTE:  client has no control on when data loader is created or deleted.
  188.     void RegisterDataLoader(CDataLoaderFactory& factory,
  189.                             EIsDefault          is_default = eNonDefault,
  190.                             TPriority priority = kPriority_NotSet);
  191.     // RegisterDataLoader(*new CSimpleDataLoaderFactory<TDataLoader>(name), ...
  193.     void RegisterDataLoader(TFACTORY_AUTOCREATE factory,
  194.                             const string& loader_name,
  195.                             EIsDefault   is_default = eNonDefault,
  196.                             TPriority priority = kPriority_NotSet);
  199.     // Revoke previously registered data loader.
  200.     // Return FALSE if the loader is still in use (by some scope).
  201.     // Throw an exception if the loader is not registered with this ObjMgr.
  202.     bool RevokeDataLoader(CDataLoader& loader);
  203.     bool RevokeDataLoader(const string& loader_name);
  205.     // Register top-level seq_entry
  206.     //void RegisterTopLevelSeqEntry(CSeq_entry& top_entry);
  208.     //CConstRef<CBioseq> GetBioseq(const CSeq_id& id);
  210.     virtual void DebugDump(CDebugDumpContext ddc, unsigned int depth) const;
  212. protected:
  214. // functions for scopes
  215.     void RegisterScope(CScope_Impl& scope);
  216.     void RevokeScope  (CScope_Impl& scope);
  218.     typedef set<TDataSourceLock> TDataSourcesLock;
  220.     TDataSourceLock AcquireDataLoader(CDataLoader& loader);
  221.     TDataSourceLock AcquireDataLoader(const string& loader_name);
  222.     TDataSourceLock AcquireTopLevelSeqEntry(CSeq_entry& top_entry);
  223.     void AcquireDefaultDataSources(TDataSourcesLock& sources);
  224.     bool ReleaseDataSource(TDataSourceLock& data_source);
  226. private:
  228. // these are for Object Manager itself
  229. // nobody else should use it
  230.     TDataSourceLock x_RegisterTSE(CSeq_entry& top_entry);
  231.     TDataSourceLock x_RegisterLoader(CDataLoader& loader,
  232.                                      TPriority priority,
  233.                                      EIsDefault   is_default = eNonDefault,
  234.                                      bool         no_warning = false);
  235.     CDataLoader* x_GetLoaderByName(const string& loader_name) const;
  236.     TDataSourceLock x_FindDataSource(const CObject* key);
  237.     TDataSourceLock x_RevokeDataLoader(CDataLoader* loader);
  238.     
  239. private:
  241.     typedef set< TDataSourceLock >                  TSetDefaultSource;
  242.     typedef map< string, CDataLoader* >             TMapNameToLoader;
  243.     typedef map< const CObject* , TDataSourceLock > TMapToSource;
  244.     typedef set< CScope_Impl* >                     TSetScope;
  246.     TSetDefaultSource   m_setDefaultSource;
  247.     TMapNameToLoader    m_mapNameToLoader;
  248.     TMapToSource        m_mapToSource;
  249.     TSetScope           m_setScope;
  250.     
  251.     typedef CMutex      TRWLock;
  252.     typedef CMutexGuard TReadLockGuard;
  253.     typedef CMutexGuard TWriteLockGuard;
  255.     mutable TRWLock     m_OM_Lock;
  256.     mutable TRWLock     m_OM_ScopeLock;
  258.     friend class CScope_Impl;
  259.     friend class CDataSource; // To get id-mapper
  260. };
  263. END_SCOPE(objects)
  264. END_NCBI_SCOPE
  266. #endif // OBJECT_MANAGER__HPP