---

CdbBdbSRevCollectionP.ddl

Go to the documentation of this file.

#ifndef CDBBDBSHARED_REV_COLLECTION_P_HH
#define CDBBDBSHARED_REV_COLLECTION_P_HH

// File and Version Information:
//      $Id: CdbBdbSRevCollectionP.ddl,v 1.10 2004/08/06 05:54:25 bartoldu Exp $

#include "BdbUtil/Bdb.hh"
#include "ooMap.h"

#include "CdbBase/CdbItr.hh"

#include "CdbBdbShared/CdbBdbSRevisionP.hh"
#include "CdbBdbShared/CdbBdbSTimeLineP.hh"

#include "BdbTime/BdbTime.hh"

#include <iostream>

//--------------------------------------------------------------------------------------
// Explicit template instantiatin for the persistent TimeLine used by this class only --
//--------------------------------------------------------------------------------------

EXPLICIT_INSTANTIATE_CdbBdbSTimeLineP_1( BdbRef(CdbBdbSRevisionP) );

/// A collection of revisions
/**
  * This is a persistent implementation for the timeline (in the insertion
  * dimension) of "revisions". Each revision occupies a "validity" interavl in
  * the "insertion" timeline. When a new revision is put into the collection
  * it's inserted into an apporpriate position.
  */
class CdbBdbSRevCollectionP : public BdbPersObj {

private:

    typedef CdbBdbSTimeLineInterval< BdbRef(CdbBdbSRevisionP) > Interval;

public:

  // Default constructor

    CdbBdbSRevCollectionP( );

  // Destructor

    virtual ~CdbBdbSRevCollectionP( );

  /// Insert a revision into the collection
  /**
    * The specified revision is registered in the collection by its name
    * (must be present) and its identifier (revision creation time). The values
    * of the correspondinig keys are obtained through the revision class
    * interface.
    *
    * This operation does not have any side effects for the inserted revisions.
    *
    * The operation may fail if any of the following conditions is met:
    *
    *     - the passed revision exposes inproper identification (missing
    *       name or wrong identifier)
    *     - any system (Objectivity) error occures
    *     - the collection is internally inconsistent
    *     - specified revision is "out-of-sequence" (see documentation
    *       for the explanation of the concepts of revisions).
    */
    CdbStatus insert( const BdbRef(CdbBdbSRevisionP)& theRevisionRef );

  /// Find a revision in the collection by the revision identifier
  /**
    * Remember, that "revision id" is a point in the "insertion" time
    * dimension when a revison was created.
    *
    * The method uses "exact match" method to find the revision.
    *
    * In addition to usual (Success or Error) completion status values,
    * this one can also return CdbStatus::NotFound if the revision was not found.
    */
    CdbStatus find( const BdbTime&            theId,            /**< the revision identifier */
                    BdbRef(CdbBdbSRevisionP)& theRevisionRef    /**< the revision reference to be set up upon completion */
                  ) const;

  /// Find a revision in the collection by its name
  /**
    * The name passed as a parameter should not be 0 pointer.
    *
    * In addition to usual (Success or Error) completion status values,
    * this one can also return CdbStatus::NotFound if the revision was not found.
    */
    CdbStatus find( const char*               theName,         /**< the revision name */
                    BdbRef(CdbBdbSRevisionP)& theRevisionRef   /**< the revision reference to be set up upon completion */
                  ) const;

  /// Get the identifier for the most recent revision if any
  /**
    * Return CdbStatus::NotFound if there is no revisions in
    * the collection.
    */
    CdbStatus last( BdbTime& theId                              /**< the value of the identifier to be returned */
                  ) const;

  /// Set an iterator for revisions identifiers

    CdbItr<BdbTime> iterator_identifiers( ) const;

  /// Set an iterator for revisions names

    CdbItr<const char*> iterator_names( ) const;

  /// Dump the contents of the collection
  /**
    */
    void dump( std::ostream& o ) const;

private:

  /// Insert specified revision into the map
  /**
    * The revision name will be inquired from the passed revision
    * as a key for the registration.
    */
    CdbStatus insertIntoMap( const BdbRef(CdbBdbSRevisionP)& theRevisionRef );

  /// Remove a revision into a map
  /**
    * The method does not check the value of passed name. Non-zero string
    * is expected.
    */
    void removeFromMap( const char* theName );

  /// Insert specified revision into the TimeLine of "duration"intervals
  /**
    * The revision identifier will be inquired from the passed revision
    * as a key for the registration.
    */
    CdbStatus insertIntoTimeLine( const BdbRef(CdbBdbSRevisionP)& theRevisionRef );

private:

  /// The TimeLine of the "revision duration intervals"
  /**
    * This includes both the index for these intervals as well as
    * a double linked list of them.
    */
    BdbRef( CdbBdbSTimeLineP< BdbRef(CdbBdbSRevisionP) > ) _timeLineRef;

  /// The (oo-)map of revisions.
  /**
    * This map provides sorting facility for the revisions according to their
    * given names.
    */
    BdbRef( BdbMap ) _mapRef;
};

#endif /* CDBBDBSHARED_REV_COLLECTION_P_HH */

---