IDbContainer.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
//
//  Package    : pool/StorageSvc (The pool framework)
//
//  @author      M.Frank
//
//====================================================================
#ifndef POOL_IDBCONTAINER_H
#define POOL_IDBCONTAINER_H
 
// Framework include files
#include "PersistentDataModel/Token.h"
#include "StorageSvc/DbObject.h"
#include "StorageSvc/Transaction.h"
 
#include <vector>
#include <cstdint>
 
/*
 *   POOL namespace declaration
 */
namespace pool    {
 
  // Forward declarations
  class DbTypeInfo;
  class DbDatabase;
  class DbContainer;
  class DataCallBack;
  class DbOption;
  class DbSelect;
 
  typedef const class Shape        *ShapeH;
 
  class IDbContainer    {
  protected:
    virtual ~IDbContainer()   {     }
 
  public:
    virtual void release() = 0;
    virtual uint64_t size() = 0;
    virtual std::string name() const = 0;
    virtual DbStatus setOption(const DbOption& refOpt) = 0;
    virtual DbStatus getOption(DbOption& refOpt) = 0;
    virtual void* allocate( unsigned long siz, 
                            DbContainer&  cntH,
                            ShapeH shape) = 0; 
    virtual DbStatus allocate(DbContainer& cntH, 
                              const void* object,
                              ShapeH shape, 
                              Token::OID_t& oid) = 0;
    virtual DbStatus free(  void* ptr,
                            DbContainer&  cntH) = 0;
 
    virtual uint64_t nextRecordId() = 0;
    virtual void useNextRecordId(uint64_t) = 0;
 
    virtual DbStatus close() = 0;
    virtual DbStatus open(  DbDatabase&        dbH, 
                            const std::string& nam, 
                            const DbTypeInfo* info, 
                            DbAccessMode mode) = 0;
    virtual DbStatus checkAccess(DbDatabase&        dbH,
                                 const std::string& nam) const = 0;
    virtual DbStatus select(DbSelect& sel) = 0;
    virtual DbStatus fetch(DbSelect& sel) = 0;
 
 
    virtual DbStatus load( void** ptr, ShapeH shape, 
                           const Token::OID_t& lnkH, 
                           Token::OID_t&       oid,
                           bool                any_next=false) = 0;
 
 
    virtual DbStatus save(  DbContainer&  cntH,
                            const void* object,
                            ShapeH shape, 
                            Token::OID_t& linkH) = 0;
 
    virtual DbStatus save(  DbObjectHandle<DbObject>& objH) = 0;
 
    virtual DbStatus update(DbContainer&  cntH,
                            const void* object,
                            ShapeH shape, 
                            const DbObjectHandle<DbObject>& objH) = 0;
 
 
    virtual DbStatus update(DbContainer&  cntH,
                            const void* object,
                            ShapeH shape, 
                            const Token::OID_t& linkH) = 0;
 
 
    virtual DbStatus destroy( const Token::OID_t& linkH) = 0;
 
    virtual DbStatus transAct(Transaction::Action) = 0;
 
    virtual bool updatesPending() const = 0;
  };
}      // End namespace pool
#endif // POOL_IDBCONTAINER_H