clsPreferencesFile.cs

// C# ClassLib
// http://csharp-classlib.sourceforge.net
//
//
// Copyright (C) 2005 Marcel Joachim Kloubert
// 
// This program 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 2
// of the License, or (at your option) any later version.
// 
// This program 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 this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//

using System;
using System.IO;
using System.Xml;
using System.Xml.XPath;

namespace CSharp_ClassLib.Classes
{
        public class PreferencesFile : System.Object
        {
        private System.Xml.XmlDocument m_oXMLDocument;
                
                private System.Collections.ArrayList m_oPreferencesEntries;
                
            private const string XML_TAG_ROOT =  "preferences_file";
                private const string XML_TAG_ENTRIES =  "entries";      
                
                private const string XML_ATTRIBUTE_ID =  "id";
                private const string XML_ATTRIBUTE_CATEGORY =  "category";
                
                private const string XPATH_ALL_ENTRIES = "/" + XML_TAG_ROOT + "//" + XML_TAG_ENTRIES + "/child::*";
                
                public PreferencesFile ()
                {
                        this.InitRest();
                        
                        return;
                }
        
                public PreferencesFile (string Preferences_File)
                {
                        this.InitRest();
                        
                        this.LoadFromFile(Preferences_File);
                        
                        return;
                }
                
                public CSharp_ClassLib.Classes.PreferencesEntry[] Entries
                {
                        get
                        {
                                CSharp_ClassLib.Classes.PreferencesEntry[] oBuffer = new CSharp_ClassLib.Classes.PreferencesEntry[m_oPreferencesEntries.Count];
                                m_oPreferencesEntries.CopyTo(oBuffer);
                                
                                return oBuffer;
                        }
                }
                
                private void InitRest ()
                {
                        m_oXMLDocument = null;
                        
                        m_oPreferencesEntries = new System.Collections.ArrayList();
                        
                        return;
                }
                
                public void LoadFromFile (string Preferences_File)
                {
                        if (!System.IO.File.Exists(Preferences_File))
                                // file not found!
                                throw ( new System.IO.FileNotFoundException("Preferences file not found!", Preferences_File) );
                        
                // first create a temp document
                        System.Xml.XmlDocument oTEMPXMLDocument = new System.Xml.XmlDocument();                 
                        // init a new XPath document
                System.Xml.XPath.XPathDocument oXPathDocument = new System.Xml.XPath.XPathDocument(Preferences_File);
        
                try
                {
                        oTEMPXMLDocument.Load(Preferences_File);
        
                        // then read data
                        this.ReadPreferencesFileEntries(oXPathDocument);        
                        
                        m_oXMLDocument = oTEMPXMLDocument;
                }
                catch (System.Exception e)
                {
                        throw (e);
                }
                
                return;
                }
                
                private void ReadPreferencesFileEntries (System.Xml.XPath.XPathDocument XPath_Document)
                {
                        if (null == XPath_Document)
                                // argument is null!
                                throw ( new System.ArgumentNullException("XPath_Document", "Argument must not be null!") );
                        
                try
                {
                                // Create temporary preferences entry list
                        System.Collections.ArrayList m_oTempPreferencesEntries = new System.Collections.ArrayList();
        
                        System.Xml.XPath.XPathNavigator oXMLPathNav = XPath_Document.CreateNavigator();
                        System.Xml.XPath.XPathNodeIterator oXMLNodeIterator = oXMLPathNav.Select(XPATH_ALL_ENTRIES);
                
                        // Temporary preference entry
                        CSharp_ClassLib.Classes.PreferencesEntry oTMPEntry;
        
                        while ( oXMLNodeIterator.MoveNext() )
                        {
                        switch ( oXMLNodeIterator.Current.Name.ToLower().Trim() )
                        {
                                case "entry":
                                // first store data in a temporary PreferencesEntry instance
                                oTMPEntry = new CSharp_ClassLib.Classes.PreferencesEntry();
                                oTMPEntry.ID = oXMLNodeIterator.Current.GetAttribute(XML_ATTRIBUTE_ID, "");
                                oTMPEntry.Category = oXMLNodeIterator.Current.GetAttribute(XML_ATTRIBUTE_CATEGORY, "");
                                oTMPEntry.Value = oXMLNodeIterator.Current.Value;
                    
                                // add temp instance to list
                                m_oTempPreferencesEntries.Add(oTMPEntry);
                                break;
                        }            
                        }
                        
                        m_oPreferencesEntries = m_oTempPreferencesEntries;
                }
                catch (System.Exception e)
                {
                        throw(e);
                }
                
                return;                 
                }
        
        public string GetValue (string ID, bool ThrowException)
        {       
                return this.GetValue(ID, "", ThrowException);
        }
                
        public string GetValue (string ID, string Category, bool ThrowException)
        {       
                int i = 0;
                
                for (i = 0; i < this.m_oPreferencesEntries.Count; i++)
                {
                if ( (((CSharp_ClassLib.Classes.PreferencesEntry)m_oPreferencesEntries[i]).Category == Category) && (((CSharp_ClassLib.Classes.PreferencesEntry)m_oPreferencesEntries[i]).ID == ID) )
                        // entry found
                        return ((CSharp_ClassLib.Classes.PreferencesEntry)m_oPreferencesEntries[i]).Value;
                }
        
                // entry not found => use Default value or throw exception
                if (ThrowException)
                        throw ( new System.ArgumentOutOfRangeException("ID; Category", "Entry was not found!") );
                
                return "";
        }
                
        public string GetValue (string ID, string Category, string Default)
        {       
                int i = 0;
                
                for (i = 0; i < this.m_oPreferencesEntries.Count; i++)
                {
                if ( (((CSharp_ClassLib.Classes.PreferencesEntry)m_oPreferencesEntries[i]).Category == Category) && (((CSharp_ClassLib.Classes.PreferencesEntry)m_oPreferencesEntries[i]).ID == ID) )
                        // entry found
                        return ((CSharp_ClassLib.Classes.PreferencesEntry)m_oPreferencesEntries[i]).Value;
                }
        
                // entry not found => use Default value
                return Default;
        }
                
        public string GetValue (string ID, string Category)
        {       
                return this.GetValue(ID, Category, "");
        }
                
        public string GetValue (string ID)
        {       
                return this.GetValue(ID, "", "");
        }
        
                public void UpdateEntry (string ID, string Category, string NewValue)
                {
                        this.UpdateEntry (ID, Category, NewValue, false);
                        
                        return;
                }
        
                public void UpdateEntry (string ID, string Category, string NewValue, bool AutoAdd)
                {
                        int i = 0;
                
                        // check if this entry already exists
                        for (i = 0; i < m_oPreferencesEntries.Count; i++)
                        {
                                if ( (((PreferencesEntry)m_oPreferencesEntries[i]).Category == Category) && (((PreferencesEntry)m_oPreferencesEntries[i]).ID == ID) )
                                        // entry found
                                {
                                        ((PreferencesEntry)m_oPreferencesEntries[i]).Value = NewValue;

                                        return;
                                }
                        }

                        if (!AutoAdd)
                                // entry not found => error!
                                throw ( new System.ArgumentOutOfRangeException("ID; Category", "Entry was not found!") );                               
                        else
                                

                        return;
                }
                
                public void AddEntry (string ID, string Category, string NewValue)
                {
                        return;
                }
        }

        public class PreferencesEntry : System.Object
        {
        string m_strID = "";
        string m_strCategory = "";
        string m_strValue = "";
                
        public PreferencesEntry()
        {
                Category = "";
                ID = "";
                Value = "";
            
                return;
        }
        
        public PreferencesEntry(string category)
        {
                Category = category;
                ID = "";
                Value = "";
            
                return;
        }
        
        public PreferencesEntry(string category, string id)
        {
                Category = category;
                ID = id;
                Value = "";
            
                return;
        }
        
        public PreferencesEntry(string category, string id, string value)
        {
                Category = category;
                ID = id;
                Value = value;
            
                return;
        }
        
        public string ID
        {
                get { return m_strID; }
                set { m_strID = value; return; }
        }
        
        public string Category
        {
                get { return m_strCategory; }
                set { m_strCategory = value; return; }
        }
        
        public string Value
        {
                get { return m_strValue; }
                set { m_strValue = value; return; }
        }
        }       
}

---