DbDatabaseObj.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
//====================================================================
//  DbDatabaseObj object definition
//--------------------------------------------------------------------
//
//  Package    : System (The POOL project)
//
//  Description: Generic data persistency
//
//  @author      M.Frank
//====================================================================
#ifndef POOL_DBDATABASEOBJ_H
#define POOL_DBDATABASEOBJ_H 1
 
// We need the definition of the domain for defining the Database
#include "PersistentDataModel/Guid.h"
#include "StorageSvc/DbDomain.h"
#include "StorageSvc/DbDatabase.h"
#include "StorageSvc/DbContainer.h"
#include "StorageSvc/DbPrint.h"
#include "DbAccessObj.h"
 
// STL include files
#include <map>
#include <string>
#include <vector>
 
 
/*
 *  POOL namespace declaration
 */
namespace pool    {

  class DbDatabaseObj : public  DbAccessObj<std::string, DbContainerObj >, public APRMessaging {
  private:
    typedef std::pair<std::string, std::string>      Parameter;
    typedef std::vector< Parameter >                 Parameters;
    typedef std::vector< DbContainerObj >            Containers;
    typedef std::map<std::string, std::string, std::less<>>       ParamMap;
    typedef std::map< Guid , Token* >                LinkMap;
    typedef std::vector<Token*>                      LinkVector;
    typedef std::map< Guid , const DbTypeInfo* >     ShapeMap;
    typedef std::map< long long int , int >          IndexMap;
    typedef DbAccessObj<std::string, DbContainerObj > Base;
     
    DbDomain                      m_dom;
    DbContainer                   m_links;
    DbContainer                   m_shapes;
    DbContainer                   m_params;
    IDbDatabase*                  m_info;
    LinkMap                       m_linkMap;
    LinkVector                    m_linkVec;
    IndexMap                      m_indexMap;
    ShapeMap                      m_shapeMap;
    ParamMap                      m_paramMap;
    std::map<RootType, const DbTypeInfo*> m_classMap;
    Containers                    m_retiredConts;
    const DbTypeInfo*             m_string_t;
    std::string                   m_logon;
    int                           m_fileAge;
    Token*                        m_token;
 
  private:
    void cleanup();
    
  public:
    DbDatabaseObj( DbDomain&          dom,
                   const std::string& pfn,
                   const std::string& fid,
                   Io::IoFlag mode = Io::READ);
    virtual ~DbDatabaseObj();
    const std::string& logon() const  {  return m_logon;        }
    long long int size() const;
    IDbDatabase* info()               {  return m_info;         }
    const IDbDatabase* info() const   {  return m_info;         }
    DbDomain& domain()                {  return m_dom;          }
    const DbDomain& domain() const    {  return m_dom;          }
    int  age()  const                 {  return m_fileAge;      }
    const Token* token() const        {  return m_token;        }

    StatusCode open();
    StatusCode close();
    StatusCode retire();
    StatusCode transAct(Transaction::Action action);

    StatusCode read(const Token& token, ShapeH shape, void** object);
    std::string cntName(Token& token) const;
    StatusCode makeLink(Token* pToken, Token::OID_t& refLink);
    const DbTypeInfo* objectShape(const RootType& classH) const;
    const DbTypeInfo* objectShape(const Guid& nam) const;
    const DbTypeInfo* contShape(const std::string& nam) const;
    StatusCode addShape (const DbTypeInfo* pType);
    const Token* cntToken(const std::string& cntName);
    StatusCode containers(std::vector<const Token*>& conts, bool intern);
    StatusCode containers(std::vector<IDbContainer*>& conts, bool intern);
    StatusCode addParam(const std::string& nam, const std::string& val);
    StatusCode param(const std::string& nam, std::string& val) const;
    StatusCode setOption(const DbOption& refOpt);
    StatusCode getOption(DbOption& refOpt);

    void setAge(int value);
  };
}       // End namespace pool
#endif  // POOL_DBDATABASEOBJ_H