---

CdbFolder.hh

Go to the documentation of this file.

#ifndef CDB_FOLDER_HH
#define CDB_FOLDER_HH

// File and Version Information:
//      $Id: CdbFolder.hh,v 1.9 2003/08/13 23:34:13 gapon Exp $

#include "CdbBase/CdbStateControl.hh"
#include "CdbBase/CdbFolderLocator.hh"
#include "CdbBase/CdbCloneable.hh"

#include "CdbBase/CdbCPtrBase.hh"
#include "CdbBase/CdbFolderPtrFwd.hh"
#include "CdbBase/CdbViewPtrFwd.hh"
#include "CdbBase/CdbConditionPtrFwd.hh"
#include "CdbBase/CdbConditionItr.hh"

#include <string>

class CdbId;
class BdbTime;

/// The transient representation for the persistent folder.
/**
  * This class also includes the CdbStateControl, CdbFolderLocator
  * and CdbCloneable interfaces.
  *
  * Note, that this is an abstract class specifying the interface to the folder.
  * It also maintains the general status of an object of the CdbFolder class as it's seen to its
  * clients through the API.
  *
  * @see CdbStateControl
  * @see CdbFolderLocator
  * @see CdbCloneable
  */
class CdbFolder : public    CdbStateControl,
                  public    CdbFolderLocator,
                  protected CdbCloneable< CdbFolder > {

friend class CdbCPtrBase< CdbFolder >;

private:

  /// The default constructor (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbFolder( );

protected:

  /// The normally used constructor will set the internal parameters
  /// of an object.
  /**
    * Initialize the context of the Folder with specified set of parameters. This
    * will also validate the internal state of the object.
    *
    * If the folder was already open it will be closed before replacing the
    * parameters.
    *
    * @see CdbView
    * @see CdbViewPtr
    * @see CdbFolderPtr
    */
    CdbFolder( const CdbViewPtr&   theViewPtr,      /**< the smart pointer providing a back link to the parent view */
               const CdbFolderPtr& theFolderPtr,    /**< the smart pointer providing a back link to the parent folder */
               const char*         theName          /**< the name of the folder */
             );

  /// The copy constructor
  /**
    * Details...
    */
    CdbFolder( const CdbFolder& theFolder );

  /// The destructor.
  /**
    * Is only available for the derived classes and friends to prevent accidental
    * deletion of objects.
    */
    virtual ~CdbFolder( );

  /// The assignment operator
  /**
    * Details...
    */
    CdbFolder& operator=( const CdbFolder& theFolder );

public:

  /// Static locator for a folder object
  /**
    * Locates specified folder object and returns a smart pointer to the transient
    * object of the current class. This "shortcut" allows to avoid the complicated
    * multi-staged process of the object location, which is useless when
    * the intermediate objects are not needed.
    *
    * The last parameter (a pointer to the top-level Cdb singleton) is optional. If 0 is
    * passed then a default instance is used.
    *
    * Note, that if specified object is not found then a smart pointer is initialized
    * to point to 0.
    *
    * @see Cdb
    * @see CdbFolderPtr
    * @see CdbStatus
    *
    * @return a completion status
    */
    static CdbStatus instance( CdbFolderPtr& theFolderPtr,              /**< the smart pointer to be initialized */
                               const char*   theFullPathName,           /**< the full path name of the folder */
                               const char*   theViewName           = 0, /**< the view name */
                               const char*   theDatabaseName       = 0, /**< the database name */
                               const char*   theImplementationName = 0, /**< the implementation name */
                               const char*   theTechnologyName     = 0  /**< the technology name */
                             );

  /// Static locator for a folder object
  /**
    * Unlike the previous method this one requires extended identifier
    * of a view.
    *
    * @see CdbId
    */
    static CdbStatus instance( CdbFolderPtr& theFolderPtr,              /**< the smart pointer to be initialized */
                               const char*   theFullPathName,           /**< the full path name of the folder */
                               const CdbId&  theViewId,                 /**< the view identifier */
                               const char*   theDatabaseName       = 0, /**< the database name */
                               const char*   theImplementationName = 0, /**< the implementation name */
                               const char*   theTechnologyName     = 0  /**< the technology name */
                             );

public:

  /// Return a smart pointer to the parent CdbView object.
  /**
    * @see CdbView
    * @see CdbViewPtr
    */
    const CdbViewPtr& parentView( ) const;

  /// Return a smart pointer to the parent CdbFolder object.
  /**
    * @see CdbFolder
    * @see CdbFolderPtr
    */
    const CdbFolderPtr& parentFolder( ) const;

  /// Obtain the current name of the CdbFolder.
  /**
    * It's guranteed that the returned pointer will point onto non 0 string.
    *
    * @return a const pointer on to the object's name
    */
    const char* name( ) const;

  /// Obtain the creation time of the folder
  /**
    * This method is supposed to be implemented by the corresponding subclass.
    *
    * @return a string with the object's description
    */
    virtual BdbTime created( ) const = 0;

  /// Obtain the folder description
  /**
    * This method is supposed to be implemented by the corresponding subclass.
    *
    * @return a string with the object's description
    */
    virtual std::string description( ) const = 0;

  /// Find the specified condition
  /**
    * This method is supposed to be implemented by the corresponding subclass.
    *
    * This method initializes a smart pointer to a transient object of
    * the CdbCondition class representing the found condition. It will
    * initialize the smart pointer to point onto 0 and return the corresponding
    * error statuswhen specified object is not found or is not awailable for some
    * other reason.
    *
    * The only characteristics of the condition is its name. This name should not be
    * a 0 pointer.
    *
    * @see CdbCondition
    * @see CdbConditionPtr
    * @see CdbStatus
    *
    * @return a completion status of the operation
    */
    virtual CdbStatus findCondition( CdbConditionPtr& theConditionPtr,  /**< a smart pointer to an object to be initialized */
                                     const char*      theName           /**< the name of an object to be found */
                                   ) = 0;

  /// Initialize an instance of an iterator for the known conditions names
  /**
    * This method is supposed to be implemented by the corresponding subclass.
    *
    * The iterator will be set into a "valid" state upon successfull completion.
    *
    * @see CdbIItr::isValid()
    * @see CdbCondition
    * @see CdbConditionItr
    * @see CdbStatus
    *
    * @return completion status
    */
    virtual CdbStatus conditionIterator( CdbConditionItr& theItr ) = 0;

private:

    CdbViewPtr   _myViewPtr;
    CdbFolderPtr _myFolderPtr;

    std::string _myName;
};

#endif  // CDB_FOLDER_HH

---