---

CdbBdbSCollectionP.cc

Go to the documentation of this file.

// File and Version Information:
//      $Id: CdbBdbSCollectionP.cc,v 1.10 2004/08/06 05:54:24 bartoldu Exp $

/// Implementation file for the CdbBdbSCollectionP class.
/**
  * @see CdbBdbSCollectionP
  */

#include "BaBar/BaBar.hh"

#include "CdbBdbShared/CdbBdbSCollectionP.hh"

#include "CdbBdbShared/CdbBdbSCollectionElementP.hh"
#include "CdbBdbShared/CdbBdbSCollectionIdItr.hh"
#include "CdbBdbShared/CdbBdbSCollectionNameItr.hh"

#include <assert.h>
using std::cout;
using std::endl;
using std::ostream;

CdbBdbSCollectionP::CdbBdbSCollectionP( bool useIdFlag,
                                        bool useNameFlag ) :
    _treeRef(0),
    _mapRef(0),
    _elements(0)
{
    assert( useIdFlag || useNameFlag );     // CONFIGURATIN ERROR - AT LEAST ONE WAY
                                            // TO IDENTIFY COLLECTION ELEMENTS IS EXPECTED

    if( useIdFlag   ) _treeRef = new( ooThis( )) BTreeP( );
    if( useNameFlag ) _mapRef  = new( ooThis( )) BdbMap( );
}

CdbBdbSCollectionP::~CdbBdbSCollectionP( ) 
{
  // Remove all the elements first
  //
  // NOTE: The preferable way of removing elements is through the B-tree.
  //       However if the identifiers are not used in the current configuration
  //       then we should use ooMap.

    if( ! BdbIsNull( _treeRef )) {

        CdbItr< BTreeEntry > itr = _treeRef->iterator( );
        while( itr.next( )) {
            BTreeEntry e = itr.value( );
            BdbDelete( e.value );
        }

    } else {

        assert( ! BdbIsNull(_mapRef));

        ooMapItr itr( _mapRef );
        while( itr.next( )) {
            BdbRef( CdbBdbSCollectionElementP ) eRef;
            eRef = (const BdbRef( CdbBdbSCollectionElementP )&) (itr->oid( ));
            BdbDelete( eRef );
        }
    }

  // Remove the rest

    if( ! BdbIsNull( _treeRef )) BdbDelete( _treeRef );
    if( ! BdbIsNull( _mapRef  )) BdbDelete( _mapRef );
}

bool
CdbBdbSCollectionP::useId( ) const
{
    return ! BdbIsNull( _treeRef );
}

bool
CdbBdbSCollectionP::useName( ) const
{
    return ! BdbIsNull( _mapRef );
}

d_ULong
CdbBdbSCollectionP::elements( ) const
{
    return _elements;
}

CdbStatus
CdbBdbSCollectionP::insert( const BdbRef( CdbBdbSCollectionElementP )& theRef )
{
    const char* errorStr = "CdbBdbSCollectionP::insert() -- ERROR";

    ooUpdate( );

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters.

        if( ! verifyElement( theRef )) {
            cout << errorStr << endl
                 << "    The specified object has not passed the general verification." << endl;
            break;
        }

      // Check if the currenbt collection does not have an element
      // with the same name.

        ooVString name = theRef->name( );

        if( useName( )) {
            if( _mapRef->isMember( name.head( ))) {
                cout << errorStr << endl
                     << "    The collection already has an element with such name." << endl
                     << "        Passed element name: " << name.head( ) << endl;
                break;
            }
        }

      // And the same test for the B-tree

        BTreeEntry newEntry( theRef->id( ), theRef );

        if( useId( )) {
            if( _treeRef->search( newEntry )) {
                cout << errorStr << endl
                     << "    The collection already has an element with such identifier." << endl
                     << "        Passed element identifier: " << newEntry.key << endl;
                break;
            }
        }

      // And finally - do the insertion into either or both the map and B-tree.

        if( useName( )) {
            if( BdbcSuccess != _mapRef->add( name.head( ), theRef )) {
                cout << errorStr << endl
                     << "    Failed to insert new element into the collection's persistent map" << endl
                     << "        Passed element name:       " << name.head( ) << endl
                     << "                       identifier: " << newEntry.key << endl;
                break;
            }
        }
        if( useId( )) {
            _treeRef->insert( newEntry );
        }

        ++_elements;

      // Done.

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSCollectionP::find( const char*                           theName,
                          BdbRef( CdbBdbSCollectionElementP )&  theRef ) const
{
  // Check for missuse of the method

    if( ! useName( )) {
        assert(0);
        return CdbStatus::Error;
    }

  // Proceed with finding

    const char* errorStr = "CdbBdbSCollectionP::find(name) -- ERROR";
    const char* fatalStr = "CdbBdbSCollectionP::find(name) -- FATAL ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Verify parameters.

        if( 0 == theName ) {
            cout << errorStr << endl
                 << "    Invalid name passed to the procedure." << endl;
            break;
        }

      // Look for an object with such name in the map.

        BdbRef(BdbPersObj) oRef;

        if( BdbcSuccess != _mapRef->lookup( theName, oRef )) {
            result = CdbStatus::NotFound;
            break;
        }

      // Verify found object type against what _MUST_ be in the collection.

        if( BdbIsNull(oRef)   ||
            ! oRef.isValid( )  ||
            ! oRef->ooIsKindOf( ooTypeN( CdbBdbSCollectionElementP ))) {

            cout << fatalStr << endl
                 << "    INCONSISTENT COLLECTION OR INAPPROPRIATE TYPE" << endl
                 << "    PASSED AS THE TEMPLATE PARAMETER." << endl;

            assert(0);

            break;
        }
        theRef = (const BdbRef( CdbBdbSCollectionElementP )&) oRef;

      // Done.

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSCollectionP::find( d_UShort                             theId,
                          BdbRef( CdbBdbSCollectionElementP )& theRef ) const
{
  // Check for missuse of the method

    if( ! useId( )) {
        assert(0);
        return CdbStatus::Error;
    }

  // Proceed with finding

    const char* fatalStr = "CdbBdbSCollectionP::find(id) -- FATAL ERROR";

    CdbStatus result = CdbStatus::Error;
    do {

      // Look for an object with such identifier in the B-tree.
        
        BTreeEntry foundEntry;

        if( ! _treeRef->search( BTreeEntry( theId ), foundEntry )) {
            result = CdbStatus::NotFound;
            break;
        }
        BdbRef( CdbBdbSCollectionElementP ) oRef = foundEntry.value;

      // Verify found object type against what _MUST_ be in the collection.

        if( BdbIsNull(oRef)   ||
            ! oRef.isValid( )  ||
            ! oRef->ooIsKindOf( ooTypeN( CdbBdbSCollectionElementP ))) {

            cout << fatalStr << endl
                 << "    INCONSISTENT COLLECTION OR INAPPROPRIATE TYPE" << endl
                 << "    PASSED AS THE TEMPLATE PARAMETER." << endl;

            assert(0);

            break;
        }
        theRef = oRef;

      // Done.

        result = CdbStatus::Success;

    } while( false );

    return result;
}

CdbStatus
CdbBdbSCollectionP::remove( const char* theName )
{
  // Check for missuse of the method

    if( ! useName( )) {
        assert(0);
        return CdbStatus::Error;
    }

  // Proceed with removal

    ooUpdate( );

    BdbRef( CdbBdbSCollectionElementP ) pRef;

    CdbStatus result = find( theName, pRef );
    if( CdbStatus::Success == result ) {

        if( useId( )) _treeRef->remove( BTreeEntry( pRef->id( )));
        _mapRef->remove( theName );

        BdbDelete( pRef );

        --_elements;
    }

    return result;
}

CdbStatus
CdbBdbSCollectionP::remove( d_UShort theId )
{
  // Check for missuse of the method

    if( ! useId( )) {
        assert(0);
        return CdbStatus::Error;
    }

  // Proceed with removal

    ooUpdate( );

    BdbRef( CdbBdbSCollectionElementP ) pRef;

    CdbStatus result = find( theId, pRef );
    if( CdbStatus::Success == result ) {

        _treeRef->remove( BTreeEntry( theId ));
        if( useName( )) _mapRef->remove( pRef->name( ));

        BdbDelete( pRef );

        --_elements;
    }

    return result;
}

CdbBdbSCollectionP::IteratorOfNames
CdbBdbSCollectionP::iterator_names( ) const
{
  // Check for missuse of the method

    if( ! useName( )) {
        assert(0);
        return IteratorOfNames( 0 );
    }

  // ATTENTION: This is not a memory leak - the created object
  //            will be destroyed by the iterator.

    return IteratorOfNames( new CdbBdbSCollectionNameItr( _mapRef ));
}

CdbBdbSCollectionP::IteratorOfIdentifiers
CdbBdbSCollectionP::iterator_identifiers( ) const
{
  // Check for missuse of the method

    if( ! useId( )) {
        assert(0);
        return IteratorOfIdentifiers( 0 );
    }

  // ATTENTION: This is not a memory leak - the created object
  //            will be destroyed by the iterator.

    return IteratorOfIdentifiers( new CdbBdbSCollectionIdItr( _treeRef->iterator( )));
}


void
CdbBdbSCollectionP::dump( ostream& o ) const
{
    if( useName( )) {

        o << "====================================" << endl
          << "== ELEMENTS SORTED BY THEIR NAMES ==" << endl
          << "====================================" << endl
          << endl;

        d_ULong num = 0;

        IteratorOfNames itr = iterator_names( );
        while( itr.next( )) {

            BdbRef( CdbBdbSCollectionElementP ) pRef;
            if( CdbStatus::Success != find( itr.value( ), pRef )) {
                o << "%%% ERROR : ELEMENT WITH NAME: \"" << itr.value( ) << "\" NOT FOUND %%%" << endl;
            } else {
                o << "\"" << pRef->name( ) << "\"" << endl;
                ++num;
            }
            o << endl;
        }

        o << "== TOTAL OF " << num << "/" << elements( ) << " ELEMENTS WERE FOUND ==" << endl
          << endl;
    }

    if( useId( )) {

        o << "==========================================" << endl
          << "== ELEMENTS SORTED BY THEIR IDENTIFIERS ==" << endl
          << "==========================================" << endl
          << endl;

        d_ULong num = 0;

        IteratorOfIdentifiers itr = iterator_identifiers( );
        while( itr.next( )) {

            BdbRef( CdbBdbSCollectionElementP ) pRef;
            if( CdbStatus::Success != find( itr.value( ), pRef )) {
                o << "%%% ERROR : ELEMENT WITH ID: " << itr.value( ) << " NOT FOUND %%%" << endl;
            } else {
                o << pRef->id( ) << endl;
                ++num;
            }
            o << endl;
        }

        o << "== TOTAL OF " << num << "/" << elements( ) << " ELEMENTS WERE FOUND ==" << endl;
    }
}

bool
CdbBdbSCollectionP::verifyElement( const BdbRef( CdbBdbSCollectionElementP )& theRef ) const
{
    const char* errorStr = "CdbBdbSCollectionP::verifyElement() -- ERROR";

    bool result = false;
    do {

        if( BdbIsNull( theRef )) {
            cout << errorStr << endl
                 << "    The 0-0-0-0 reference passed where the persistent object" << endl
                 << "    of type " << ooTypeN( CdbBdbSCollectionElementP ) << " was expected." << endl;
            break;
        }
        if( ! theRef.isValid( )) {
            cout << errorStr << endl
                 << "    Non-valid reference passed where the persistent object" << endl
                 << "    of type " << ooTypeN( CdbBdbSCollectionElementP ) << " was expected." << endl;
            break;
        }
        if( ! theRef->ooIsKindOf( ooTypeN( CdbBdbSCollectionElementP ))) {
            cout << errorStr << endl
                 << "    An object of an incompatible or inappropriate persistent type passed" << endl
                 << "    to the collection." << endl
                 << "        Passed object's type number: " << theRef->ooGetTypeN( ) << endl
                 << "        Expected        type number: " << ooTypeN( CdbBdbSCollectionElementP ) << endl;
            break;
        }

      // The last test is the optional one. It's only done when the collection
      // is configured to use names of elements.

        if( useName( )) {
            if( 0 == theRef->name( ).length( )) {
                cout << errorStr << endl
                     << "    The passed object does not have a valid name." << endl;
                break;
            }
        }

        result = true;

    } while( false );

    return result;
}

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

---