NumberObject.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   NumberObject.h
//  AUTHOR      :   Liang Liu
//  CREATION    :   2008-09-23
//  Copyright (C) MicroStrategy Incorporated 2008
//  All Rights Reserved
//==============================================================================================

#ifndef MsiChart_NumberObject_h
#define MsiChart_NumberObject_h

#include "TextObject.h"
#include "NumberObjectHelper.h"

namespace MsiChart
{
    typedef enum
    {
        Default = -2,
        Fixed = 0,
        Currency,
        Date,
        Time,
        Percentage,
        Fraction,
        Scientific,
        Custom,
        Special,
        General,
        FromGrid,
    } NumberCategory;

    #define CURR_SYMB_SIZE 5
    #define FORMAT_SIZE 256

    struct ChartAdvFormat
    {
        int     formatType;
        int     iDigits;
        int     iGrouping;
        char    szCurrency[CURR_SYMB_SIZE];
        int     iPosCurr;
        int     NegFormat;
        char    szCustomFormat[FORMAT_SIZE];
        
        ChartAdvFormat() : formatType(General),
                            iDigits(0),
                            iGrouping(3),
                            iPosCurr(0),
                            NegFormat(3)

        {
            strlcpy(szCurrency, "$", CURR_SYMB_SIZE);
            strlcpy(szCustomFormat, "General", FORMAT_SIZE);
        }
    };
    
    const static char sFixedStringTable[3][8] = {
        {"[SF:-3]"},
        {"[SF:-6]"},
        {"[SF:-9]"}
    };
    
    class NumberObject: public TextObject
    {
    public:
        typedef MSynch::SmartPtr<NumberObject> Ptr;

        NumberObject(const TripleId& irTripleId, 
                        GraphObjectManager* ipManager,                      
                        double iNumber, 
                        const ChartAdvFormat& irNumberFormat,
                        GraphCollectionObject* ipParentObject = NULL,                       
                        LCID iLocale = 0,
                        bool iClientDrag = false,
                        Dataset::Ptr iDatasetPtr = NULL,
                        bool iIsFinal = true,                    
                        Int32 iColumnOffset = 0,
                        EnumDssGraphNumberFormatAsAxis iNumberFormatAsAxis = DssGraphNumberFormatAsDefaultAxis);

        virtual ~NumberObject();

        //  Pure virtual function from GraphObject
        virtual void Draw() const;

        void AddTextBeforeNumber(const MBase::String& irString);

        double GetNumber() const;
        void SetNumber(double iNumber);
        
        void SetThreshHold(bool iIsThreshHold, Int32 iColor = 0);
        
        bool IsAbbreviated() const;
        
        bool GetNumberFromText(double& orValue);
        
        bool IsReplacedText() const;
        
        void SetCorrectDateFormatString(ChartAdvFormat& orFormat);
        
    
        Int32 GetColor() const;
        void SetColor(Int32 iColor);
        void SetPrefix(MBase::String iPrefix);
        void SetSuffix(MBase::String iSuffix);
        void GetPrefix(MBase::String& orPrefix);
        void GetSuffix(MBase::String& orSuffix);
        void SetHasBracket(bool iHasBracket);
        Int32 GetColumnOffset() const;
        //void SetTextValue(const MBase::String& irString);
        //NumberObjectHelper need to call this method and there is a SetText in TextObject,so I didn't change the prefix --Jin ,dong
        void hSetText(const MBase::String& irString);
        void HandleNegNumberFormat(const char* ipFormattingString, Int32 iNegFormat, LCID iLocale);
        void FilterQuotes(char* ipString, bool iDividPosAndNeg = true);
        bool FilterQuotes(std::string& iorString, bool iDividPosAndNeg = true);
        void MapFormattingString(std::string& iorStr);
        bool IsFraction(const std::string& irNumberFormat) const;
        double AdjustFormatStringWithDot(std::string& formatString, int iDotIndex);
        bool HasBracket(std::string& iorFormatStr);
        double AnalyzeSeperatorAtTail(std::string& iorNumberFormat);
        bool GetPreAndSuffix(std::string& iorFormatStr, std::string& orPrefix, std::string& orSuffix);
    private:
        void SetNumberFormat(const ChartAdvFormat& irNumberFormat, LCID iLocale, Dataset::Ptr iDatasetPtr, EnumDssGraphNumberFormatAsAxis iNumberFormatAsAxis = DssGraphNumberFormatAsDefaultAxis);
        
        void SetNumberFormatForTimeSeries(const ChartAdvFormat& irNumberFormat);

        void hFormatTimeSeriesAxisLabels(const ChartAdvFormat& irNumberFormat, LCID iLocale, Dataset::Ptr iDatasetPtr, EnumDssGraphNumberFormatAsAxis iNumberFormatAsAxis);
        void hFormatGraphMatrixAxisLabels(const ChartAdvFormat& irNumberFormat, LCID iLocale, Dataset::Ptr iDatasetPtr);
        
        TripleId hMapTripleId(EnumDssGraphNumberFormatAsAxis iNumberFormatAsAxis, ChartAdvFormat& iorNumberFormat);
        
        void hMapFormatType(const TripleId& irTripleId, ChartAdvFormat& iorNumberFormat);
        
        bool hGetPreAndSuffix(std::string& iorFormatStr, std::string& orPrefix, std::string& orSuffix, bool& orHasBrakcket, bool iDividPosAndNeg = true);
        
        void hParseColor(char** oppSource);
        
        std::string hConvertToFraction(double value, std::string& formatString);
    
        void hSetTextFromGrid(Dataset::Ptr iDatasetPtr, MFormat::NumberFormat* ipNumberFormat, LCID iLocale); //Handle the "From Grid" case
        void hSetNumberFormat(Dataset::Ptr iDatasetPtr, const ChartAdvFormat& irNumberFormat,  LCID iLocale);
        void hRemoveMinusFromNegExpComponet(std::string& iorNumberFormat); //used in scientific mode.
        bool replaceQuestionMarkWithHash(std::string& iorNumberFormat); 
        bool hIsCondenseAllowed(Dataset::Ptr iDatasetPtr);
        
        void hParseConditions(std::string& iorFormat);
        void hReplaceCurencySymbol(std::string& iorFormat);
        bool hHandleReplacedText(Dataset::Ptr iDatasetPtr);

        // data members
        double mNumber; 
        Int32 mColor;   
        bool mIsFinal;  
        bool mIsThreshHold;
        bool mIsAbbreviated;    //< Abbreviated with time series style. 
        Int32 mColumnOffset;
        bool mIsReplacedText;   //< Replaced Text from Thresholds or other specified text.
        
        bool mHasBracket;
        MBase::String mPrefix;
        MBase::String mSuffix;

        NumberObjectHelper *mpNumberObjectHelper;
    };
    inline Int32 NumberObject::GetColumnOffset() const
    {
        return mColumnOffset;
    }
    inline double NumberObject::GetNumber() const
    {
        return mNumber;
    }
    inline void NumberObject::SetThreshHold(bool iIsThreshHold, Int32 iColor)
    {
        mIsThreshHold = iIsThreshHold;
        if (mIsThreshHold)
            mColor = iColor;
    }
    inline void NumberObject::SetHasBracket(bool iHasBracket)
    {
        mHasBracket = iHasBracket;
    }
    inline bool NumberObject::IsAbbreviated() const
    {
        return mIsAbbreviated;
    }
    inline bool NumberObject::IsReplacedText() const
    {
        return mIsReplacedText;
    }
    inline Int32 NumberObject::GetColor() const
    {
        return mColor;
    }
    inline void NumberObject::SetColor(Int32 iColor)
    {
        mColor = iColor;
    }
    inline void NumberObject::SetPrefix(MBase::String iPrefix)
    {
        mPrefix = iPrefix;
    }
    inline void NumberObject::SetSuffix(MBase::String iSuffix)
    {
        mSuffix = iSuffix;
    }
    inline void NumberObject::GetPrefix(MBase::String& orPrefix)
    {
        orPrefix =  mPrefix;
    }
    inline void NumberObject::GetSuffix(MBase::String& orSuffix)
    {
        orSuffix = mSuffix;
    }
    inline void NumberObject::SetNumber(double iNumber)
    {
        mNumber = iNumber;
    }
}

#endif