/*********************************************************************/
/*                                                                   */
/*                     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 AgentService.Ontology;
using AgentService.Ontology.Schema.Abstract;
using System;
using AgentService.Ontology.Validation;

namespace AgentService.Ontology.Schema 
{

	/// <summary>
	/// This is the class used to define schemas of agent actions in an ontology.
	/// </summary>
    public class AgentActionSchema : ConceptSchema 
	{
		public static readonly new string  base_name= "AgentActionSchema";
		private static new AgentActionSchema baseSchema = new AgentActionSchema();


		/// <summary>
		/// Constructs a schema that vinculates an entity to be a generic agent action.
		/// </summary>
        private AgentActionSchema()
            : base(AgentActionSchema.base_name)
		{
		}

		/// <summary>
		/// Creates an AgentActionSchema with a given type-name.
		/// </summary>
		/// <param name="typeName">The name of this <code>AgentActionSchema</code></param>
		public AgentActionSchema(string typeName): base(typeName) 
		{
		}

		/// <summary>
		/// Retrieves the generic base schema for all agent actions.
		/// </summary>
		/// <returns>Returns the generic base schema for all agent actions.</returns>
        public static new ObjectSchema GetBaseSchema() //Upper case of GetBaseSchema
		{
			return baseSchema;
		}

		/// <summary>
		/// Adds a slot of type PredicateSchema to this schema.
		/// </summary>
		/// <param name="name">The name of the slot.</param>
		/// <param name="slotSchema">The schema of the slot.</param>
		public void add(string name, PredicateSchema slotSchema) 
		{
			base.Add(name, slotSchema);
		}

		/// <summary>
		/// Adds a slot of type PredicateSchema to this schema.
		/// </summary>
		/// <param name="name">The name of the slot.</param>
		/// <param name="slotSchema">The schema of the slot.</param>
		/// <param name="optionality">The optionality, i.e. <code>OPTIONAL</code> or <code>MANDATORY</code></param>
		public void add(string name, PredicateSchema slotSchema, int optionality) 
		{
			base.Add(name, slotSchema, optionality);
		}

		/// <summary>
		/// Returns true if 
		///- s is the base schema for the XXXSchema class and this schema is
		///	 an instance of (e.g. s is ConceptSchema.GetBaseSchema() and this 
		///	 schema is an instance of ConceptSchema)
		///	- s is the base schema for a super-class of the XXXSchema class and
		///	 this schema is an instance of (e.g. s is TermSchema.GetBaseSchema()
		///	 and this schema is an instance of ConceptSchema.
		/// </summary>
		/// <param name="s">Object schema</param>
		/// <returns>Returns true if <code>s</code> is a base schema for this schema.</returns>
		protected new bool DescendsFrom(ObjectSchema s) 
		{
			try
			{
				if (s != null) 
				{
					if (s.Equals(GetBaseSchema())) 
					{
						return true;
					}
					if (base.DescendsFrom(s)) 
					{
						return true;
					}
					return ContentElementSchema.GetBaseSchema().DescendsFrom(s);
				}
				else 
				{
					return false;
				}
			}
			catch(Exception ex)
			{
				throw new OntologyException(ex.ToString());
			}

		}

		/// <summary>
		/// Returns an abstract object that represents this agent action.
		/// </summary>
		/// <returns></returns>
		public override AbsObject NewInstance()
		{
			try
			{
				return new AbsAgentAction(GetTypeName());
			}
			catch(Exception ex)
			{
				throw new OntologyException(ex.ToString());
			}
		} 

	
		/// <summary>
		/// Validates a given abstract object, using a given ontology.
		/// </summary>
		/// <param name="abs">The abstract object to Validate.</param>
		/// <param name="onto">The ontology to use.</param>
		public new void Validate(AbsObject abs, Ontology onto)
		{
			try
			{
				if (!(abs is AbsAgentAction)) 
				{
					throw new ValidationException(abs+" is not an AbsAgentAction");
				}
				ValidateSlots(abs, onto);
			}
			catch(Exception ex)
			{
				throw new ValidationException("Unable to Validate "+abs.ToString()+": "+ex.ToString());
			}
		}

    }
}