DbiWriter.h

Go to the documentation of this file.

#ifndef DBIWRITER_H
#define DBIWRITER_H

#include <list>
#include <string>

#include "DatabaseInterface/Dbi.h"
#include "DatabaseInterface/DbiLogEntry.h"
#include "DatabaseInterface/DbiTableProxyRegistry.h"
#include "Context/ContextRange.h"
#include "Context/TimeStamp.h"

class DbiSqlValPacket;
class DbiTableProxy;
class DbiValidityRec;

template <class T> class DbiWriter
{

public:

// Constructors and destructors.
           DbiWriter();
           DbiWriter(const ContextRange& vr,
                     Int_t aggNo,
                     Dbi::SubSite subsite,
                     Dbi::Task task,
                     TimeStamp versionDate,
                     const std::string& dbName,
                     const std::string& logComment = "",
                     const std::string& tableName = "");
           DbiWriter(const ContextRange& vr,
                     Int_t aggNo,
                     Dbi::SubSite subsite = 0,
                     Dbi::Task task = 0,
                     TimeStamp versionDate = TimeStamp(0,0),
                     UInt_t dbNo = 0,
                     const std::string& logComment = "",
                     const std::string& tableName = "");
           DbiWriter(const DbiValidityRec& vrec,
                     const std::string& dbName,
                     const std::string& logComment = "");
           DbiWriter(const DbiValidityRec& vrec,
                     UInt_t dbNo = 0,
                     const std::string& logComment = "");

  virtual ~DbiWriter();

       void Init(); 

// State testing member functions

       DbiTableProxy& TableProxy() const;

          Bool_t IsOpen(Bool_t reportErrors = kTRUE) const;
          Bool_t CanOutput(Bool_t reportErrors = kTRUE) const;
//     Number of SQL statements collected 
          UInt_t GetNumSqlStmts() const;
//     ValidityRec, exposed for debugging
          DbiValidityRec* GetValidityRec() const;
//     SEQNO from the last Close, exposed for debugging 
          UInt_t GetLastSeqnoClosed() const;

// State changing member functions

    void SetDbNo(UInt_t dbNo) { fDbNo = dbNo;}
    void SetDbName(const string& dbName);
    void SetLogComment(const std::string& reason);
    // For setting of requireGlobal see DbiCascader::AllocateSeqNo
    void SetRequireGlobalSeqno(Int_t requireGlobal) {fRequireGlobalSeqno = requireGlobal;}
    void SetOverlayVersionDate() {fUseOverlayVersionDate = kTRUE;}
    
    // avoid versiondate crowding on the very first TIMESTART in always overlaying situation 
    //
    void   SetTimeStartFlooredVersionDate(Bool_t tfvd){ fTimeStartFlooredVersionDate = tfvd;}
    Bool_t GetTimeStartFlooredVersionDate(){     return fTimeStartFlooredVersionDate ; }

    //  switch on versionDate uniqing 
    //
    void SetRequireUniqueVersionDate(Bool_t requireUnique ){fRequireUniqueVersionDate = requireUnique ; } 
    Bool_t GetRequireUniqueVersionDate(){ return fRequireUniqueVersionDate ; } 
    //  
    //  versionDate uniqing config, 
    //     ctor defaults are full masks for the safest uniqing
    //     if will never need to read from a wider context than are writing into 
    //     then setting the uniqing masks to zero will perform uniqing only within 
    //     the specific written contexts 
    //
    void SetUniqueVersionDateSiteMask(UInt_t siteMask){fUniqueVersionDateSiteMask = siteMask ; } 
    void SetUniqueVersionDateSimMask( UInt_t simMask){ fUniqueVersionDateSimMask  = simMask ; } 
    UInt_t GetUniqueVersionDateSiteMask(){ return fUniqueVersionDateSiteMask ; } 
    UInt_t GetUniqueVersionDateSimMask(){  return fUniqueVersionDateSimMask  ; } 


//  I/O functions
  void Abort() { Reset(); }
  Bool_t Close(const char* fileSpec=0);
  Bool_t Open(const ContextRange& vr,
            Int_t aggNo,
            Dbi::SubSite subsite,
            Dbi::Task task,
            TimeStamp versionDate,
            const string& dbName,
            const std::string& logComment = "");
   Bool_t Open(const ContextRange& vr,
            Int_t aggNo,
            Dbi::SubSite subsite = 0,
            Dbi::Task task = 0,
            TimeStamp versionDate = TimeStamp(),
            UInt_t dbNo = 0,
            const std::string& logComment = "");
 Bool_t Open(const DbiValidityRec& vrec,
             const string& dbName,
             const std::string& logComment = "");
 Bool_t Open(const DbiValidityRec& vrec,
              UInt_t dbNo = 0,
              const std::string& logComment = "");

  DbiWriter<T>& operator<<(const T& row);

private:  

// State testing member functions

  Bool_t NeedsLogEntry() const;
  Bool_t WritingToMaster() const;

// State changing member functions

DbiWriter(const DbiWriter&); // Forbidden
DbiWriter& operator=(const DbiWriter&); // Forbidden

    void CompleteOpen(UInt_t dbNo = 0,
                      const std::string& logComment = "");
    void Reset();

static DbiTableProxy& GetTableProxy();
static DbiTableProxy& GetTableProxy(const std::string& tableName);

// Data members

  Int_t fAggregateNo;   

  UInt_t fDbNo;          

  DbiSqlValPacket* fPacket;        

  Int_t fRequireGlobalSeqno;     

  DbiTableProxy* fTableProxy;    

  std::string fTableName;     

  Bool_t fUseOverlayVersionDate;

  DbiValidityRec* fValidRec;      

  DbiLogEntry fLogEntry;      

  UInt_t fLastSeqnoClosed;

  Bool_t fRequireUniqueVersionDate ;
  
  UInt_t fUniqueVersionDateSiteMask ; 

  UInt_t fUniqueVersionDateSimMask ; 

  Bool_t fTimeStartFlooredVersionDate ; 


// Removed: ClassDefT(DbiWriter<T>,0)          // Writer for specific database table. 

};
// Removed: ClassDefT2(DbiWriter,T)

#endif  // DBIWRITER_H