/*********************************************************************/
/*                                                                   */
/*                     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.Runtime.Serialization;
using AgentService.Platform.AMS;
using System.Collections.Generic;

namespace AgentService.Platform.DF
{

	

	/// <summary>
	/// Class ServiceDescription. Holds the description of a service.
	/// </summary>
	[Serializable()]
    [DataContract]
	public class ServiceDescription
	{

		public static readonly int AllSubTypes = 0;

		# region Members
        /// <summary>
        /// cached name used for the the
        /// ToString() method.
        /// </summary>
        protected string cachedName;
		/// <summary>
		/// name of the service
		/// </summary>
 		private string name;
		/// <summary>
		/// Gets the name of the service
		/// </summary>
        [DataMember]
		public string Name 
		{
			get 
			{
				return this.name;
			}
            set
            {
                this.name = value;
            }
		}

		/// <summary>
		/// type of the service
		/// </summary>
 		private string type;
		/// <summary>
		/// Gets the service type
		/// </summary>
        [DataMember]
		public string Type 
		{
			get 
			{
				return this.type;
			}
            set
            {
                this.type = value;
            }
		}

		/// <summary>
		/// service subtype
		/// </summary>
		private int subType;
		/// <summary>
		/// Gets the service subtype
		/// </summary>
        [DataMember]
		public int SubType  
		{
			get 
			{
				return this.subType;
			}
            set
            {
                this.subType = value;
            }
		}
		

		/// <summary>
		/// owner of the service
		/// </summary>
 		private AID owner;
		/// <summary>
		/// Gets the owner of the service
		/// </summary>
        [DataMember]
		public AID Owner 
		{
			get 
			{
				return this.owner;
			}
            set
            {
                this.owner = value;
            }
		}

		/// <summary>
		/// list of interaction protocols supported by the service
		/// </summary>
 		private List<string> protocols;
		/// <summary>
		/// Gets the collection of protocols supported by the service
		/// </summary>
        [DataMember]
        public List<string> Protocols 
		{
			get 
			{
				return this.protocols;
			}

            set
            {
                this.protocols = value;
            }
		}

		/// <summary>
		/// list of ontologies supported by the service
		/// </summary>
		private AgentService.Ontology.OntologyTypeDescriptorCollection ontologies;
		/// <summary>
		/// Gets the list of ontologies supported by the srrvice
		/// </summary>
        [DataMember]
        public AgentService.Ontology.OntologyTypeDescriptorCollection Ontologies
		{
			get 
			{
				return this.ontologies;
			}

            set
            {
                this.ontologies = value;
            }
		}
		/// <summary>
		/// list of content languages supported by the service
		/// </summary>
        private List<string> languages;
		/// <summary>
		/// Gets the list of content languages supported by the service
		/// </summary>
        [DataMember]
        public List<string> Languages 
		{
			get 
			{
				return this.languages;
			}

            set
            {
                this.languages = value;
            }
		}

		/// <summary>
		/// list of properties that discriminate the service
		/// </summary>
        private List<string> properties;
		/// <summary>
		/// Gets the properties that discriminate the service.
		/// </summary>
        [DataMember]
        public List<string> Properties 
		{
			get 
			{
				return this.properties;
			}

            set
            {
                this.properties = value;
            }
		}

		/// <summary>
		/// Flag indicating if the service is published by the platform.
		/// A service published by the platform is known also outside the
		/// platform.
		/// </summary>
		private bool bPublish;
		/// <summary>
		/// Gets the value of the publishing flag
		/// </summary>
        [DataMember]
		public bool AllowPublishing 
		{
			get
			{
				return this.bPublish;
			}
            set
            {
                this.bPublish = value;
            }
		}

		# endregion

		# region Constructor

        public ServiceDescription() { }

		/// <summary>
		/// Constructs a ServiceDescription object
		/// </summary>
		/// <param name="name">name of the service</param>
		/// <param name="type">type of the service</param>
		/// <param name="bPublish">flags indicating if the service allows publishing</param>
		/// <param name="subtype">subtype of the service</param>
		public ServiceDescription(string name, string type, int subtype, bool bPublish)
		{
			if (name == null)
				throw new ArgumentNullException("name", "service name cannot be null");
			if (type == null)
				throw new ArgumentNullException("type", "service type cannot be null");
			if (owner == null)
				throw new ArgumentNullException("owner", "service owner cannot be null");

			this.name = name;
			this.type = type;
			this.subType = subtype;
			this.protocols = new List<string>();
			this.ontologies = new AgentService.Ontology.OntologyTypeDescriptorCollection();
            this.languages = new List<string>();
            this.properties = new List<string>(); ;

			this.bPublish = bPublish;
		}


		/// <summary>
		/// Constructs a ServiceDescription object with the needed information
		/// </summary>
		/// <param name="name">Service name</param>
		/// <param name="type">Service type</param>
		/// <param name="owner">Name of the agent tha provide the service</param>
		public ServiceDescription(string name, string type)
		{
			if (name == null)
				throw new ArgumentNullException("name", "service name cannot be null");
			if (type == null)
				throw new ArgumentNullException("type", "service type cannot be null");

			this.name = name;
			this.type = type;
			this.subType = ServiceDescription.AllSubTypes;
            this.protocols = new List<string>();
			this.ontologies = new AgentService.Ontology.OntologyTypeDescriptorCollection();
            this.languages = new List<string>();
            this.properties = new List<string>();

			this.bPublish = true;
		}
        /// <summary>
        /// Creates a cache copy of the full name for the service description.
        /// </summary>
        protected void makeCachedName() 
        {
            this.cachedName = string.Format("{0}#{1}#{2}", this.name, this.type, this.subType);
        }
		/// <summary>
		/// Returns true if the given service description matcvhes the
		/// current ServiceDescription, by following the comparison criteria
		/// </summary>
		/// <param name="sd">service descirption candidate</param>
		/// <param name="flags">flags that describe how to perform the search</param>
		/// <returns>true if the candidate matches the current instance with the given flags</returns>
		public bool Match(ServiceDescription sd, ServiceComparison flags) 
		{
			string lowerName = this.name.ToLower();
			string lowerNameOther = sd.name.ToLower();
			bool bMatchNames = (lowerName.CompareTo(lowerNameOther) == 0);
			if (flags == (ServiceComparison.ByName | ServiceComparison.ByType | ServiceComparison.BySubType))
			{
				if ((this.type != null) && (sd.type != null))
				{
					bool bMatchTypes = (this.type.ToLower().CompareTo(sd.type.ToLower()) == 0);
					bool bMatchSubTypes = (this.subType == sd.subType);
					return (bMatchNames && bMatchTypes && bMatchSubTypes);
					

				}
				if ((this.type == null) && (sd.type == null))
				{
					// if we have null types, we do not
					// check further for sub types
					return bMatchNames;
				}
				return false;
			}
			if (flags == (ServiceComparison.ByName | ServiceComparison.ByType))
			{
				if ((this.type != null) && (sd.type != null))
				{
					bool bMatchTypes = (this.type.ToLower().CompareTo(sd.type.ToLower()) == 0);
					return (bMatchNames && bMatchTypes);
				}
				if ((this.type == null) && (sd.type == null))
				{
					return bMatchNames;
				}
				return false;
			
			}
			if (flags == ServiceComparison.ByName) 
			{
				return bMatchNames;
			}
			return false;
		}
		/// <summary>
		/// Returns true if two ServiceDescription objects are equal. The Equals
		/// method compares two services by comparing the names of the two services.
		/// String comparison is case insensitive.
		/// </summary>
		/// <param name="other">the other ServiceDescription object</param>
		/// <returns>boolean value indicating equality</returns>
		public override bool Equals(object other)
		{
			ServiceDescription sd = other as ServiceDescription;
			if (sd == null)
				return false;

			return  (this.name.ToLower().CompareTo(sd.name.ToLower()) == 0);
		}
        /// <summary>
        /// Gets a string representation of the
        /// ServiceDescription instance.
        /// </summary>
        /// <returns>string representation</returns>
        public override string ToString()
        {
            return this.cachedName;
        }
        /// <summary>
        /// Gets the hash code of the service description.
        /// The hash code is computed by using the string
        /// returned from the ToString() method.
        /// </summary>
        /// <returns>hash code of the Service Description</returns>
        public override int GetHashCode()
        {
            return this.cachedName.GetHashCode();
        }

		# endregion

		# region Methods
		
		/// <summary>
		/// Sets the agent that owns the service.
		/// </summary>
		/// <param name="aid">agent identifier of the owner</param>
		internal void SetOwner(AID aid) 
		{
			this.owner = aid;
		}

		# endregion

	}

}