ImplementationMatrix.cs

#region Header
/*
    ==============================================================================
      Author: Zoltan Hrabovszki <zh@openkeyword.de>

      Copyright © 2012, 2013, 2014, 2015 IT-Beratung Hrabovszki
      www.OpenKeyWord.de
    ============================================================================== 

    This file is part of OpenKeyWord.

    OpenKeyWord is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenKeyWord is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with OpenKeyWord.  If not, see <http://www.gnu.org/licenses/>.

    Diese Datei ist Teil von OpenKeyWord.

    OpenKeyWord ist Freie Software: Sie können es unter den Bedingungen
    der GNU General Public License, wie von der Free Software Foundation,
    Version 3 der Lizenz oder (nach Ihrer Wahl) jeder späteren
    veröffentlichten Version, weiterverbreiten und/oder modifizieren.

    OpenKeyWord wird in der Hoffnung, dass es nützlich sein wird, aber
    OHNE JEDE GEWÄHRLEISTUNG, bereitgestellt; sogar ohne die implizite
    Gewährleistung der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK.
    Siehe die GNU General Public License für weitere Details.

    Sie sollten eine Kopie der GNU General Public License zusammen mit 
    OpenKeyWord erhalten haben. Wenn nicht, siehe <http://www.gnu.org/licenses/>.
*/
#endregion Header

namespace OKW.ImplementationMatrix
{
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Xml.Serialization;

    using OKW.Log;

    public class ImplementationMatrix
    {
        #region Fields

        public SerializableDictionary<string, string> cvImplementationMatrix = new SerializableDictionary<string, string>();

        public List<string> cvKeywords = new List<string>();

        public List<string> cvNamesOfGUIClasses = new List<string>();

        public string OKW_ImplementationMatrix_xml = string.Empty;

        protected static ImplementationMatrix instance = null;

        private Logger Log = Logger.Instance;

        #endregion Fields

        #region Constructors

        private ImplementationMatrix()
        {
            this.finalizeMe = true;
        }

        #endregion Constructors

        #region Properties

        public static ImplementationMatrix Instance
        {
            get
            {
                if ( instance == null)
                {
                    instance = new ImplementationMatrix();
                    instance.Init();
                }

                return instance;
            }
        }

        #endregion Properties

        #region Methods

        public string GetImplementation(string fpsKey)
        {
            string lvsReturn = string.Empty;

            if (this.cvImplementationMatrix.ContainsKey(fpsKey))
            {
                lvsReturn = this.cvImplementationMatrix[fpsKey];
            }
            else
            {
                lvsReturn = "?";
            }

            return lvsReturn;
        }

        public void Init()
        {
            this.Log.LogFunctionStartDebug(this.GetType().FullName + ".Init");

            // Klassen Variablen erst löschen...
            this.OKW_ImplementationMatrix_xml = string.Empty;

            // Listen und Dictionary Löschen
            this.cvImplementationMatrix.Clear();
            this.cvKeywords.Clear();
            this.cvNamesOfGUIClasses.Clear();

            // ... und dann alles Initialisieren!
            // 1. Setze Pfad und
            this.OKW_ImplementationMatrix_xml = OKW_Ini.Instance.OKW_Enviroment.File_OKW_ImplementationMatrix_xml;

            if (!string.IsNullOrEmpty(this.OKW_ImplementationMatrix_xml))
            {
                this.Log.LogPrintDebug("OKW Memorize Datei = >>" + this.OKW_ImplementationMatrix_xml + "<<");
                if (System.IO.File.Exists(this.OKW_ImplementationMatrix_xml))
                {
                    // Lesen der Daten
                    this.Read();
                }
                else
                {
                    // Deafault werte Lesen.
                    this.Log.LogWarning("Datei: >>" + this.OKW_ImplementationMatrix_xml + "<< nicht gefunden.");
                }
            }
            else
            {
                this.Log.LogWarning("Enviroment variable 'OKWIni' not set!");
            }

            this.Log.LogFunctionEndDebug();
            return;
        }

        public void Read()
        {
            this.Log.LogFunctionStartDebug( this.GetType().FullName + "Read()");

            try
            {
                XmlSerializer serializer = new XmlSerializer(typeof(ImplementationMatrix));
                StreamReader fs = new StreamReader(this.OKW_ImplementationMatrix_xml);
                instance = (ImplementationMatrix)serializer.Deserialize(fs);
                fs.Close();
            }
            finally
            {
                this.Log.LogFunctionEndDebug();
            }

            return;
        }

        public void Save()
        {
            this.Log.LogFunctionStartDebug(instance.GetType().FullName + "Save()");

            try
            {
                XmlSerializer serializer = new XmlSerializer(typeof(ImplementationMatrix));
                StreamWriter fs = new StreamWriter(this.OKW_ImplementationMatrix_xml, false);
                serializer.Serialize(fs, instance);
                fs.Close();
            }
            finally
            {
                this.Log.LogFunctionEndDebug();
            }

            return;
        }

        public void SetImplementation(string fpsNameOfGUIClass, string fpsKeyWord, string fpsImplemented)
        {
            this.AddNameOfGUIClass(fpsNameOfGUIClass);
            this.AddKeyword(fpsKeyWord);

            string lvskey = fpsNameOfGUIClass + ";" + fpsKeyWord;

            if (fpsImplemented == "P" || fpsImplemented == "F" || fpsImplemented == "N")
            {
                this.AddImplementation(lvskey, fpsImplemented);
            }
            else{
                throw new OKWNotAllowedValueException("Nur Werte 'Y' und 'N' sind erlaubt");
            }

            return;
        }

        public void WriteResultXML()
        {
            string lvskey;

            foreach (string lvsKeyword in this.cvKeywords)
            {
                foreach (string lvsClassName in this.cvNamesOfGUIClasses)
                {
                    lvskey = lvsClassName + ";" + lvsKeyword;

                    System.Console.WriteLine("<td>" + this.GetImplementation(lvskey) + "</td>");
                }
            }

            return;
        }

        private void AddImplementation(string fpsKey, string fpsImplemented)
        {
            if (this.cvImplementationMatrix.ContainsKey(fpsKey))
            {
                if (fpsImplemented=="F" & this.cvImplementationMatrix[fpsKey] == "N")
                {
                    throw new Exception("001: Fehler in Matrix: " + this.cvImplementationMatrix[fpsKey] + "-Wert kann nicht auf 'F' gesetzt werden.");
                }
                if (fpsImplemented=="F" & this.cvImplementationMatrix[fpsKey] == "F")
                {
                    this.cvImplementationMatrix[fpsKey] = "F";
                }
                if (fpsImplemented=="F" & this.cvImplementationMatrix[fpsKey] == "P")
                {
                    this.cvImplementationMatrix[fpsKey] = "F";
                }
                if (fpsImplemented=="P" & this.cvImplementationMatrix[fpsKey] == "N")
                {
                    throw new Exception("002: Fehler in Matrix: " + this.cvImplementationMatrix[fpsKey] + "-Wert kann nicht auf 'P' gesetzt werden.");
                }
                if (fpsImplemented=="P" & this.cvImplementationMatrix[fpsKey] == "F")
                {
                    this.cvImplementationMatrix[fpsKey] = "F";
                }
                if (fpsImplemented=="N" & this.cvImplementationMatrix[fpsKey] == "P")
                {
                    throw new Exception("003: Fehler in Matrix: " + this.cvImplementationMatrix[fpsKey] + "-Wert kann nicht auf 'N' gesetzt werden.");
                }
                if (fpsImplemented=="N" & this.cvImplementationMatrix[fpsKey] == "F")
                {
                    throw new Exception("004: Fehler in Matrix: " + this.cvImplementationMatrix[fpsKey] + "-Wert kann nicht auf 'N' gesetzt werden.");
                }
                if (fpsImplemented=="N" & this.cvImplementationMatrix[fpsKey] == "N")
                {
                    this.cvImplementationMatrix[fpsKey] = "N";
                }
            }
            else
            {
                this.cvImplementationMatrix.Add(fpsKey,fpsImplemented);
            }

            return;
        }

        public void SaveAs_CSV()
        {
            string lvsZeile;
            System.IO.StreamWriter file = new System.IO.StreamWriter(@"C:\temp\ImplementationMatrix\ImplementationMatrix.csv");

            // Spaltenköpfe schreiben
            lvsZeile = "GUI-Class";
            foreach ( string Keyword in this.cvKeywords )
            {
                lvsZeile = lvsZeile + ";" + Keyword;
            }
            file.WriteLine(lvsZeile);
            
            // Body Schreiben
            foreach ( string GUIKlassName in this.cvNamesOfGUIClasses )
            {
                lvsZeile = GUIKlassName;

                foreach ( string Keyword in this.cvKeywords )
                {
                    lvsZeile = lvsZeile + ";" + this.GetImplementation(GUIKlassName + ";" + Keyword);
                }
                
                file.WriteLine(lvsZeile);
            }
            
            file.Close();
            
            return;
        }

        public void SaveAs_HTML()
        {
            System.IO.StreamWriter file = new System.IO.StreamWriter(@"C:\temp\ImplementationMatrix\ImplementationMatrix.html");
//
            file.WriteLine("<html>");
            file.WriteLine("    <head>");
            
            file.WriteLine("    <style type=\"text/css\">");
            file.WriteLine("    td.P{");
            file.WriteLine("    text-align:center;");
            file.WriteLine("    background-color:#00FF00;");
            file.WriteLine("    }");
            file.WriteLine("    td.F{");
            file.WriteLine("    text-align:center;");
            file.WriteLine("    background-color:#FF0000;");
            file.WriteLine("    }");
            file.WriteLine("    td.N{");
            file.WriteLine("    text-align:center;");
            file.WriteLine("    background-color:#000000;");
            file.WriteLine("    }");
            
            file.WriteLine("    th.rotate {");
            file.WriteLine("    /* Something you can count on */");
            file.WriteLine("    height: 200px;");
            file.WriteLine("    white-space: nowrap;");
            file.WriteLine("    }");

            file.WriteLine("    th.rotate > div {");
            file.WriteLine("    transform: ");
            file.WriteLine("    /* Magic Numbers */");
            file.WriteLine("    translate(0px, 90px)");
            file.WriteLine("    /* 45 is really 360 - 45 */");
            file.WriteLine("    rotate(-90deg);");
            file.WriteLine("    width: 25px;");
            file.WriteLine("    }");
            file.WriteLine("    th.rotate > div > span {");
            file.WriteLine("    padding: 5px 10px;");
            file.WriteLine("    }");

            file.WriteLine("    </style>");
            
            file.WriteLine("    </head>");

            file.WriteLine("    <body>");

            file.WriteLine("    <table border=\"1\">");
            file.WriteLine("        <tr>");
            // Spaltenköpfe schreiben
            file.WriteLine("            <th>GUI-Class</th>");
            foreach ( string Keyword in this.cvKeywords )
            {
                file.WriteLine("            <th class=\"rotate\"><div><span>" + Keyword + "</span></div></th>");
            }
            file.WriteLine("        </tr>");

            
            // Body Schreiben
            foreach ( string GUIKlassName in this.cvNamesOfGUIClasses )
            {
                file.WriteLine("        <tr>");
                file.WriteLine("            <th>" + GUIKlassName + "</th>");

                foreach ( string Keyword in this.cvKeywords )
                {
                    string Wert = this.GetImplementation(GUIKlassName + ";" + Keyword);
                    file.WriteLine("            <td class=\""+ Wert +"\" align=\"center\">" + Wert + "</td>");
                }
                
                file.WriteLine("        </tr>");
            }
            file.WriteLine("    </table>");

            file.WriteLine("    </body>");
            file.WriteLine("</html>");
            file.Close();
            
            return;
        }

        
        private void AddKeyword(string fpsKeyword)
        {
            if (!this.cvKeywords.Contains(fpsKeyword))
            {
                this.cvKeywords.Add(fpsKeyword);
            }

            return;
        }

        private void AddNameOfGUIClass(string fpsNameOfGUIClass)
        {
            if (!this.cvNamesOfGUIClasses.Contains(fpsNameOfGUIClass))
            {
                this.cvNamesOfGUIClasses.Add(fpsNameOfGUIClass);
            }

            return;
        }

        bool finalizeMe;
        ~ ImplementationMatrix()
        {
            if (this.finalizeMe)
            {
                this.SaveAs_HTML();
                this.Save();
                this.finalizeMe=false;
            }
        }

        #endregion Methods
    }
}