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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: lds_admin.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 21:01:14  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.6
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef LDS_ADMIN_HPP__
  10. #define LDS_ADMIN_HPP__
  11. /*  $Id: lds_admin.hpp,v 1000.0 2003/10/29 21:01:14 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: Anatoliy Kuznetsov
  37.  *
  38.  * File Description: LDS data management(admin) include file.
  39.  *
  40.  */
  41. #include <objtools/lds/lds.hpp>
  42. #include <objtools/lds/admin/lds_object.hpp>
  43. BEGIN_NCBI_SCOPE
  44. BEGIN_SCOPE(objects)
  45. //////////////////////////////////////////////////////////////////
  46. //
  47. // LDS database maintanance(modification).
  48. //
  49. class NCBI_LDS_EXPORT CLDS_Management
  50. {
  51. public:
  52.     CLDS_Management(CLDS_Database& db);
  53.     /// Create the database. If the LDS database already exists all data will
  54.     /// be cleaned up.
  55.     void Create();
  56.     /// Recursive scanning of directories in LDS database
  57.     enum ERecurse {
  58.         eDontRecurse,
  59.         eRecurseSubDirs
  60.     };
  61.     /// CRC32 calculation mode
  62.     enum EComputeControlSum {
  63.         eNoControlSum,
  64.         eComputeControlSum
  65.     };
  66.     /// Syncronize LDS database content with directory. 
  67.     /// The main workhorse function.
  68.     /// Function will do format guessing, files parsing, etc
  69.     /// Current implementation can work with only one directory.
  70.     /// If file is removed all relevant objects are cleaned up too.
  71.     /// @param dir_name
  72.     ///   directory to syncronize with
  73.     /// @param recurse
  74.     ///   subdirectories recursion mode
  75.     /// @param control_sum
  76.     ///   control sum computation
  77.     void SyncWithDir(const string&      dir_name, 
  78.                      ERecurse           recurse = eRecurseSubDirs,
  79.                      EComputeControlSum control_sum = eComputeControlSum);
  80.     // Function tries to open the database, if the database does not exist
  81.     // creates it and loads all the data.
  82.     // Return pointer on new CLDS_Database object 
  83.     // (caller is responsible for the destruction).
  84.     // is_created parameter receives TRUE if the database was created by 
  85.     // the method.
  86.     static CLDS_Database* 
  87.         OpenCreateDB(const string& dir_name,
  88.                      const string& db_name,
  89.                      bool*         is_created,
  90.                      ERecurse recurse = eRecurseSubDirs,
  91.                      EComputeControlSum control_sum = eComputeControlSum);
  92. private:
  93.     CLDS_Database&   m_lds_db; // LDS database object
  94. };
  95. END_SCOPE(objects)
  96. END_NCBI_SCOPE
  97. #endif
  98. /*
  99.  * ===========================================================================
  100.  * $Log: lds_admin.hpp,v $
  101.  * Revision 1000.0  2003/10/29 21:01:14  gouriano
  102.  * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.6
  103.  *
  104.  * Revision 1.6  2003/10/09 18:11:27  kuznets
  105.  * Create() reimplemented.
  106.  *
  107.  * Revision 1.5  2003/10/06 20:15:47  kuznets
  108.  * Added support for sub directories and option to disable CRC32 for files
  109.  *
  110.  * Revision 1.4  2003/07/03 18:04:25  kuznets
  111.  * + newline at the end of the file to make GCC happy
  112.  *
  113.  * Revision 1.3  2003/06/25 18:27:47  kuznets
  114.  * +OpenCreateDB() class method
  115.  *
  116.  * Revision 1.2  2003/06/16 16:24:16  kuznets
  117.  * Fixed #include paths (lds <-> lds_admin separation)
  118.  *
  119.  * Revision 1.1  2003/06/16 14:54:08  kuznets
  120.  * lds splitted into "lds" and "lds_admin"
  121.  *
  122.  * 
  123. */