dc/d00/DbDatabaseObj_8h_source.html

/*

  Copyright (C) 2002-2022 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/DbAccessObj.h"

#include "StorageSvc/DbDomain.h"

#include "StorageSvc/DbDatabase.h"

#include "StorageSvc/DbContainer.h"


// STL include files

#include <map>

#include <string>

#include <vector>


/*

 *  POOL namespace declaration

 */

namespace pool    {


  // Forward declarations

  class DbToken;


  class DbDatabaseObj : public  DbAccessObj<std::string, DbContainerObj > {

  private:

    typedef RootType                            TypeH;

    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>       ParamMap;

    typedef std::map< Guid , DbToken* >              LinkMap;

    typedef std::vector<DbToken*>                    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<TypeH, const DbTypeInfo*> m_classMap;

    Containers                    m_retiredConts;

    DbTypeInfo*             m_string_t;

    std::string                   m_logon;

    int                           m_fileAge;

    Token*                        m_token;


  private:

    DbStatus cleanup();

  public:

    DbDatabaseObj( DbDomain&          dom,

                   const std::string& pfn,

                   const std::string& fid,

                   DbAccessMode mode = pool::READ);

    virtual ~DbDatabaseObj();

    const std::string& logon() const  {  return m_logon;        }

    long long int size();

    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;        }


    DbStatus open();

    DbStatus reopen(DbAccessMode mode);

    DbStatus close();

    DbStatus retire();

    bool updatesPending() const;

    DbStatus transAct(Transaction::Action action);


    DbStatus read(const Token& token, ShapeH shape, void** object);

    DbStatus getLink(const Token::OID_t& oid, Token* pTok);

    std::string cntName(Token& token);

    DbStatus makeLink(Token* pToken, Token::OID_t& refLink);

    const DbTypeInfo* objectShape(const TypeH& classH);

    const DbTypeInfo* objectShape(const Guid& nam);

    const DbTypeInfo* contShape(const std::string& nam);

    DbStatus addShape (const DbTypeInfo* pType);

    const Token* cntToken(const std::string& cntName);

    DbStatus containers(std::vector<const Token*>& conts, bool intern);

    DbStatus containers(std::vector<IDbContainer*>& conts, bool intern);

    DbStatus associations(std::vector<const Token*>& conts);

    DbStatus shapes(std::vector<const DbTypeInfo*>& shaps);

    int nParam();

    DbStatus addParam(const std::string& nam, const std::string& val);

    DbStatus param(const std::string& nam, std::string& val);

    DbStatus params(std::vector< std::pair<std::string, std::string> >& vals);

    DbStatus setOption(const DbOption& refOpt);

    DbStatus getOption(DbOption& refOpt);


    void setAge(int value);

  };

}       // End namespace pool

#endif  // POOL_DBDATABASEOBJ_H