IOVEditor.h

Go to the documentation of this file.

#ifndef CondCore_CondDB_IOVEditor_h
#define CondCore_CondDB_IOVEditor_h
//
// Package:     CondDB
// Class  :     IOVEditor
//
//
// Author:      Giacomo Govi
// Created:     Apr 2013
//

#include "CondCore/CondDB/interface/Time.h"
#include "CondCore/CondDB/interface/Types.h"
//
#include <boost/date_time/posix_time/posix_time.hpp>

namespace cond {

  namespace persistency {

    class SessionImpl;
    class IOVEditorData;

    // value semantics...
    class IOVEditor {
    public:
      IOVEditor();
      // ctor
      explicit IOVEditor(const std::shared_ptr<SessionImpl>& session);

      // ctor used after new tag creation. the specified params are assumed and passed directly to the object.
      IOVEditor(const std::shared_ptr<SessionImpl>& session,
                const std::string& tag,
                cond::TimeType timeType,
                const std::string& payloadType,
                cond::SynchronizationType synchronizationType,
                const boost::posix_time::ptime& creationTime = boost::posix_time::microsec_clock::universal_time());

      //
      IOVEditor(const IOVEditor& rhs);

      //
      IOVEditor& operator=(const IOVEditor& rhs);

      //
      ~IOVEditor();

      // loads to tag to edit
      void load(const std::string& tag);

      // read only getters. they could be changed to return references...
      std::string tag() const;
      cond::TimeType timeType() const;
      std::string payloadType() const;

      // getters/setters for the updatable parameters
      cond::SynchronizationType synchronizationType() const;
      void setSynchronizationType(cond::SynchronizationType synchronizationType);

      cond::Time_t endOfValidity() const;
      void setEndOfValidity(cond::Time_t validity);

      std::string description() const;
      void setDescription(const std::string& description);

      cond::Time_t lastValidatedTime() const;
      void setLastValidatedTime(cond::Time_t time);

      // register a new insertion.
      // if checkType==true, the payload corresponding to the specified id is verified to be the same type as the iov payloadObjectType
      void insert(cond::Time_t since, const cond::Hash& payloadHash, bool checkType = false);
      void insert(cond::Time_t since,
                  const cond::Hash& payloadHash,
                  const boost::posix_time::ptime& insertionTime,
                  bool checkType = false);

      // register a new deletion.
      void erase(cond::Time_t since, const cond::Hash& payloadHash);

      // execute the update/intert queries and reset the buffer
      bool flush();
      bool flush(const boost::posix_time::ptime& operationTime);
      bool flush(const std::string& logText);
      bool flush(const std::string& logText, bool forceInsertion);

      bool isLocked() const;
      void lock();
      void unlock();

    private:
      bool flush(const std::string& logText, const boost::posix_time::ptime& operationTime, bool forceInsertion);
      void checkTransaction(const std::string& ctx);

    private:
      std::shared_ptr<IOVEditorData> m_data;
      std::shared_ptr<SessionImpl> m_session;
    };

  }  // namespace persistency
}  // namespace cond

#endif