/*********************************************************************/
/*                                                                   */
/*                     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>
	/// AggregateSchema is the schema of aggregate entities in an ontology.
	/// </summary>
    public class AggregateSchema : TermSchema {
		public static readonly new string base_name = "Aggregate";
		private static new AggregateSchema baseSchema = new AggregateSchema();

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

		/// <summary>
		/// Constructs a schema with a given <code>typeName</code> that vinculates an entity to be a generic aggregate.
		/// </summary>
		/// <param name="typeName">It is the name of the aggregate</param>
		public AggregateSchema(string typeName):base(typeName) 
		{	
		}


		/// <summary>
		/// Retrieves the generic AggregateSchema for all aggregates.
		/// </summary>
		/// <returns>Returns a ObjectSchema that represent the generic AggregateSchema</returns>
		public static new ObjectSchema GetBaseSchema() 
		{
			return baseSchema;
		}

		/// <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">The possible base schema</param>
		/// <returns>Returns true if <code>s</code> is a base schema for this schema</returns>
		public override bool DescendsFrom(ObjectSchema s)
		{
			try
			{
				if (s != null) 
				{
					if (s.Equals(GetBaseSchema())) 
					{
						return true;
					}
					return base.DescendsFrom(s);
				}
				else 
				{
					return false;
				}
			}
			catch(Exception ex)
			{
				throw new OntologyException(ex.ToString());
			}
		}

		/// <summary>
		/// Returns an abstract object that represents this aggregate.
		/// </summary>
		/// <returns></returns>
		public override AbsObject NewInstance() 
		{
			return new AbsAggregate(GetTypeName());
		} 

		/// <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 override void Validate(AbsObject abs, Ontology onto)
		{
			try
			{
				if (!(abs is AbsAggregate)) 
				{
					throw new ValidationException(abs.ToString()+" is not an AbsAggregate");
				}
  		
				AbsAggregate agg = (AbsAggregate) abs;
				for(int i=0; i<agg.Size(); i++)
				{
					AbsTerm el = (AbsTerm) agg.getElement(i);
					ObjectSchema s = onto.GetSchema(el.GetTypeName());
					s.Validate(el, onto);
				}
			}
			catch(Exception ex)
			{
				throw new ValidationException("Unable to Validate "+abs.ToString()+": "+ex.ToString());
			}
		}

		/// <summary>
		/// 
		/// </summary>
		/// <param name="o"></param>
		/// <returns></returns>
		public new bool IsEqualTo(object o) 
		{
			try
			{
				if (o != null) 
				{
					return (o is AggregateSchema);
				}
				else 
				{
					return false;
				}
			}
			catch(Exception ex)
			{
				throw new OntologyException(ex.ToString());
			}
		}


    }
}