---

CdbCompositeName.hh

Go to the documentation of this file.

#ifndef CDB_COMPOSITE_NAME_HH
#define CDB_COMPOSITE_NAME_HH

// File and Version Information:
//      $Id: CdbCompositeName.hh,v 1.4 2005/08/16 22:23:53 gapon Exp $

#include "CdbBase/CdbCommon.hh"

#include <iostream>
#include <string>

/// This class represents a composite name
/**
  * A composite name is a name made of two simple names - the <first> one
  * and the <last> one separated by a <separator> substring. The <separator>
  * substring is delivered through the corresponding static method of
  * the class. The <first> and <last> names of the composite name
  * are guarantied not to contain the value of <separator>. The class
  * provides constructors to build a composite name either from its components
  * or by translating a text string, which already has both names combined
  * with the <separator>.
  *
  * The main reason to introduce this class into the current project was
  * to support the naming mechanizm for several API entities, which requires
  * the scope name and the entity name itself at that scope. In terms
  * of the composite name class, the scope name can be represented by the <first>
  * name, and the entity name - by the <last> one (or vice versa).
  */
class CdbCompositeName {

    friend std::ostream& operator<<( std::ostream&           o,
                                     const CdbCompositeName& theName );

public:

  /// The separator of elements
  /**
    */
    static const char* separator( );

public:

  /// The normal & default constructor
  /**
    * Loads the object from specified string. This constructor expects
    * a string pointer to be passed as value of the parameter. If this
    * is a null pointer or if it points onto a nono-translatable string
    * then the new object will remain in the invalid state.
    *
    * @see CdbCompositeName::isValid()
    */
    explicit CdbCompositeName( const char* theStr = 0 );

  /// The normal constructor
  /**
    * Requirements to the strings:
    *
    * - must be non-null pointers
    * - must not contain the separator
    *
    * @see CdbCompositeName::isValid()
    */
    CdbCompositeName( const char* theFirst,
                      const char* theLast );

  /// The copy constructor
  /**
    * More details...
    */
    CdbCompositeName( const CdbCompositeName& theName );

  /// The destructor
  /**
    * More details...
    */
    virtual ~CdbCompositeName( );

  /// The assignment operator
  /**
    * More details...
    */
    CdbCompositeName& operator=( const CdbCompositeName& theName );

  /// Check if the object has the valid state
  /**
    * Any other operations with the object can only make sense
    * if this method will return true.
    */
    bool isValid( ) const;

  /// Get the first element in the name

    std::string first( ) const;

  /// Get the last element in the name

    std::string last( ) const;

  /// Get the whole name

    std::string getName( ) const;

  /// The "equal" operator
  /**
    */
    bool operator==( const CdbCompositeName& theName ) const;

  /// The "not-equal" operator
  /**
    */
    inline bool operator!=( const CdbCompositeName& theName ) const;

private:

  /// Translate specified string into tokens
  /**
    * This method will tokenize (if successfull) an input string
    * and return the boolean value to indicate if the operation
    * was successfull or not.
    */
    bool translate( const char* theStr );

  /// Load the object's context from specified strings
  /**
    * The strings are checked for not being empty and non containing
    * separators.
    */
    bool load( const char* theFirst,
               const char* theLast );

  /// Dump object contence into a steram

    void dump( std::ostream& o ) const;

private:

    bool _isValid;

    std::string _first;
    std::string _last;
};

// Inline implementation for teh class's methods and operators

inline
bool
CdbCompositeName::operator!=( const CdbCompositeName& theName ) const
{
    return ! operator==( theName );
}

inline
std::ostream&
operator<<( std::ostream&                o,
            const CdbCompositeName& theName )
{
    theName.dump( o );
    return o;
}
#endif  // CDB_COMPOSITE_NAME_HH

---