lds_loader.hpp

来自「ncbi源码」· HPP 代码 · 共 166 行

/*
 * ===========================================================================
 * PRODUCTION $Log: lds_loader.hpp,v $
 * PRODUCTION Revision 1000.3  2004/06/01 20:58:10  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.13
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_PLUGINS_DOC_BASIC___LDS_LOADER__HPP
#define GUI_PLUGINS_DOC_BASIC___LDS_LOADER__HPP

/*  $Id: lds_loader.hpp,v 1000.3 2004/06/01 20:58:10 gouriano Exp $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Authors:  Anatoliy Kuznetsov
 *
 * File Description:
 *    CDataPlugin_LDSLoader - load sequence information from the local data storage(LDS).
 */

#include <gui/core/doc_loader.hpp>

#include <objmgr/scope.hpp>

#include <objtools/lds/lds.hpp>
#include <objtools/lds/lds_set.hpp>
#include <objtools/lds/lds_query.hpp>


BEGIN_NCBI_SCOPE

BEGIN_SCOPE(objects)
  class CLDS_Database;
END_SCOPE(objects)


//////////////////////////////////////////////////////////////////
//
// LDS document loader for Genome Workbench.
//

class CDataPlugin_LDSLoader : public CDocLoader<CDataPlugin_LDSLoader>
{
public:

    CDataPlugin_LDSLoader();
    ~CDataPlugin_LDSLoader();

    // load a given document
    void Load(objects::CPluginMessage& msg);

    // Search command
    void Search(objects::CPluginMessage& msg);

    static void GetInfo(objects::CPluginInfo& info);

private:

    // Open document, return "TRUE" if success, insert loaded object's id 
    // into the obj_read set
    bool x_LoadLDS_BioTSE(int                     object_id,
                          objects::CLDS_Database* db, 
                          objects::CLDS_Set*      obj_read,
                          objects::CPluginReply&  reply);

    // Open document, return "TRUE" if success, insert loaded object's id 
    // into the obj_read set
    bool x_LoadLDS_Annot(const objects::CLDS_Query::SObjectDescr& obj_descr,
                         objects::CLDS_Database*                  db,  
                         objects::CLDS_Set*                       obj_read,
                         objects::CPluginReply&                   reply);

    // Check the object type, if it's one of the known ones, load it as a 
    // molecule or an annotation
    bool x_Load(const objects::CLDS_Query::SObjectDescr& obj_descr,
                objects::CLDS_Database*                  db,
                objects::CLDS_Set*                       obj_read,
                objects::CPluginReply&                   reply);

private:
    objects::CLDS_DatabaseHolder*  m_DbHolder;

};


END_NCBI_SCOPE


/*
 * ===========================================================================
 * $Log: lds_loader.hpp,v $
 * Revision 1000.3  2004/06/01 20:58:10  gouriano
 * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.13
 *
 * Revision 1.13  2004/05/25 17:21:59  dicuccio
 * Modified class names.  Fonts to 12 point
 *
 * Revision 1.12  2003/11/18 17:49:02  dicuccio
 * Added standard processing of return values
 *
 * Revision 1.11  2003/11/06 20:12:15  dicuccio
 * Cleaned up handling of USING_SCOPE - removed from all headers
 *
 * Revision 1.10  2003/11/04 17:49:25  dicuccio
 * Changed calling parameters for plugins - pass CPluginMessage instead of paired
 * CPluginCommand/CPluginReply
 *
 * Revision 1.9  2003/10/28 14:21:01  kuznets
 * Chages to lds loader to support multiple LDS databases
 *
 * Revision 1.8  2003/09/29 15:39:10  dicuccio
 * Header file clean-up.  Deprecated gui/scope.hpp and gui/core/types.hpp.  Added
 * GenBank data loader management dialog
 *
 * Revision 1.7  2003/08/07 20:31:35  kuznets
 * Implemented document opening based on lds_search_dlg selection
 *
 * Revision 1.6  2003/08/05 17:16:25  kuznets
 * Changes to improve code reuse between loaders + CLDS_Database passed as the
 * construction parameter to the lds search dialog
 *
 * Revision 1.5  2003/07/15 17:57:08  kuznets
 * Added annotaion/alignment search capabilities
 *
 * Revision 1.4  2003/07/14 11:17:00  shomrat
 * Plugin messageing system related changes
 *
 * Revision 1.3  2003/07/01 19:29:14  kuznets
 * Open command implementation
 *
 * Revision 1.2  2003/06/20 14:52:57  dicuccio
 * Revised plugin registration - moved GetInfo() into the plugin handler
 *
 * Revision 1.1  2003/06/17 20:16:09  kuznets
 * Initial revision.
 *
 *
 * ===========================================================================
 */


#endif  // GUI_PLUGINS_DOC_BASIC___LDS_LOADER__HPP