OKW.LogMessenger Class Reference

Public Member Functions
	LogMessenger (string fpsClassname)
string	GetMessage (string MethodName, string TextKey)
string	GetMessage (string MethodName, string TextKey, object Parameter_1)
	Gets the Message for the Methodename/TextKey with one Parametres. More...
string	GetMessage (string MethodName, string TextKey, object Parameter_1, object Parameter_2)
	Gets the Message for the Methodename/TextKey with one Parametres. More...
string	GetMessage (string MethodName, string TextKey, object Parameter_1, object Parameter_2, object Parameter_3)
	Gets the Message for the Methodename/TextKey with one Parametres. More...

Private Member Functions
void	Init ()
	This constructor has no Parameter and uses the default values for the config-file and Actual/default language(=EN) More...
string	ReadMessage (string ClassName, string MethodName, string TextKey)
	Exceptions OKWMessageNotFoundException if a Message ist not found or if more then one Message is found for the Given Parmeter. More...

Private Attributes
bool	bInit = false
string	cvsClassName = string.Empty
string	MyXMLFile = string.Empty
XPathDocument	MyXPathDocument
XPathNavigator	MyXPathNavigator

Detailed Description

Author

Zoltan Hrabovszki

Date

2013_12_22

Constructor & Destructor Documentation

OKW.LogMessenger.LogMessenger

(

string

fpsClassname

)

Author

Zoltan Hrabovszki

Date

2013_12_22

        {
            this.cvsClassName = fpsClassname;
            this.Init();
        }

Member Function Documentation

string OKW.LogMessenger.GetMessage	(	string	MethodName,
		string	TextKey
	)

Gets the Message for the Methodename/TextKey without any Parametres.

Parameters

MethodName	Name of the Method
TextKey	of the message

Returns

Log-Message for the given Parameter.

Author

Zoltan Hrabovszki

Date

2013.12.22

        {
            string lvs_Return = "Message Not Found!";

            lvs_Return = this.ReadMessage(this.cvsClassName, MethodName, TextKey);

            return lvs_Return;
        }

Here is the caller graph for this function:

string OKW.LogMessenger.GetMessage	(	string	MethodName,
		string	TextKey,
		object	Parameter_1
	)

Gets the Message for the Methodename/TextKey with one Parametres.

Parameters

MethodName	Name of the Method
TextKey	of the message
Parameter_1	One Value inserted in the Log-Message

Returns

Log-Message for the given Parameter.

Author

Zoltan Hrabovszki

Date

2013.12.22

        {
            string lvs_Return = string.Empty;

            lvs_Return = this.ReadMessage(this.cvsClassName, MethodName, TextKey);
            lvs_Return = string.Format(lvs_Return, Parameter_1);

            return lvs_Return;
        }

string OKW.LogMessenger.GetMessage	(	string	MethodName,
		string	TextKey,
		object	Parameter_1,
		object	Parameter_2
	)

Gets the Message for the Methodename/TextKey with one Parametres.

Parameters

MethodName	Name of the Method
TextKey	of the message
Parameter_1	First Value inserted in the Log-Message
Parameter_2	Second Value inserted in the Log-Message

Returns

Log-Message for the given Parameter.

Author

Zoltan Hrabovszki

Date

2013.12.22

        {
            string lvs_Return = "Message Not Found!";

            lvs_Return = this.ReadMessage(this.cvsClassName, MethodName, TextKey);
            lvs_Return = string.Format(lvs_Return, Parameter_1, Parameter_2);

            return lvs_Return;
        }

string OKW.LogMessenger.GetMessage	(	string	MethodName,
		string	TextKey,
		object	Parameter_1,
		object	Parameter_2,
		object	Parameter_3
	)

Gets the Message for the Methodename/TextKey with one Parametres.

Parameters

MethodName	Name of the Method
TextKey	of the message
Parameter_1	First Value inserted in the Log-Message
Parameter_2	Second Value inserted in the Log-Message

Returns

Log-Message for the given Parameter.

Author

Zoltan Hrabovszki

Date

2013.12.22

        {
            string lvs_Return = "Message Not Found!";

            lvs_Return = this.ReadMessage(this.cvsClassName, MethodName, TextKey);
            lvs_Return = string.Format(lvs_Return, Parameter_1, Parameter_2, Parameter_3);

            return lvs_Return;
        }

void OKW.LogMessenger.Init ( )

private

This constructor has no Parameter and uses the default values for the config-file and Actual/default language(=EN)

Author

Zoltan Hrabovszki

Date

2013_12_22

        {
            if (!this.bInit)
            {
                try
                {
                    this.MyXMLFile = System.IO.Path.Combine( OKW_Ini.Instance.OKW_Enviroment.PathLog, this.cvsClassName + ".xml");

                    if (!System.IO.File.Exists(this.MyXMLFile))
                    {
                        System.Console.WriteLine("============================================================================================================");
                        System.Console.WriteLine("OKW Exception: File not found! -> '" + this.MyXMLFile + "'");
                        System.Console.WriteLine("============================================================================================================");

                        throw new FileNotFoundException("File not found! The File was: '" + this.MyXMLFile + "'");
                    }
                    else
                    {
                        this.MyXPathDocument = new XPathDocument(this.MyXMLFile);
                        this.MyXPathNavigator = this.MyXPathDocument.CreateNavigator();
                    }

                    this.bInit = true;
                }
                finally
                {
                    System.Console.WriteLine(string.Empty);
                }
            }
        }

string OKW.LogMessenger.ReadMessage ( string  ClassName, string  MethodName, string  TextKey  )

private

Exceptions

OKWMessageNotFoundException

if a Message ist not found or if more then one Message is found for the Given Parmeter.

Parameters

ClassName	Name of the Class.
MethodName	Name of the Method.
TextKey	Key for the Text-Message.

Returns

Rreturns the Message for the given language or default language if given languae does not exist
_"Message Not Found!"_ will be returnd, if a doesn´s exist.

Author

Zoltan Hrabovszki

Date

2013_12_22

        {
            string lvsReturn = "Message Not Found!";
            string myPath = "//Class[@name='" + ClassName + "']/Method[@name='" + MethodName + "']/Text[@key='" + TextKey + "']/ " + OKW.OKWLanguage.Instance.Language;

            XPathNodeIterator iter = this.MyXPathNavigator.Select(myPath);

            if (iter.Count < 1 || iter.Count > 1)
            {
                // Es wurde kein Wert gefunden -> Exception MsgNitFound auslösen...
                throw new OKWMessageNotFoundException("Message not Found. Class: " + ClassName +
                                                      ",  Method: " + MethodName +
                                                      ", TextKey: " + TextKey,
                                                      ", Gefunden Werte: " + iter.Count);
            }
            else
            {
                iter.MoveNext();
                lvsReturn = iter.Current.Value;
            }
            
            return lvsReturn;
        }

---

The documentation for this class was generated from the following file:

• OKW/Develop/LogMessenger.cs