---

d_Error.h

Go to the documentation of this file.

#ifndef d_Error_h
#define d_Error_h 1
//------------------------------------------------------------------------------

#include "d_Errorcodes.h"
#include "cODMGLiteral.h"

#include "cpp_exception.h"

#include "d_String.h"
//------------------------------------------------------------------------------

/**
 * Orient ODBMS exceptions and errors.
 *
 * Orient exceptions are treated by raising d_Error objects.
 *
 * For this reason each database operation (object management, queries, etc.)
 * had to be included inside a C++ try-catch block. This means that there is no
 * need to check the result at every database operation, but rather exception
 * raised in a try block will be handled in the catch block (full C++
 * integration).
 * 
 * It inherits from C++ exception class.
 *
 * LOCATION:
 * d_Error.h
 *
 * USAGE:
 * try
 * {
 *   ...
 * }
 * catch( d_Error* <err-object> )
 * {
 *   ...
 * }
 * 
 * Where:
 * 
 * <ERR-OBJECT>:                NAME OF D_ERROR OBJECT CAUGHT.
 *
 * EXAMPLES:
 * try
 * {
 *   ...
 *   db.open( "business" );
 *   ...
 * }
 * catch( d_Error* err )
 * {
 *    * CATCH DATABASE ERRORS
 *   cerr << "Database error :";
 * 
 *    * SWITCHING ERROR KIND
 *   switch( err->get_kind() )
 *   {
 *     case d_Error::d_Error_DatabaseOpen:
 *       cerr << "Database not open";
 *       break;
 *
 *     default:
 *       cerr << "Generic";
 *   }
 *   delete err;
 * }
 *
 * ODMG:
 * Compliant 
*/

class _ODLL d_Error : public cpp_exception
{
  public:
    typedef d_Long kind;

    /**
     * Default Constructor.
     *
     * ODMG    :        Compliant 
     */
    d_Error ();

    /**
     * Create a d_Error object specifying error kind.
     *
     * Create a d_Error object with error kind equal to <iKind>.
     *
     * ODMG    :        Compliant 
     */
    d_Error (kind iKind);

    /**
     * Copy Constructor.
     *
     * ODMG    :        Compliant 
     */
    d_Error (const d_Error& iSource);

    /**
     * Destructor.
     *
     * ODMG    :        Compliant 
     */
    ~d_Error();

    /**
     * Returns a message that describes the error.
     *
     * ODMG    :        Compliant 
     */
    virtual const char * what () const throw();

    /**
     * Returns error's kind.
     *
     * ODMG    :        Compliant 
     */
    kind get_kind ();

    /**
     * Set error's kind.
     *
     * ODMG    :        Compliant 
     */
    void set_kind (kind iKind);

    /**
     * Get the Detail error if any, otherwise null.
     *
     * ODMG    :        Extension
     */
    d_Error* get_detail();

    /**
     * Set the Detail error.
     *
     * ODMG    :        Extension
     */
    void set_detail( d_Error* iDetail );

    /**
     * Check if contains the kind requested in the current object and
     * in the detail objects.
     *
     * ODMG    :        Extension
     */
    bool contains( kind iKind );

    /**
     * Append a string to the error message.
     *
     * ODMG    :        Compliant 
     */
    d_Error& operator << (const d_String& iInfo);

    /**
     * Append a integer to the error message.
     *
     * ODMG    :        Compliant
     */
    d_Error& operator << (d_ULong iInfo);

    /**
     * Append a c-string to the error message.
     *
     * ODMG    :        Compliant 
     */
    d_Error& operator << (const char* iInfo);

    /**
     * Append the message of another d_Error object.
     *
     * ODMG    :        Compliant 
     */
    d_Error& operator << (const d_Error& iInfo);

  private:
    // Internal.
    char* findDescription (const kind iKind);

    // Internal.
    d_Error* detail;

    // Internal.
    kind curr_kind;
    // Internal.
    d_String message;
};

//------------------------------------------------------------------------------
// ERROR FACILITIES :

//#define OERROR_DEBUG  1

#define OERROR(inKind,extra)      {d_Error* _tmperr = new d_Error(inKind); \
                                   *_tmperr << extra; \
                                   throw(_tmperr);}
#define OERRORD(inKind,detail,extra) {d_Error* _tmperr = new d_Error(inKind); \
                                      *_tmperr << extra; \
                                      _tmperr->set_detail(detail); \
                                      throw(_tmperr);}

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

#endif

---