---

CdbRooRoRegistry.hh

Go to the documentation of this file.

#ifndef CDBBROOREADONLY_REGISTRY_HH
#define CDBBROOREADONLY_REGISTRY_HH

// File and Version Information:
//      $Id: CdbRooRoRegistry.hh,v 1.3 2005/06/23 23:44:46 gapon Exp $

#include "BdbTime/BdbTime.hh"

#include "CdbBase/CdbCPtr.hh"

#include <Rtypes.h>

#include <string>
#include <iostream>

class CdbRooRoRegistryDescriptorR;
class CdbRooRoViewCollectionR;
class CdbRooRoPartitionsLayoutR;


template<class T> class CdbRooRoNameIdCollectionR;

class CdbRooRoOriginR;
typedef CdbRooRoNameIdCollectionR<CdbRooRoOriginR> CdbRooRoOriginCollectionR;

class CdbRooRoClusterR;
typedef CdbRooRoNameIdCollectionR<CdbRooRoClusterR> CdbRooRoClusterCollectionR;

class CdbRooRoRClusterR;
typedef CdbRooRoNameIdCollectionR<CdbRooRoRClusterR> CdbRooRoRClusterCollectionR;

class CdbRooRoConditionR;
typedef CdbRooRoNameIdCollectionR<CdbRooRoConditionR> CdbRooRoConditionCollectionR;

/// A base class for the "Registry"-s of specific types of databases
/**
  * This is an abstract class to be extended & implemented by concrete
  * subclasses.
  *
  * DESIGN NOTE:
  *
  *     At the moment it's a base class of a hierarchy of transient classes providing
  *     a convenience interface to a persistent store.
  */
class CdbRooRoRegistry {

private:

  /// Default constructor (NOT IMPLEMENTED))

    CdbRooRoRegistry( );

protected:

  /// Normal constructor
  /**
    * The "id" of the MASTER database is the same as its creation time.
    * The local collections get created only if the corresponding flag is set up.
    *
    * NOTE:
    *
    *   A resgistry of this class will take an ownership over passed collection objects
    *   and store using "counted smart pointers".
    *
    * @see class CdbCPtr
    */
    CdbRooRoRegistry( const CdbCPtr< CdbRooRoRegistryDescriptorR >&  theDescriptorPtr,             /**< the registry descriptor */
                      const CdbCPtr< CdbRooRoConditionCollectionR >& theConditionCollectionPtr,    /**< the local collection of REGULAR conditions */
                      const CdbCPtr< CdbRooRoViewCollectionR >&      theViewCollectionPtr,         /**< the local collection of views */
                      const CdbCPtr< CdbRooRoRClusterCollectionR >&  theClusterCollectionPtr       /**< th elocal collection of REGULAR clusters */
                    );

public:

  /// Destructor
  /**
    */
    virtual ~CdbRooRoRegistry( );

  // Accessors

    UShort_t originId( ) const;

    const std::string& originName ( ) const;
    const std::string& description( ) const;

    BdbTime created( ) const;
    BdbTime id     ( ) const;

    bool hasLocalCollections( ) const;
    bool isMaster           ( ) const;


  // Local collections

    CdbCPtr< CdbRooRoConditionCollectionR > conditionCollection( ) const;
    CdbCPtr< CdbRooRoViewCollectionR >      viewCollection     ( ) const;
    CdbCPtr< CdbRooRoRClusterCollectionR >  clusterCollection  ( ) const;

  // MASTER-only collections

    virtual CdbCPtr< CdbRooRoOriginCollectionR >  originCollection  ( ) const = 0;
    virtual CdbCPtr< CdbRooRoClusterCollectionR > pClusterCollection( ) const = 0;
    virtual CdbCPtr< CdbRooRoPartitionsLayoutR >  partitionsLayout  ( ) const = 0;

  /// Dump the contents of the object

    virtual void dump( std::ostream& o ) const;

public:

  /// Static locator for the MASTER registry
  /**
    * The method will return CdbStatus::NotFound if the registry is not found.
    */
    static CdbStatus findMaster( CdbCPtr< CdbRooRoRegistry >& theRegistryPtr );

  /// Static locator for the local registry
  /**
    * The "local" registry is the one corresponding to the local origin.
    *
    * The method will return CdbStatus::NotFound if the registry is not found.
    */
    static CdbStatus findLocal( CdbCPtr< CdbRooRoRegistry >& theRegistryPtr );

  /// Static locator for a registry corresponding to specified origin ID
  /**
    * The method will return CdbStatus::NotFound if the registry is not found.
    */
    static CdbStatus findByOrigin( CdbCPtr< CdbRooRoRegistry >& theRegistryPtr,
                                   UShort_t                     theOriginId );

  /// Static locator for a registry corresponding to specified origin name
  /**
    * The locator will also support the following pseudo-names for origins:
    *
    *   "<master>"
    *   "<local>"
    *
    * The method will return CdbStatus::NotFound if the registry is not found.
    */
    static CdbStatus findByOrigin( CdbCPtr< CdbRooRoRegistry >& theRegistryPtr,
                                   const std::string&           theOriginName );

private:

    CdbCPtr< CdbRooRoRegistryDescriptorR >  _registryDescriptorPtr;
    CdbCPtr< CdbRooRoConditionCollectionR > _conditionCollectionPtr;
    CdbCPtr< CdbRooRoViewCollectionR >      _viewCollectionPtr;
    CdbCPtr< CdbRooRoRClusterCollectionR >  _clusterCollectionPtr;
};

#endif /* CDBBROOREADONLY_REGISTRY_HH */

---