---

CdbBdbSFolderP.cc

Go to the documentation of this file.

// File and Version Information:
//      $Id: CdbBdbSFolderP.cc,v 1.9 2004/12/08 09:26:54 gapon Exp $

/// The implementation file for the CdbBdbSFolderP class
/**
  * @see CdbBdbSFolderP
  */

#include "BaBar/BaBar.hh"

#include "CdbBdbShared/CdbBdbSFolderP.hh"

#include "CdbBdbShared/CdbBdbSViewP.hh"
#include "CdbBdbShared/CdbBdbSFolderPItr.hh"
#include "CdbBdbShared/CdbBdbSConditionAtFolderPItr.hh"

#include "CdbBase/CdbPathName.hh"

#include <assert.h>

#include <vector>
using std::cout;
using std::endl;
using std::ostream;

CdbBdbSFolderP::CdbBdbSFolderP( const char*                   theName,
                                const char*                   theDescription,
                                const BdbTime&                theCreationTime,
                                const BdbRef(CdbBdbSViewP)&   theParentViewRef,
                                const BdbRef(CdbBdbSFolderP)& theParentFolderRef ) :
    _name(theName),
    _description(theDescription),
    _created(theCreationTime),
    _parentViewRef(theParentViewRef),
    _parentFolderRef(theParentFolderRef),
    _foldersMapRef(0),
    _conditionsMapRef(0)
{
    assert( 0 != theName );
    assert( 0 != theDescription );
    assert(( BdbTime::minusInfinity != theCreationTime ) && ( BdbTime::plusInfinity != theCreationTime ));
    assert( ! BdbIsNull(theParentViewRef));

    _foldersMapRef    = new( ooThis( )) BdbMap( );
    _conditionsMapRef = new( ooThis( )) BdbMap( );
}

CdbBdbSFolderP::~CdbBdbSFolderP( ) 
{
  // First of all remove owned folders and conditions if there are any.
  //
  // NOTE: This algorithm is required to have two passes since we can't iterate over
  //       collection whose components are going to change. Otherwise it's going to be
  //       a crash inside Objectivity's iterators code.

    {
        std::vector<BdbRef(CdbBdbSFolderP)> folders;
        ooMapItr fItr( _foldersMapRef );
        while( fItr.next( )) folders.push_back((const BdbRef(CdbBdbSFolderP)&)( fItr->oid( )));
        for( std::vector<BdbRef(CdbBdbSFolderP)>::iterator i = folders.begin( ); i != folders.end( ); ++i ) BdbDelete(*i);
    }
    {
        std::vector<BdbRef(CdbBdbSConditionAtFolderP)> conditions;
        ooMapItr cItr( _conditionsMapRef );
        while( cItr.next( )) conditions.push_back((const BdbRef(CdbBdbSConditionAtFolderP)&)( cItr->oid( )));
        for( std::vector<BdbRef(CdbBdbSConditionAtFolderP)>::iterator i = conditions.begin( ); i != conditions.end( ); ++i ) BdbDelete(*i);
    }

  // Finally - delete the emptied collections

    BdbDelete(_foldersMapRef);
    BdbDelete(_conditionsMapRef);
}

ooString(32)
CdbBdbSFolderP::name( ) const
{
    return _name.head( );
}

ooString(32)
CdbBdbSFolderP::description( ) const
{
    return _description;
}

BdbTime
CdbBdbSFolderP::created( ) const
{
    return _created;
}

BdbRef(CdbBdbSViewP)
CdbBdbSFolderP::parentView( ) const
{
    return _parentViewRef;
}

BdbRef(CdbBdbSFolderP)
CdbBdbSFolderP::parentFolder( ) const
{
    return _parentFolderRef;
}

CdbStatus
CdbBdbSFolderP::insert( const BdbRef(CdbBdbSFolderP)& theRef )
{
    ooUpdate( );

    const char* errorStr = "CdbBdbSFolderP::insert(folder) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        if( BdbIsNull(theRef)) {
            cout << errorStr << endl
                 << "    Illegal folder reference passed to the procedure." << endl;
            break;
        }

        ooString(32) fName = theRef->name( );
        if( 0 == fName.head( )) {
            cout << errorStr << endl
                 << "    The passed folder does not have any name." << endl;
            break;
        }

        CdbPathName fPathName( fName.head( ));
        if(( ! fPathName.isValid    ( ))
            || fPathName.isAbsolute ( )
            || fPathName.isComposite( )) {

            cout << errorStr << endl
                 << "    The passed folder's name has illegal format. It must be a simple" << endl
                 << "    string without path separators." << endl
                 << "        PASSED FOLDER'S NAME:   \"" << fName.head( ) << "\"" << endl
                 << "        CURRENT PATH SEPARATOR: \"" << CdbPathName::separator( ) << "\"" << endl;
            break;
        }

      // Check if specified folder has the current folder as its parent
      // and that it also has the same parent view.

        if(( ooThis( )      != theRef->parentFolder( )) ||
           ( _parentViewRef != theRef->parentView  ( ))) {
            cout << errorStr << endl
                 << "    The passed folder has wrong parent folder or view. They have to be" << endl
                 << "    the current folder and the current folder's parent view." << endl
                 << "        PASSED  FOLDER'S PARENT FOLDER: " << theRef->parentFolder( ).sprint( ) << endl
                 << "        CURRENT FOLDER:                 " << ooThis( ).sprint( ) << endl
                 << "        PASSED  FOLDER'S PARENT VIEW:   " << theRef->parentView( ).sprint( ) << endl
                 << "        CURRENT FOLDER'S PARENT VIEW:   " << _parentViewRef.sprint( ) << endl;
            break;
        }

      // Check if there is no such folder in the current collection.

        if( d_True == _foldersMapRef->isMember( fName.head( ))) {
            cout << errorStr << endl
                 << "    The current folder already has a child folder with such a name." << endl
                 << "        PASSED NAME: \"" << fName.head( ) << "\"" << endl;
            break;
        }

      // Do the registration

        if( BdbcSuccess != _foldersMapRef->add( fName.head( ),
                                                theRef )) {
            cout << errorStr << endl
                 << "    Failed to insert specified object into the collection of child folders." << endl
                 << "        PASSED NAME: \"" << fName.head( ) << "\"" << endl;
            break;
        }

      // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSFolderP::insert( const BdbRef(CdbBdbSConditionAtFolderP)& theRef )
{
    ooUpdate( );

    const char* errorStr = "CdbBdbSFolderP::insert(condition) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        if( BdbIsNull(theRef)) {
            cout << errorStr << endl
                 << "    Illegal condition reference passed to the procedure." << endl;
            break;
        }

        ooString(32) cName = theRef->name( );
        if( 0 == cName.head( )) {
            cout << errorStr << endl
                 << "    The passed condition does not have any name." << endl;
            break;
        }

        CdbPathName cPathName( cName.head( ));
        if(( ! cPathName.isValid    ( ))
            || cPathName.isAbsolute ( )
            || cPathName.isComposite( )) {

            cout << errorStr << endl
                 << "    The passed condition's name has illegal format. It must be a simple" << endl
                 << "    string without path separators." << endl
                 << "        PASSED CONDITION'S NAME: \"" << cName.head( ) << "\"" << endl
                 << "        CURRENT PATH SEPARATOR:  \"" << CdbPathName::separator( ) << "\"" << endl;
            break;
        }

      // Check if specified condition has the current folder as its parent.

        if( ooThis( ) != theRef->parentFolder( )) {
            cout << errorStr << endl
                 << "    The passed condition has wrong parent folder. It has to be" << endl
                 << "    the current folder." << endl
                 << "        PASSED  CONDITION'S PARENT FOLDER: " << theRef->parentFolder( ).sprint( ) << endl
                 << "        CURRENT FOLDER:                    " << ooThis( ).sprint( ) << endl;
            break;
        }

      // Check if there is no such condition in the current collection.

        if( d_True == _conditionsMapRef->isMember( cName.head( ))) {
            cout << errorStr << endl
                 << "    The current folder already has a condition with such a name." << endl
                 << "        PASSED NAME: \"" << cName.head( ) << "\""  << endl;
            break;
        }

      // Do the registration

        if( BdbcSuccess != _conditionsMapRef->add( cName.head( ),
                                                   theRef )) {
            cout << errorStr << endl
                 << "    Failed to insert specified object into the collection of conditions." << endl
                 << "        PASSED NAME: \"" << cName.head( ) << "\"" << endl;
            break;
        }

      // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSFolderP::createFolder( const char*    theFullPathName,
                              const char*    theDescription,
                              const BdbTime& theCreationTime )
{
   ooUpdate( );

    const char* errorStr = "CdbBdbSFolderP::createFolder( ) - ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        CdbPathName fullPathName( theFullPathName );

        if(( ! fullPathName.isValid    ( ))
            || fullPathName.isAbsolute ( )
            || fullPathName.isRoot( )) {

            cout << errorStr << endl
                 << "    The passed folder's name has illegal format. It must be a either simple" << endl
                 << "    or composite relative path." << endl
                 << "        PASSED NAME: \"" << theFullPathName << "\"" << endl;
            break;
        }

      // Find the first (or the only) component from the passed path at local collection.
      // Create it if it does not exist yet.

        BdbRef(CdbBdbSFolderP) fRef;
        {
            CdbPathName firstComponentName( fullPathName.first( ));
            assert( firstComponentName.isValid( ));

            BdbRef(BdbPersObj) objRef;
            if( BdbcSuccess == _foldersMapRef->lookup( firstComponentName.toString( ).c_str( ),
                                                       objRef )) {

              // Okay it exists. There is nothing we can do at this level except of
              // casting to the right type since we might need it later to propagare
              // down the operation for composite path.

                fRef = (const BdbRef(CdbBdbSFolderP)&) objRef;

            } else {

              // Not found - then create it.

                fRef = new( ooThis( )) CdbBdbSFolderP( firstComponentName.toString( ).c_str( ),
                                                       theDescription,
                                                       theCreationTime,
                                                       _parentViewRef,
                                                       ooThis( ));

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

                if( CdbStatus::Success != insert( fRef )) {
                    BdbDelete( fRef );
                    break;
                }
            }
        }
        assert( !BdbIsNull(fRef));

      // Propagate operation down to the above found/created folder if a composite
      // path was passed to the current procedure.

        if( fullPathName.isComposite( )) {
            result = fRef->createFolder( fullPathName.afterFirst( ).toString( ).c_str( ),
                                         theDescription,
                                         theCreationTime );
        } else {
            ;
        }

      // Done 

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSFolderP::removeFolder( const CdbPathName& thePathName,
                              bool               forceFlag )
{
    ooUpdate( );

    const char* errorStr = "CdbBdbSFolderP::removeFolder( ) - ERROR";
    const char* fatalStr = "CdbBdbSFolderP::removeFolder( ) - FATAL INTERNAL ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        if(( ! thePathName.isValid    ( ))
            || thePathName.isAbsolute ( )
            || thePathName.isComposite( )) {

            cout << errorStr << endl
                 << "    The passed folder's name has illegal format. It must be a simple" << endl
                 << "    string without path separators." << endl
                 << "        PASSED NAME:            \"" << thePathName << "\"" << endl
                 << "        CURRENT PATH SEPARATOR: \"" << CdbPathName::separator( ) << "\"" << endl;
            break;
        }

      // Find the folder at local collection

        BdbRef(BdbPersObj) objRef;
        if( BdbcSuccess != _foldersMapRef->lookup( thePathName.toString( ).c_str( ),
                                                   objRef )) {
            result = CdbStatus::NotFound;
            break;
        }

        BdbRef(CdbBdbSFolderP) fRef = (const BdbRef(CdbBdbSFolderP)&) objRef;

        if( BdbIsNull(fRef) || ! fRef.isValid( )) {
            cout << fatalStr << endl
                 << "    The internal map of the folders is corrupted." << endl;
            assert( 0 );
            break;
        }

      // NON-FORCE mode only: check if the folder is not empty and refuse removal
      //                      if the folder contains any other subfolders or conditions.

        if( ! forceFlag ) {

            CdbItr< const char* > fItr;
            if( CdbStatus::Success != fRef->folderIterator( fItr )) {
                cout << errorStr << endl
                     << "    Failed to setup asn iterator of folders." << endl;
                break;
            }
            CdbItr< const char* > cItr;
            if( CdbStatus::Success != fRef->conditionIterator( cItr )) {
                cout << errorStr << endl
                     << "    Failed to setup asn iterator of conditions." << endl;
                break;
            }
            if( fItr.next( ) || cItr.next( )) {
                cout << errorStr << endl
                     << "    The folder requested for removal is not empty. It contains either" << endl
                     << "    other sub-folders or conditions. Use 'force' mode to proceed with removal." << endl;
                break;
            }
        }

      // Remove it from the map and delete the folder object itself.

        if( BdbcSuccess != _foldersMapRef->remove( thePathName.toString( ).c_str( ))) {
            cout << errorStr << endl
                 << "    Failed to remove the folder object from the map." << endl;
            break;
        }
        BdbDelete(fRef);

      // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSFolderP::removeCondition( const CdbPathName& thePathName )
{
    ooUpdate( );

    const char* errorStr = "CdbBdbSFolderP::removeCondition( ) - ERROR";
    const char* fatalStr = "CdbBdbSFolderP::removeCondition( ) - FATAL INTERNAL ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

        if(( ! thePathName.isValid    ( ))
            || thePathName.isAbsolute ( )
            || thePathName.isComposite( )) {

            cout << errorStr << endl
                 << "    The passed condition's name has illegal format. It must be a simple" << endl
                 << "    string without path separators." << endl
                 << "        PASSED NAME:            \"" << thePathName << "\"" << endl
                 << "        CURRENT PATH SEPARATOR: \"" << CdbPathName::separator( ) << "\"" << endl;
            break;
        }

      // Find the condition at local collection

        BdbRef(BdbPersObj) objRef;
        if( BdbcSuccess != _conditionsMapRef->lookup( thePathName.toString( ).c_str( ),
                                                      objRef )) {
            result = CdbStatus::NotFound;
            break;
        }

        BdbRef(CdbBdbSConditionAtFolderP) cRef = (const BdbRef(CdbBdbSConditionAtFolderP)&) objRef;

        if( BdbIsNull(cRef) || ! cRef.isValid( )) {
            cout << fatalStr << endl
                 << "    The internal map of the conditions is corrupted." << endl;
            assert( 0 );
            break;
        }

      // Remove it from the map and delete the condition object itself.

        if( BdbcSuccess != _conditionsMapRef->remove( thePathName.toString( ).c_str( ))) {
            cout << errorStr << endl
                 << "    Failed to remove the condition object from the map." << endl;
            break;
        }
        BdbDelete(cRef);

      // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSFolderP::findFolder( const CdbPathName&      thePathName,
                            BdbRef(CdbBdbSFolderP)& theRef ) const
{
    const char* errorStr = "CdbBdbSFolderP::findFolder( ) - ERROR";
    const char* fatalStr = "CdbBdbSFolderP::findFolder( ) - FATAL INTERNAL ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

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

      // Proceed with search
      //
      // If the path name is made of one element only than the locally found
      // folder is what we're looking for. Otherwise we'll proceed down
      // the hierarchy of folders.

        BdbRef(BdbPersObj) objRef;

        if( BdbcSuccess != _foldersMapRef->lookup( thePathName.first( ).toString( ).c_str( ),
                                                   objRef )) {
            result = CdbStatus::NotFound;
            break;
        }

        BdbHandle(CdbBdbSFolderP) folderH;
        folderH = (const BdbRef(CdbBdbSFolderP)&) objRef;

        if( BdbIsNull(folderH) || ! folderH.isValid( )) {
            cout << fatalStr << endl
                 << "    The internal map of the folders is corrupted." << endl;
            assert( 0 );
            break;
        }

        if( ! thePathName.isComposite( )) theRef = folderH;
        else
            return folderH->findFolder( thePathName.afterFirst( ),
                                        theRef );
     // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSFolderP::findCondition( const CdbPathName&                 thePathName,
                               BdbRef(CdbBdbSConditionAtFolderP)& theRef ) const
{
    const char* errorStr = "CdbBdbSFolderP::findCondition( ) - ERROR";
    const char* fatalStr = "CdbBdbSFolderP::findCondition( ) - FATAL INTERNAL ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters

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

      // Proceed with search
      //
      // If the path name is made of one element only than the locally found
      // condition is what we're looking for. Otherwise we'll proceed down
      // the hierarchy of folders.

        if( thePathName.isComposite( )) {

          // Find the folder first, then propagate the operation down to
          // the found folder.

            BdbRef(BdbPersObj) objRef;

            if( BdbcSuccess != _foldersMapRef->lookup( thePathName.first( ).toString( ).c_str( ),
                                                       objRef )) {
                result = CdbStatus::NotFound;
                break;
            }

            BdbHandle(CdbBdbSFolderP) folderH;
            folderH = (const BdbRef(CdbBdbSFolderP)&) objRef;

            if( BdbIsNull(folderH) || ! folderH.isValid( )) {
                cout << fatalStr << endl
                     << "    The internal map of the folders is corrupted." << endl;
                assert( 0 );
                break;
            }

            return folderH->findCondition( thePathName.afterFirst( ),
                                           theRef );

        } else {

          // The required condition must be attached to the current folder.

            BdbRef(BdbPersObj) objRef;

            if( BdbcSuccess != _conditionsMapRef->lookup( thePathName.first( ).toString( ).c_str( ),
                                                          objRef )) {
                result = CdbStatus::NotFound;
                break;
            }

            BdbHandle(CdbBdbSConditionAtFolderP) conditionH;
            conditionH = (const BdbRef(CdbBdbSConditionAtFolderP)&) objRef;

            if( BdbIsNull(conditionH) || ! conditionH.isValid( )) {
                cout << fatalStr << endl
                     << "    The internal map of the conditions is corrupted." << endl;
                assert( 0 );
                break;
            }

            theRef = conditionH;
        }

     // Done

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSFolderP::folderIterator( CdbItr< const char* >& theItr ) const
{
  // 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 CdbBdbSFolderPItr( _foldersMapRef ));
    return CdbStatus::Success;
}

CdbStatus
CdbBdbSFolderP::conditionIterator( CdbItr< const char* >& theItr ) const
{
  // 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 CdbBdbSConditionAtFolderPItr( _conditionsMapRef ));
    return CdbStatus::Success;
}

void
CdbBdbSFolderP::dump( ostream& o ) const
{
    o << "         NAME: \"" << _name.head( ) << "\"" << endl
      << "  DESCRIPTION: \"" << _description.head( ) << "\"" << endl
      << "      CREATED: " << _created << endl
      << "  PARENT VIEW: " << _parentViewRef.sprint( ) << endl
      << "PARENT FOLDER: " << _parentFolderRef.sprint( ) << endl;
}

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

---