/*********************************************************************/
/*                                                                   */
/*                     AgentService Framework                        */
/*                       www.agentservice.it                         */
/*                                                                   */
/* Copyright (C) 2007 l.i.d.o. - DIST, University of Genoa, Italy    */
/* GNU Lesser General Public License                                 */
/*                                                                   */
/* This library is free software; you can redistribute it and/or     */
/* modify it under the terms of the GNU Lesser General Public        */
/* License as published by the Free Software Foundation,             */
/* version 2.1 of the License.                                       */
/*                                                                   */
/* This library 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 */
/* Lesser General Public License for more details.                   */
/*                                                                   */
/* You should have received a copy of the GNU Lesser General Public  */
/* License along with this library; if not, write to the             */
/* Free Software Foundation, Inc., 59 Temple Place - Suite 330,      */
/* Boston, MA  02111-1307, USA.                                      */
/*                                                                   */
/*********************************************************************/
using System;
using System.Xml;
using System.Xml.Serialization;

namespace AgentService.Install.XmlDataModel
{
	/// <summary>
	/// Class XmlCoreInfo. Wrapper class
	/// for the XML tag lt;core /gt;. It
	/// Contains the information about
	/// the selected core modules.
	/// </summary>
	[Serializable]
	[XmlRoot(ElementName="core")]
	public class XmlCoreInfo : ICloneable
	{
        /// <summary>
        /// directory where the modules
        /// are stored.
        /// </summary>
        protected string binPath;
        /// <summary>
        /// Gets, set the directory where
        /// the modules are stored.
        /// </summary>
        [XmlAttribute(AttributeName="bin-path")]
        public string BinPath 
        {
            get 
            {
                return this.binPath;
            }
            set 
            {
                this.binPath = value;
            }
        }
        /// <summary>
        /// directory where che configuration
        /// files of the modules are stored.
        /// </summary>
        protected string confPath;
        /// <summary>
        /// Gets, sets the directory where the
        /// configuration files of the modules
        /// are stored.
        /// </summary>
        [XmlAttribute(AttributeName="conf-path")]
        public string ConfPath 
        {
            get 
            {
                return this.confPath;
            }
            set 
            {
                this.confPath = value;
            }
        }
		/// <summary>
		/// installation information for
		/// the platform storage module.
		/// </summary>
		protected XmlModuleInfo storage;
		/// <summary>
		/// Gets, sets the installation 
		/// information for the platform
		/// storage module.
		/// </summary>
		[XmlElement(ElementName="storage")]
		public XmlModuleInfo Storage 
		{
			get 
			{
				return this.storage;
			}
			set 
			{
				this.storage = value;
			}
		}
		/// <summary>
		/// installation information for
		/// the platform peristence module.
		/// </summary>
		protected XmlModuleInfo persistence;
		/// <summary>
		/// Gets, sets the installation 
		/// information for the platform
		/// persistence module.
		/// </summary>
		[XmlElement(ElementName="persistence")]
		public XmlModuleInfo Persistence 
		{
			get 
			{
				return this.persistence;
			}
			set 
			{
				this.persistence = value;
			}
		}
		/// <summary>
		/// installation information for
		/// the platform messaging module.
		/// </summary>
		protected XmlModuleInfo messaging;
		/// <summary>
		/// Gets, sets the installation 
		/// information for the platform
		/// messaging module.
		/// </summary>
		[XmlElement(ElementName="messaging")]
		public XmlModuleInfo Messaging 
		{
			get 
			{
				return this.messaging;
			}
			set 
			{
				this.messaging = value;
			}
		}
		/// <summary>
		/// installation information for
		/// the platform peristence module.
		/// </summary>
		protected XmlModuleInfo logging;
		/// <summary>
		/// Gets, sets the installation 
		/// information for the platform
		/// logging module.
		/// </summary>
		[XmlElement(ElementName="logging")]
		public XmlModuleInfo Logging 
		{
			get 
			{
				return this.logging;
			}
			set 
			{
				this.logging = value;
			}
		}
		/// <summary>
		/// Dummy default constructor used by
		/// the XML deserializer to create empty
		/// instances and the sets their properties
		/// reading them from the XML stream.
		/// </summary>		
		public XmlCoreInfo()
		{
			this.storage = new XmlModuleInfo();
			this.persistence = new XmlModuleInfo();
			this.logging = new XmlModuleInfo();
			this.messaging = new XmlModuleInfo();
		}
		/// <summary>
		/// Constructs an instance of the XmlCoreInfo 
		/// with the given parameters.
		/// </summary>
		/// <param name="storage">platform storage installation information</param>
		/// <param name="persistence">platform persistence installation information</param>
		/// <param name="messaging">platform messaging installation information</param>
		/// <param name="logging">platform logging installation information</param>
		public XmlCoreInfo(XmlModuleInfo storage, XmlModuleInfo persistence, XmlModuleInfo messaging, XmlModuleInfo logging)
		{
			this.storage = storage;
			this.persistence = persistence;
			this.messaging = messaging;
			this.logging = logging;
		}

		#region ICloneable Members
		/// <summary>
		/// Clones this instance of the XmlCoreInfo.
		/// </summary>
		/// <returns>identical copy of the instance</returns>
		public object Clone()
		{
			XmlCoreInfo clone = new XmlCoreInfo(this.storage.Clone() as XmlModuleInfo, 
								                this.persistence.Clone() as XmlModuleInfo, 
							                    this.messaging.Clone() as XmlModuleInfo, 
								                this.logging.Clone() as XmlModuleInfo);

            clone.binPath = (this.binPath != null ? this.binPath.Clone() as string : null);
            clone.confPath = (this.confPath != null ? this.confPath.Clone() as string : null);

            return clone;
		}

		#endregion

		/// <summary>
		/// Compares the current instance with a 
		/// given one.
		/// </summary>
		/// <param name="obj">other instance</param>
		/// <returns>true i the core modules of the two instances are the same</returns>
		public override bool Equals(object obj)
		{
			XmlCoreInfo core = obj as XmlCoreInfo;
			if (core != null)
			{
				return ((this.storage.Equals(core.storage) == true)	&&
						(this.persistence.Equals(core.persistence) == true) &&
						(this.messaging.Equals(core.messaging) == true) &&
						(this.logging.Equals(core.logging) == true));

			}
			return false;
		}
        /// <summary>
        /// Gets the hash code for this XmlCoreInfo instance.
        /// </summary>
        /// <returns>base hash code funcation</returns>
        public override int GetHashCode()
        {
            return base.GetHashCode();
        }
	}
}