---

CdbRooRoViewR.cc

Go to the documentation of this file.

// File and Version Information:
//      $Id: CdbRooRoViewR.cc,v 1.4 2005/05/09 05:22:24 gapon Exp $

/// Implementation file for the CdbRooRoViewR class
/**
  * @see CdbRooRoViewR
  */

#include "BaBar/BaBar.hh"

#include "CdbRooReadonly/CdbRooRoViewR.hh"
#include "CdbRooReadonly/CdbRooRoFolderR.hh"
#include "CdbRooReadonly/CdbRooRoFolderRItr.hh"
#include "CdbRooReadonly/CdbRooRoConditionAtFolderR.hh"
#include "CdbRooReadonly/CdbRooRoConfigCollectionR.hh"

#include "CdbBase/CdbPathName.hh"
#include "CdbBase/CdbTimeUtils.hh"

#include <assert.h>

using std::cout;
using std::endl;

CdbRooRoViewR::CdbRooRoViewR( ) :
    _name               (""),
    _id                 (0xFFFF),
    _description        (""),
    _created            (BdbTime::minusInfinity),
    _minValidityTime    (BdbTime::minusInfinity),
    _maxValidityTime    (BdbTime::minusInfinity),
    _useDefaultConfigPtr(false),
    _defaultConfigPtr   (0),
    _useRootFolderPtr   (false),
    _rootFolderPtr      (0),
    _isFrozen           (false)
{ }

CdbRooRoViewR::CdbRooRoViewR( const std::string&         theName,
                              UShort_t                   theId,
                              const std::string&         theDescription,
                              const BdbTime&             theCreationTime,
                              const BdbTime&             theMinValidityTime,
                              const BdbTime&             theMaxValidityTime,
                              CdbRooRoConfigCollectionR* theDefaultConfigPtr ) :
    _name               (theName),
    _id                 (theId),
    _description        (theDescription),
    _created            (theCreationTime),
    _minValidityTime    (theMinValidityTime),
    _maxValidityTime    (theMaxValidityTime),
    _useDefaultConfigPtr(0 != theDefaultConfigPtr),
    _defaultConfigPtr   (theDefaultConfigPtr),
    _useRootFolderPtr   (true),
    _rootFolderPtr      (new CdbRooRoFolderR( CdbPathName::separator( ),
                                              "The ROOT folder of the current view",
                                              theCreationTime )),
    _isFrozen           (false)
{
    assert(( BdbTime::minusInfinity != theCreationTime ) && ( BdbTime::plusInfinity != theCreationTime ));
}

CdbRooRoViewR::CdbRooRoViewR( const CdbRooRoViewR& theOther ) :
    _name               (theOther._name),
    _id                 (theOther._id),
    _description        (theOther._description),
    _created            (theOther._created),
    _minValidityTime    (theOther._minValidityTime),
    _maxValidityTime    (theOther._maxValidityTime),
    _useDefaultConfigPtr(theOther._useDefaultConfigPtr),
    _defaultConfigPtr   (( theOther._useDefaultConfigPtr ? new CdbRooRoConfigCollectionR( *(theOther._defaultConfigPtr)) : 0 )),
    _useRootFolderPtr   (theOther._useRootFolderPtr),
    _rootFolderPtr      (( theOther._useRootFolderPtr ? new CdbRooRoFolderR( *(theOther._rootFolderPtr)) : 0 )),
    _isFrozen           (theOther._isFrozen)
{ }

CdbRooRoViewR::~CdbRooRoViewR( ) 
{
    if( _useDefaultConfigPtr ) {
        delete _defaultConfigPtr;
        _defaultConfigPtr = 0;
    }
    if( _useRootFolderPtr ) {
        delete _rootFolderPtr;
        _rootFolderPtr = 0;
    }
}

CdbRooRoViewR&
CdbRooRoViewR::operator=( const CdbRooRoViewR& theOther )
{
    if( this != &theOther ) {

        if( _useDefaultConfigPtr ) delete _defaultConfigPtr;
        if( _useRootFolderPtr    ) delete _rootFolderPtr;

        _name                = theOther._name;
        _id                  = theOther._id;
        _description         = theOther._description;
        _created             = theOther._created;
        _minValidityTime     = theOther._minValidityTime;
        _maxValidityTime     = theOther._maxValidityTime;
        _useDefaultConfigPtr = theOther._useDefaultConfigPtr;
        _defaultConfigPtr    = ( theOther._useDefaultConfigPtr ? new CdbRooRoConfigCollectionR( *(theOther._defaultConfigPtr)) : 0 );
        _useRootFolderPtr    = theOther._useRootFolderPtr;
        _rootFolderPtr       = ( theOther._useRootFolderPtr ? new CdbRooRoFolderR( *(theOther._rootFolderPtr)) : 0 );
        _isFrozen            = theOther._isFrozen;
    }
    return *this;
}

CdbStatus
CdbRooRoViewR::setDefaultConfig( CdbRooRoConfigCollectionR* theConfigPtr )
{
    const char* errorStr = "CdbRooRoViewR::setDefaultConfig() - ERROR.";

    CdbStatus result = CdbStatus::Error;
    do {

      // Check the current state of the view

        if( isFrozen( )) {
            cout << errorStr << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Replace and delete (if any) the previously known configuration
      // with the new one.
      //
      // NOTE: If the passed reference is the same than the one we have then
      //       we don't remove existing one to avoid dangling references.
      //       Known reference might be passed if a client has updated configuration
      //       and explictly wants this configuration to present.

        if( 0 != defaultConfig( )) {
            if( theConfigPtr != defaultConfig( )) delete _defaultConfigPtr;
        }
        _useDefaultConfigPtr = true;
        _defaultConfigPtr    = theConfigPtr;

      // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbRooRoViewR::setConfig( const std::string&         thePathName,
                          CdbRooRoConfigCollectionR* theConfigPtr,
                          bool                       dontDestroyConfigObject )
{
    const char* errorStr = "CdbRooRoViewR::setConfig() - ERROR.";

    CdbStatus result = CdbStatus::Error;
    do {

      // Check the current state of the view

        if( isFrozen( )) {
            cout << errorStr << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Find the condition

        CdbRooRoConditionAtFolderR* cPtr;
        if( CdbStatus::Success != findCondition( thePathName,
                                                 cPtr )) {
            result = CdbStatus::NotFound;
            break;
        }

      // Finish

        result = cPtr->setConfig( theConfigPtr,
                                  dontDestroyConfigObject );

    } while( false );

    return result;
}

CdbStatus
CdbRooRoViewR::createFolder( const std::string& thePathName,
                             const std::string& theNewFolderName,
                             const std::string& theDescription,
                             const BdbTime&     theCreationTime )
{
    const char* errorStr = "CdbRooRoViewR::createFolder() - ERROR.";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fPath( theNewFolderName.c_str( ));

        if(( ! fPath.isValid( )) || fPath.isRoot( ) || fPath.isComposite( )) {
            cout << errorStr << endl
                 << "    Illegal new folder name passed to the procedure." << endl
                 << "    A non-composite and non-root folder name was expected." << endl
                 << "        PASSED NAME: \"" << theNewFolderName << "\"" << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << errorStr << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }
    
      // Find the "host" folder.

        CdbRooRoFolderR* hPtr;

        result = findFolder( thePathName, hPtr );
        if( CdbStatus::Success != result ) break;

      // Create new object

        CdbRooRoFolderR* fPtr = new CdbRooRoFolderR( theNewFolderName,
                                                     theDescription,
                                                     theCreationTime );

      // Do the final registration. Remove the previously created
      // object if it does not work.

        result = hPtr->insert( fPtr );
        if( CdbStatus::Success != result ) delete fPtr;

    } while( false );

    return result;
}

CdbStatus
CdbRooRoViewR::createFolder( const std::string& theFullPathName,
                             const std::string& theDescription,
                             const BdbTime&     theCreationTime )
{
    const char* errorStr = "CdbRooRoViewR::createFolder(recursive) - ERROR.";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fPath( theFullPathName );

        if(( ! fPath.isValid( )) || ( ! fPath.isAbsolute( ))) {
            cout << errorStr << endl
                 << "    Illegal folder name passed to the procedure." << endl
                 << "    A valid, absolute folder name was expected." << endl
                 << "        PASSED NAME: \"" << theFullPathName << "\"" << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << errorStr << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }
    
      // Just quit if the ROOT folder was specified simple because this folder
      // must always exist.

        if( fPath.isRoot( )) {
            result = CdbStatus::Success;
        } else {

          // Delegate operation to create the rest of the path to the "root" folder.
          //
          // NOTE: This is a recursive operation. The "root" folder may propagate
          //       down the chain.

            result = rootFolder( )->createFolder( fPath.afterFirst( ).toString( ),
                                                  theDescription,
                                                  theCreationTime );
        }

    } while( false );

    return result;
}

CdbStatus
CdbRooRoViewR::createCondition( const std::string&         thePathName,
                                const std::string&         theNewConditionName,
                                const std::string&         theDescription,
                                const BdbTime&             theCreationTime,
                                const CdbRooRoIdR&         theId,
                                CdbRooRoConfigCollectionR* theConfigPtr )
{
    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName cPath( theNewConditionName );

        if(( ! cPath.isValid( )) || cPath.isRoot( ) || cPath.isComposite( )) {
            cout << "CdbRooRoViewR::createCondition() - ERROR." << endl
                 << "    Illegal new condition name passed to the procedure." << endl
                 << "    A non-composite and non-root condition name was expected." << endl
                 << "        PASSED NAME: \"" << theNewConditionName << "\"" << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << "CdbRooRoViewR::createCondition() - ERROR." << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Find the "host" folder.

        CdbRooRoFolderR* hPtr;

        result = findFolder( thePathName, hPtr );
        if( CdbStatus::Success != result ) break;

      // Create new object

        CdbRooRoConditionAtFolderR* cPtr
            = new CdbRooRoConditionAtFolderR( theNewConditionName,
                                              theDescription,
                                              theCreationTime,
                                              theId,
                                              theConfigPtr );

      // Do the final registration. Remove the previously created
      // object if it does not work.

        result = hPtr->insert( cPtr );
        if( CdbStatus::Success != result ) delete cPtr;

    } while( false );

    return result;
}

CdbStatus
CdbRooRoViewR::removeFolder( const std::string& thePathName,
                             bool               forceFlag )
{
    const char* errorStr = "CdbRooRoViewR::removeFolder( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fName( thePathName );

        if( fName.isValid( ) && fName.isRoot( )) {
            cout << errorStr << endl
                 << "    The ROOT folder can't be deleted in this way. It can only be" << endl
                 << "    deleted with its host view." << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << "CdbRooRoViewR::removeFolder() - ERROR." << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Find the "host" folder.

        CdbRooRoFolderR* fPtr;

        result = findFolder( fName.beforeLast( ).toString( ), fPtr );
        if( CdbStatus::Success != result ) break;

      // And finally - ask the "host" to follow up with the actual removal.

        result = fPtr->removeFolder( fName.last( ).toString( ),
                                     forceFlag );

    } while( false );

    return result;
}

CdbStatus
CdbRooRoViewR::removeCondition( const std::string& thePathName )
{
    const char* errorStr = "CdbRooRoViewR::removeCondition( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fName( thePathName );

        if( fName.isValid( ) && fName.isRoot( )) {
            cout << errorStr << endl
                 << "    The ROOT name can't be passed to this procedure." << endl;
            break;
        }

      // Check the current state of the view

        if( isFrozen( )) {
            cout << "CdbRooRoViewR::removeCondition() - ERROR." << endl
                 << "    This view is already frozen, which means that it can't be" << endl
                 << "    reconfigured anymore." << endl;
            break;
        }

      // Find the "host" folder.

        CdbRooRoFolderR* fPtr;

        result = findFolder( fName.beforeLast( ).toString( ), fPtr );
        if( CdbStatus::Success != result ) break;

      // And finally - ask the "host" to follow up with the actual removal.

        result = fPtr->removeCondition( fName.last( ).toString( ));

    } while( false );

    return result;
}

CdbStatus
CdbRooRoViewR::findFolder( const std::string& thePathName,
                           CdbRooRoFolderR*&  thePtr )
{
    const char* errorStr = "CdbRooRoViewR::findFolder( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fPath( thePathName );

        if( ! ( fPath.isValid( ) && fPath.isAbsolute( ))) {
            cout << errorStr << endl
                 << "    Illegal path name passed to the procedure: " << thePathName << endl;
            break;
        }

      // Proceed with search

        if( fPath.isRoot( )) thePtr = rootFolder( );
        else
            return rootFolder( )->findFolder( fPath.afterFirst( ).toString( ),
                                              thePtr );
     // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbRooRoViewR::findCondition( const std::string&           thePathName,
                              CdbRooRoConditionAtFolderR*& thePtr )
{
    const char* errorStr = "CdbRooRoViewR::findCondition( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName cPath( thePathName );

        if( ! ( cPath.isValid( ) && cPath.isAbsolute( ) && ( ! cPath.isRoot( )))) {
            cout << errorStr << endl
                 << "    Illegal path name passed to the procedure: " << thePathName << endl;
            break;
        }

      // Find a folder hosting the condition

        CdbRooRoFolderR* fPtr;
        if( CdbStatus::Success != findFolder( cPath.beforeLast( ).toString( ), fPtr )) {
            result = CdbStatus::NotFound;
            break;
        }

      // Find the desired condition itself

        result = fPtr->findCondition( cPath.last( ).toString( ), thePtr );

    } while( false );

    return result;
}

CdbStatus
CdbRooRoViewR::folderIterator( CdbItr< const char* >& theItr ) const
{
  // Since we're not passing any parent folder to this iterator
  // then only ROOT folder will be delivered by it.
  //
  // NOTE: There is no memory leak in this code because the ownership
  //       over the created instance of the iterator will be passed
  //       to the generic iterator.

    theItr = CdbItr< const char* >( new CdbRooRoFolderRItr( ));
    return CdbStatus::Success;
}

void
CdbRooRoViewR::dump( std::ostream& o ) const
{
    o << "              NAME: " << name( ) << endl
      << "                ID: " << id( ) << endl
      << "       DESCRIPTION: " << description( ) << endl
      << "           CREATED: " << CdbTimeUtils::time2string( created( ))     << " : " << created( )     << endl
      << "      MIN.VALIDITY: " << CdbTimeUtils::time2string( minValidity( )) << " : " << minValidity( ) << endl
      << "      MAX.VALIDITY: " << CdbTimeUtils::time2string( maxValidity( )) << " : " << maxValidity( ) << endl
      << "         IS FROZEN: " << ( isFrozen( ) ? "Yes" : "No" ) << endl
      << "HAS DEFAULT CONFIG: " << ( defaultConfig( ) ? "Yes, see its dump below." : "No." ) << endl;

    if( defaultConfig( )) {
        o << "......................................................." << endl
          << endl;
        defaultConfig( )->dump( o );
        o << "......................................................." << endl;
    }
}

/////////////////
// End Of File //
/////////////////

---