---

CdbBdb2RooPayloadConversionFwk.hh

Go to the documentation of this file.

#ifndef CDBROOCONVERSIONFWK_BDB_2_ROO_PAYLOAD_CONVERSION_FWK_HH
#define CDBROOCONVERSIONFWK_BDB_2_ROO_PAYLOAD_CONVERSION_FWK_HH

// File and Version Information:
//      $Id: CdbBdb2RooPayloadConversionFwk.hh,v 1.4 2005/11/11 02:07:41 gapon Exp $

#include "CdbBase/CdbCPtr.hh"

#include <Rtypes.h>

#include <vector>

class CdbRooConverterBase;
class CdbBdb2RooPayloadConvertersDict;
class CdbRooConverterDict;

/// A simplified interface to the "payload" conversion framework.
/**
  * More details...
  */
class CdbBdb2RooPayloadConversionFwk {

public:

  /// Modify the current value of the "verbose" mode
  /**
    * The method will also return the previous value of the mode.
    */
    static bool setVerbose( bool newModeFlag );

  /// Modify the current value of the "debug" mode
  /**
    * The method will also return the previous value of the mode.
    */
    static bool setDebug( bool newModeFlag );

  /// Modify the current value of the "doNotCompress" mode
  /**
    * The method will also return the previous value of the mode.
    */
    static bool setDoNotCompress( bool newModeFlag );

  /// Register a converter
  /**
    * The operation if successfull will return CdbStatus::Success. Other values will
    * be treated as errors.
    */
    static CdbStatus registerConverter( const CdbCPtr< CdbRooConverterBase >& thePtr );
    static CdbStatus registerConverters( const std::vector< CdbCPtr< CdbRooConverterDict > >& theDicts);

  /// Start a test conversion in a context of the specified MetaData
  /**
    * Test using the "regular" (as opposed to "merging") converters.
    */
    static CdbStatus testConversion( UShort_t theOriginId,
                                     UShort_t theConditionId,
                                     bool     isPartitionableFlag,
                                     UShort_t thePartitionId,
                                     UShort_t theClusterId,
                                     UShort_t theIncrementId );

  /// Start a test conversion in a context of the specified MetaData
  /**
    * Test using the "merging" (as opposed to "regular") converters.
    */
    static CdbStatus testConversion( UShort_t                     theOriginId,
                                     const std::vector<UShort_t>& theConditionId,
                                     bool                         isPartitionableFlag,
                                     UShort_t                     thePartitionId,
                                     UShort_t                     theClusterId,
                                     UShort_t                     theIncrementId );

  /// Start the definition file driven conversion
  /**
    * The method will run the conversion using the specified "defition file" and converters
    * registered using the above defined method. The definition file maps conditions
    * onto persistent classes of the corresponding "payload" objects. Only those conditions
    * whose converters are registered at a time when the conversion start would be converted.
    *
    * Note, this method will employ both "regular" and "merging" converters. A proper
    * parameterization which converter to use for which condition(s) is done via
    * the definition file.
    *
    * The operation if successfull will return CdbStatus::Success. Other values will
    * be treated as errors.
    *
    * @see CdbBdb2RooPayloadConversionFwk::registerConverter()
    */
    static CdbStatus doConversion( const char* theDefinitionFileName );

private:

  /// Convert objects in the context of the specified MetaData
  /**
    * This is a regular conversion version. It uses "regular" (as opposed to "merging")
    * converters.
    */
    static  CdbStatus convertMetadata( UShort_t theOriginId,
                                       UShort_t theConditionId,
                                       bool     isPartitionableFlag,
                                       UShort_t thePartitionId,
                                       UShort_t theClusterId,
                                       UShort_t theIncrementId );

  /// Convert objects in the context of the specified MetaData
  /**
    * This is a regular conversion version. It uses "merging" (as opposed to "regular")
    * converters.
    */
    static  CdbStatus convertMetadata( UShort_t                     theOriginId,
                                       const std::vector<UShort_t>& theConditionId,
                                       bool                         isPartitionableFlag,
                                       UShort_t                     thePartitionId,
                                       UShort_t                     theClusterId,
                                       UShort_t                     theIncrementId );

  /// A dictionary of regular "one-to-one" converters

    static CdbBdb2RooPayloadConvertersDict* regularConvertersDict( );

  /// A dictionary of merging "many-to-one" converters

    static CdbBdb2RooPayloadConvertersDict* mergingConvertersDict( );

private:

    static bool verboseModeFlag;        // default value: true
    static bool debugModeFlag;          // default value: false
    static bool doNotCompressModeFlag;  // default value: false
};

#endif  // CDBROOCONVERSIONFWK_BDB_2_ROO_PAYLOAD_CONVERSION_FWK_HH

---