YiParsingError.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_PARSING_ERROR_H_
#define _YI_PARSING_ERROR_H_

#include <utility/YiString.h>

class CYIParsingError
{
public:
    static const CYIString DATA_FIELD_MISSING_MESSAGE;
    static const CYIString DATA_FIELD_UNRECOGNIZED_MESSAGE;
    static const CYIString INVALID_OBJECT_MESSAGE;
    static const CYIString FILE_READ_ERROR_MESSAGE;
    
    enum PARSING_ERROR
    {
        NONE = 0,
        DATA_HAS_ERROR,
        INVALID_OBJECT,
        DATA_FIELD_MISSING,
        DATA_FIELD_UNRECOGNIZED,
        FILE_READ_ERROR
    };
    
public:
    CYIParsingError();
    virtual ~CYIParsingError();
    
    virtual int32_t GetParsingErrorCode() const;

    virtual CYIString GetParsingErrorMessage() const;
    
    virtual void SetParsingErrorCode(int32_t eErrorCode);

    virtual void SetParsingErrorMessage(CYIString errorMessage);
    
    virtual bool HasError() const;
    
    virtual bool IsRequiredField(const CYIString &rFieldName) const;
    
private:
    int32_t m_parsingErrorCode;
    CYIString m_parsingErrorMessage;
};

inline int32_t CYIParsingError::GetParsingErrorCode() const
{
    return m_parsingErrorCode;
}

inline CYIString CYIParsingError::GetParsingErrorMessage() const
{
    return m_parsingErrorMessage;
}

inline void CYIParsingError::SetParsingErrorCode(int32_t nErrorCode)
{
    m_parsingErrorCode = nErrorCode;
}

inline void CYIParsingError::SetParsingErrorMessage(CYIString errorMessage)
{
    m_parsingErrorMessage = errorMessage;
}

inline bool CYIParsingError::HasError() const
{
    return m_parsingErrorCode > NONE;
}

inline bool CYIParsingError::IsRequiredField(const CYIString &rFieldName) const
{
    YI_UNUSED(rFieldName);
    // In the default implementation all fields are required
    return true;
}

#endif /* _YI_PARSING_ERROR_H_ */