---

CdbBdbSFolderPItr.hh

Go to the documentation of this file.

#ifndef CDBBDBSHARED_FOLDER_P_ITR_HH
#define CDBBDBSHARED_FOLDER_P_ITR_HH

// File and Version Information:
//      $Id: CdbBdbSFolderPItr.hh,v 1.4 2003/08/13 23:36:20 gapon Exp $

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

#include "CdbBase/CdbIItr.hh"

/// The internal implementation for the iterator of persistent folder names.
/**
  * This class provides the actual implementation of the corresponding
  * iterator interface.
  *
  * Remember, that the ROOT folder name is defined as a string returned
  * by the CdbPathName::separator() method.
  *
  * @see CdbIItr
  * @see CdbIItr::InterfaceType
  * @see CdbIItr::ValueType
  * @see CdbPathName::separator()
  */
class CdbBdbSFolderPItr : public CdbIItr< const char* > {

public:

    typedef CdbIItr< const char* >::ValueType     ValueType;
    typedef CdbIItr< const char* >::InterfaceType InterfaceType;

private:

  /// The copy constructor (IS DISABLED)
  /**
    * This is beause the ooMapItr class does not have the copy constructor too.
    */
    CdbBdbSFolderPItr( const CdbBdbSFolderPItr& theItr );

  /// The assignment operator (IS DISABLED)
  /**
    * This is beause the ooMapItr class does not have the assignment operator too.
    */
    CdbBdbSFolderPItr& operator=( const CdbBdbSFolderPItr& theItr );

public:

  /// The normal and default constructor
  /**
    * If the default constructor is chosen then it means that the "root" folder
    * would be the only product of this iterator. This simplest scenario does not involve
    * any operations with the persistent store.
    *
    * If the (oo-)map object is not null one then this map will be searched
    * to get a list of names. THese operations will inevitably go into
    * the persistent store.
    */
    CdbBdbSFolderPItr( const BdbRef(ooMap)& theMapRef = 0   /**< a (oo-)map with the collection of folders names */
                     );

  /// The destructor
  /**
    * Details...
    */
    virtual ~CdbBdbSFolderPItr( );

  /// Reset an iterator to its initial state.
  /**
    * This implements the corresponding method of the base class.
    *
    * @see CdbIItr::reset
    * @see CdbStatus
    */
    virtual CdbStatus reset( );

  /// Advance an iterator to the next position.
  /**
    * This implements the corresponding method of the base class.
    *
    * @see CdbIItr::next()
    */
    virtual bool next( );

  /// Obtain the currently reffered value.
  /**
    * This implements the corresponding method of the base class.
    *
    * @see CdbIItr::value()
    * @see CdbIItr::ValueType
    *
    * @return the current value the iterator is set on
    */
    virtual ValueType value( );

  /// Check if an iterator is valid.
  /**
    * This implements the corresponding method of the base class.
    *
    * @see CdbIItr::isValid()
    */
    virtual bool isValid( );

  /// Make a clone of itself
  /**
    * @see CdbIItr::clone()
    *
    * WARNING: The current implementation of this method will return an instance
    *          reset to the original state, as if no "next" method has ever been
    *          called against it, even if the original instance is already
    *          in the "isValid = true" state.
    *          The reason of ths is that ooMapItr does not have neither copy ctor,
    *          nor the assignment operator.
    */
    virtual InterfaceType* clone( ) const;

private:

    bool _isValid;
    bool _hasEverBeenAdvanced;

    BdbRef(ooMap) _mapRef;

    ooMapItr     _mapItr;
    ooString(32) _value;
};

#endif  // CDBBDBSHARED_FOLDER_P_ITR_HH

---