Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

CdbRooRoRegistry Class Reference

A base class for the "Registry"-s of specific types of databases. More...

#include <CdbRooRoRegistry.hh>

Inheritance diagram for CdbRooRoRegistry:

CdbRooRoMasterRegistry CdbRooRoSlaveRegistry CdbRooRoTestRegistry List of all members.

Public Member Functions

virtual ~CdbRooRoRegistry ()
 Destructor.

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
CdbCPtr< CdbRooRoConditionCollectionRconditionCollection () const
CdbCPtr< CdbRooRoViewCollectionRviewCollection () const
CdbCPtr< CdbRooRoRClusterCollectionRclusterCollection () const
virtual CdbCPtr< CdbRooRoOriginCollectionRoriginCollection () const=0
virtual CdbCPtr< CdbRooRoClusterCollectionRpClusterCollection () const=0
virtual CdbCPtr< CdbRooRoPartitionsLayoutRpartitionsLayout () const=0
virtual void dump (std::ostream &o) const
 Dump the contents of the object.


Static Public Member Functions

CdbStatus findMaster (CdbCPtr< CdbRooRoRegistry > &theRegistryPtr)
 Static locator for the MASTER registry.

CdbStatus findLocal (CdbCPtr< CdbRooRoRegistry > &theRegistryPtr)
 Static locator for the local registry.

CdbStatus findByOrigin (CdbCPtr< CdbRooRoRegistry > &theRegistryPtr, UShort_t theOriginId)
 Static locator for a registry corresponding to specified origin ID.

CdbStatus findByOrigin (CdbCPtr< CdbRooRoRegistry > &theRegistryPtr, const std::string &theOriginName)
 Static locator for a registry corresponding to specified origin name.


Protected Member Functions

 CdbRooRoRegistry (const CdbCPtr< CdbRooRoRegistryDescriptorR > &theDescriptorPtr, const CdbCPtr< CdbRooRoConditionCollectionR > &theConditionCollectionPtr, const CdbCPtr< CdbRooRoViewCollectionR > &theViewCollectionPtr, const CdbCPtr< CdbRooRoRClusterCollectionR > &theClusterCollectionPtr)
 Normal constructor.


Detailed Description

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.

Definition at line 45 of file CdbRooRoRegistry.hh.


Constructor & Destructor Documentation

CdbRooRoRegistry::CdbRooRoRegistry const CdbCPtr< CdbRooRoRegistryDescriptorR > &    theDescriptorPtr,
const CdbCPtr< CdbRooRoConditionCollectionR > &    theConditionCollectionPtr,
const CdbCPtr< CdbRooRoViewCollectionR > &    theViewCollectionPtr,
const CdbCPtr< CdbRooRoRClusterCollectionR > &    theClusterCollectionPtr
[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 also:
class CdbCPtr
Parameters:
theDescriptorPtr  the registry descriptor
theConditionCollectionPtr  the local collection of REGULAR conditions
theViewCollectionPtr  the local collection of views
theClusterCollectionPtr  th elocal collection of REGULAR clusters

Definition at line 92 of file CdbRooRoRegistry.cc.

References CdbCPtr< CdbRooRoViewCollectionR >::isNull(), CdbCPtr< CdbRooRoConditionCollectionR >::isNull(), and CdbCPtr< CdbRooRoRegistryDescriptorR >::isNull().

CdbRooRoRegistry::~CdbRooRoRegistry   [virtual]
 

Destructor.

Definition at line 115 of file CdbRooRoRegistry.cc.


Member Function Documentation

CdbCPtr< CdbRooRoRClusterCollectionR > CdbRooRoRegistry::clusterCollection   const
 

Definition at line 173 of file CdbRooRoRegistry.cc.

CdbCPtr< CdbRooRoConditionCollectionR > CdbRooRoRegistry::conditionCollection   const
 

Definition at line 161 of file CdbRooRoRegistry.cc.

BdbTime CdbRooRoRegistry::created   const
 

Definition at line 137 of file CdbRooRoRegistry.cc.

Referenced by dump().

const std::string & CdbRooRoRegistry::description   const
 

Definition at line 131 of file CdbRooRoRegistry.cc.

Referenced by dump().

void CdbRooRoRegistry::dump std::ostream &    o const [virtual]
 

Dump the contents of the object.

Definition at line 179 of file CdbRooRoRegistry.cc.

References created(), description(), hasLocalCollections(), id(), isMaster(), originId(), originName(), and CdbTimeUtils::time2string().

CdbStatus CdbRooRoRegistry::findByOrigin CdbCPtr< CdbRooRoRegistry > &    theRegistryPtr,
const std::string &    theOriginName
[static]
 

Static locator for a registry corresponding to specified origin name.

The locator will also support the following pseudo-names for origins:

"" ""

The method will return CdbStatus::NotFound if the registry is not found.

Definition at line 364 of file CdbRooRoRegistry.cc.

References CdbStatus::Error, findByOrigin(), findLocal(), findMaster(), CdbRooRoOriginR::id(), CdbRooRoFileUtils::instance(), CdbRooRoFileUtils::localOriginName(), and CdbStatus::Success.

CdbStatus CdbRooRoRegistry::findByOrigin CdbCPtr< CdbRooRoRegistry > &    theRegistryPtr,
UShort_t    theOriginId
[static]
 

Static locator for a registry corresponding to specified origin ID.

The method will return CdbStatus::NotFound if the registry is not found.

Definition at line 244 of file CdbRooRoRegistry.cc.

References CdbStatus::Error, CdbRooRoFileUtils::findDatabase(), CdbRooRoFileUtils::instance(), CdbCPtr< CdbRooRoRegistry >::isNull(), CdbRooRoFileUtils::nameOfSystemContainer(), CdbRooRoFileUtils::registry(), CdbRooRoFileUtils::setRegistry(), and CdbStatus::Success.

Referenced by findByOrigin(), CdbRooRoFolder::findCondition(), CdbRooRoDatabase::findCondition(), findLocal(), findMaster(), CdbRooRoDatabase::findPartition(), CdbRooRoDatabase::findView(), CdbRooRoDatabase::partitionIterator(), and CdbRooRoDatabase::physicalConditionIterator().

CdbStatus CdbRooRoRegistry::findLocal CdbCPtr< CdbRooRoRegistry > &    theRegistryPtr [static]
 

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.

Definition at line 198 of file CdbRooRoRegistry.cc.

References CdbStatus::Error, findByOrigin(), findMaster(), CdbRooRoFileUtils::instance(), CdbRooRoFileUtils::localOriginId(), CdbRooRoFileUtils::localOriginName(), CdbRooRoOriginR::name(), and CdbStatus::Success.

Referenced by findByOrigin(), and CdbRooRoDatabase::open().

CdbStatus CdbRooRoRegistry::findMaster CdbCPtr< CdbRooRoRegistry > &    theRegistryPtr [static]
 

Static locator for the MASTER registry.

The method will return CdbStatus::NotFound if the registry is not found.

Definition at line 191 of file CdbRooRoRegistry.cc.

References findByOrigin().

Referenced by findByOrigin(), findLocal(), and CdbRooRoDatabase::open().

bool CdbRooRoRegistry::hasLocalCollections   const
 

Definition at line 149 of file CdbRooRoRegistry.cc.

Referenced by dump().

BdbTime CdbRooRoRegistry::id   const
 

Definition at line 143 of file CdbRooRoRegistry.cc.

Referenced by dump().

bool CdbRooRoRegistry::isMaster   const
 

Definition at line 155 of file CdbRooRoRegistry.cc.

Referenced by dump().

virtual CdbCPtr< CdbRooRoOriginCollectionR > CdbRooRoRegistry::originCollection   const [pure virtual]
 

Implemented in CdbRooRoMasterRegistry, CdbRooRoSlaveRegistry, and CdbRooRoTestRegistry.

UShort_t CdbRooRoRegistry::originId   const
 

Definition at line 119 of file CdbRooRoRegistry.cc.

Referenced by dump().

const std::string & CdbRooRoRegistry::originName   const
 

Definition at line 125 of file CdbRooRoRegistry.cc.

Referenced by dump().

virtual CdbCPtr< CdbRooRoPartitionsLayoutR > CdbRooRoRegistry::partitionsLayout   const [pure virtual]
 

Implemented in CdbRooRoMasterRegistry, CdbRooRoSlaveRegistry, and CdbRooRoTestRegistry.

virtual CdbCPtr< CdbRooRoClusterCollectionR > CdbRooRoRegistry::pClusterCollection   const [pure virtual]
 

Implemented in CdbRooRoMasterRegistry, CdbRooRoSlaveRegistry, and CdbRooRoTestRegistry.

CdbCPtr< CdbRooRoViewCollectionR > CdbRooRoRegistry::viewCollection   const
 

Definition at line 167 of file CdbRooRoRegistry.cc.


The documentation for this class was generated from the following files:
Generated on Mon Dec 5 18:22:25 2005 for CDB by doxygen1.3-rc3