---

CdbBdbSFolderP.ddl

Go to the documentation of this file.

#ifndef CDBBDBSHARED_FOLDER_P_HH
#define CDBBDBSHARED_FOLDER_P_HH

// File and Version Information:
//      $Id: CdbBdbSFolderP.ddl,v 1.8 2004/08/06 05:54:24 bartoldu Exp $

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

#include "CdbBase/CdbItr.hh"
#include "CdbBdbShared/CdbBdbSConditionAtFolderP.hh"

#include <iostream>

class CdbPathName;

//-----------------------------------------------
// Forward Declarations for Persistent Classes --
//-----------------------------------------------

class CdbBdbSViewP;
#pragma ooclassref CdbBdbSViewP "CdbBdbShared/CdbBdbSViewP_ref.hh"

/// Persistent folder class at teh persistent view
/**
  * Folders may own other folders or persistent conditions.
  */
class CdbBdbSFolderP : public BdbPersObj {

friend class CdbBdbSViewP;

private:

  /// Default constructor (NOT IMPLEMENTED))
  /**
    * Also see comments about the special constructor defined above.
    */
    CdbBdbSFolderP( );

  /// Normal constructor
  /**
    * WARNING: Inappropriate values of the parameters will cause the crash
    *          of the constructor to avoid creating disformed persistent
    *          data structures.
    */
    CdbBdbSFolderP( const char*                   theName,                  /**< the name of the folder */
                    const char*                   theDescription,           /**< the description of the folder */
                    const BdbTime&                theCreationTime,          /**< the time when the folder is supposed to be created */
                    const BdbRef(CdbBdbSViewP)&   theParentViewRef,         /**< back link to the parent view */
                    const BdbRef(CdbBdbSFolderP)& theParentFolderRef        /**< an optional back link to the parent folder */
                  );

  /// Destructor
  /**
    */
    virtual ~CdbBdbSFolderP( );

  /// Insert a folder
  /**
    * The passed object will be asked to provide its name. This name will be used
    * to register passed object in the current folder. This name must be unique
    * in the list of folders at the current folder's scope.
    */
    CdbStatus insert( const BdbRef(CdbBdbSFolderP)& theRef );

  /// Insert a condition
  /**
    * The passed object will be asked to provide its name. This name will be used
    * to register passed object in the current folder. This name must be unique
    * in the list of conditions at the current folder's scope.
    */
    CdbStatus insert( const BdbRef(CdbBdbSConditionAtFolderP)& theRef );

  /// Create new folder (RECURSIVE)
  /**
    * This operation creates the specified folder path, including intermediate subdirectories
    * if they still do not exist.
    *
    * NOTE: The specified "description" and "creation" timestamp will be assigned to all
    *       newely created folders.
    */
    CdbStatus createFolder( const char*    theFullPathName,     /**< the path name of the folder to be created */
                            const char*    theDescription,      /**< the description of the folder */
                            const BdbTime& theCreationTime      /**< the time when the folder is supposed to be created */
                          );

  /// Remove the folder
  /**
    * If the "forceFlag" is set FALSE then only an empty folder with no other subfolders
    * or conditions in it can be removed. Otherwise both the folder itself and its contents
    * will be exterminated.
    *
    * This operation requires the name of the folder, which is _directly_ connected
    * to the current object. If there is no such folder then CdbStatus::NotFound
    * will be returned. Other status values are as usual.
    */
    CdbStatus removeFolder( const CdbPathName& thePathName,         /**< the path name of the folder to be removed */
                            bool               forceFlag = false    /**< force removal if the folder is not empty */
                          );

  /// Remove the condition
  /**
    * This operation requires the name of the condition, which is _directly_ connected
    * to the current object. If there is no such condition then CdbStatus::NotFound
    * will be returned. Other status values are as usual.
    */
    CdbStatus removeCondition( const CdbPathName& thePathName       /**< the path name of the folder to be removed */
                             );
public:

  // Accessors

    ooString(32) name       ( ) const;
    ooString(32) description( ) const;

    BdbTime created( ) const;

    BdbRef(CdbBdbSViewP)   parentView  ( ) const;
    BdbRef(CdbBdbSFolderP) parentFolder( ) const;

  /// Find the folder
  /**
    * This operation requires the relative path to the required object. Upon successfull
    * completion it will return CdbStatus::Success. If the object is not found
    * CdbStatus::NotFound will be returned, The error status will be returned in other cases.
    */
    CdbStatus findFolder( const CdbPathName&      thePathName,      /**< the relative path name to the folder */
                          BdbRef(CdbBdbSFolderP)& theRef            /**< the reference to the found object to be set up */
                        ) const;

  /// Find the condition
  /**
    * This operation requires the relative path to the required object. Upon successfull
    * completion it will return CdbStatus::Success. If the object is not found
    * CdbStatus::NotFound will be returned, The error status will be returned in other cases.
    */
    CdbStatus findCondition( const CdbPathName&                 thePathName,    /**< the relative path name to the condition */
                             BdbRef(CdbBdbSConditionAtFolderP)& theRef          /**< the reference to the found object to be set up */
                           ) const;

  /// Set up an iterator of folder names
  /**
    */
    CdbStatus folderIterator( CdbItr< const char* >& theItr         /**< the value of the iterator be set up */
                            ) const;

  /// Set up an iterator of condition names
  /**
    */
    CdbStatus conditionIterator( CdbItr< const char* >& theItr      /**< the value of the iterator be set up */
                               ) const;

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

private:

  // Data members

    ooString(32) _name;
    ooString(32) _description;

    BdbTime _created;

    BdbRef(CdbBdbSViewP)   _parentViewRef;
    BdbRef(CdbBdbSFolderP) _parentFolderRef;

    BdbRef(ooMap) _foldersMapRef;
    BdbRef(ooMap) _conditionsMapRef;
};

#endif /* CDBBDBSHARED_FOLDER_P_HH */

---