---

CdbBdbSCollectionNameItr.hh

Go to the documentation of this file.

#ifndef CDBBDBSHARED_COLLECTION_NAME_ITR_HH
#define CDBBDBSHARED_COLLECTION_NAME_ITR_HH

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

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

#include "CdbBase/CdbIItr.hh"

/// The internal implementation for the public iterator for elements of collections
/**
  * The iterator will return extract end return the names of elements stored
  * in the collection.
  *
  *     NOTE: Pay attention to the implementation of the "clone()" method
  *           of this iterator. This method does not produce an iterator
  *           being exactly at the same state as the original one (iterator).
  */
class CdbBdbSCollectionNameItr : public CdbIItr< const char* > {

public:

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

private:

  /// The default constructor (NOT IMPLEMENTED)
  /**
    * Cause there is no such thing as "default" element.
    */
    CdbBdbSCollectionNameItr( );

  /// The copy constructor (NOT IMPLEMENTED)
  /**
    * This is beause the ooMapItr class does not have the copy constructor too.
    */
    CdbBdbSCollectionNameItr( const CdbBdbSCollectionNameItr& theItr );

  /// The assignment operator (NOT IMPLEMENTED)
  /**
    * This is beause the ooMapItr class does not have the assignment operator too.
    */
    CdbBdbSCollectionNameItr& operator=( const CdbBdbSCollectionNameItr& theItr );

public:

  /// The normal constructor
  /**
    * The (oo-)map object passed as a parameter must not be null. Otherwise
    * the constructor will abort the execution.
    */
    CdbBdbSCollectionNameItr( const BdbRef( BdbMap )& theMapRef );

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

  /// 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(BdbMap) _mapRef;

    ooMapItr     _mapItr;
    ooString(32) _value;
};

#endif  // CDBBDBSHARED_COLLECTION_NAME_ITR_HH

---