IStorageExplorer.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
 
//====================================================================
// $Id: IStorageExplorer.h 726071 2016-02-25 09:23:05Z krasznaa $
//
//  Package    : pool/StorageSvc (The pool framework)
//
//  @author      M.Frank
//
//====================================================================
// $Header: /cvs/PF/pool/StorageSvc/StorageSvc/IStorageExplorer.h,v 1.19 2010/05/18 09:45:51 avalassi Exp $
#ifndef POOL_ISTORAGEEXPLORER_H
#define POOL_ISTORAGEEXPLORER_H
 
// Framework include files
#include "StorageSvc/DbStatus.h"
#include "StorageSvc/DbDatabase.h"
 
// STL include files
#include <string>
#include <vector>
#include <utility>
 
class Guid;
class Token;
 
/*
 *      pool namespace declaration
 */
namespace pool  {
 
  // Forward declarations
  typedef class Session     *SessionH;
  typedef const class Shape *ShapeH;
  class FileDescriptor;
  class DbSelect;
  class DbOption;

  class IStorageExplorer   {
  protected:
    virtual ~IStorageExplorer()   {     }
 
  public:
    typedef std::pair<std::string, std::string>   Parameter;
    typedef std::vector< Parameter >              Parameters;

    static const Guid& interfaceID();

    virtual DbStatus queryInterface(const Guid& riid, void** ppvUnkn) = 0;

    virtual unsigned int addRef() = 0;

    virtual unsigned int release() = 0;


    virtual DbStatus startSession(int                 mode,
                                  int                 tech,
                                  SessionH&           session) = 0;


    virtual DbStatus endSession(  const SessionH           session) = 0;


    virtual DbStatus connect(     const SessionH      sessionH, 
                                  int                 mode,
                                  FileDescriptor&     refDB) = 0;


    virtual DbStatus disconnect(    FileDescriptor&     refDB) = 0;


    virtual DbStatus containers(  FileDescriptor&            refDB,
                                  std::vector<const Token*>& conts,
                                  bool                       intern=false) = 0;


    virtual DbStatus dbParam(     FileDescriptor&            refDB,
                                  const std::string&         nam, 
                                  std::string&               val) = 0;


    virtual DbStatus getDomainOption(const SessionH  sessionH, 
                                     DbOption&       opt) = 0;


    virtual DbStatus setDomainOption(const SessionH  sessionH, 
                                     const DbOption& opt) = 0;


    virtual DbStatus getDatabaseOption(FileDescriptor& refDB,
                                       DbOption& opt) = 0;


    virtual DbStatus setDatabaseOption(FileDescriptor& refDB,
                                       const DbOption& opt) = 0;


    virtual DbStatus getContainerOption(FileDescriptor& refDB,
                                        const std::string& cntName,
                                        DbOption& opt) = 0;


    virtual DbStatus setContainerOption(FileDescriptor& refDB,
                                        const std::string& cntName,
                                        const DbOption& opt) = 0;


    virtual DbStatus select(      FileDescriptor&       refDB,
                                  const std::string&    cntName,
                                  DbSelect&             sel) = 0;


    virtual DbStatus next(DbSelect& context, Token*& refpTok) = 0;
  };
}       // End namespace pool
#endif  // POOL_ISTORAGEEXPLORER_H