/*********************************************************************/
/*                                                                   */
/*                     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 System.Runtime.Serialization.Formatters.Binary;
using AgentService.Ontology.Schema.Abstract;

namespace AgentService.Ontology.Schema {

	/// <summary>
	/// This class is the common ancestor of all ontological schemas.
	/// </summary>
    [Serializable]
    public abstract class ObjectSchema {

		public static readonly int mandatory = 0;
		
		public static readonly int optional = 1;
	
		public static readonly int unlimited = -1; //the cardinality.
    

		public static readonly string base_name = "Object";

		protected static ObjectSchema baseSchema = null;
    
		private bool encodingByOrder = false;


		/// <summary>
		/// Retrieves the generic base schema for all object.
		/// </summary>
		/// <returns>Return the base schema.</returns>
		public static ObjectSchema GetBaseSchema() 
		{
			return baseSchema;
		} 

		/// <summary>
		/// Adds a slot to the schema.
		/// </summary>
		/// <param name="name">The name of the slot.</param>
		/// <param name="slotSchema">The schema of the slot.</param>
		/// <param name="optionality">mandatory or optional.</param>
		public abstract void Add(string name, ObjectSchema slotSchema, int optionality);

		/// <summary>
		/// Adds a slot to the schema.
		/// </summary>
		/// <param name="name">The name of the slot.</param>
		/// <param name="slotSchema">The schema of the slot.</param>
		public abstract void Add(string name, ObjectSchema slotSchema);

		/// <summary>
		/// Adds a slot to the schema.
		/// </summary>
		/// <param name="name">The name of the slot.</param>
		/// <param name="elementSchema">The schema of the slot.</param>
		/// <param name="cardMin">The slot at least get <code>cardMin</code>values.</param>
		/// <param name="cardMax">The slot at most get <code>cardMax</code>values.</param>
		public abstract void Add(string name, ObjectSchema elementsSchema, int cardMin, int cardMax);

		/// <summary>
		/// Adds a slot to the schema.
		/// </summary>
		/// <param name="name">The name of the slot.</param>
		/// <param name="elementSchema">The schema of the slot.</param>
		/// <param name="cardMin">The slot at least get <code>cardMin</code>values.</param>
		/// <param name="cardMax">The slot at most get <code>cardMax</code>values.</param>
		/// <param name="aggType">The aggregate type of the slot.</param>
		public abstract void Add(string name, ObjectSchema elementsSchema, int cardMin, int cardMax, string aggType);

		/// <summary>
		/// Adds a super schema to the schema. The schema will inherit all the characteristics from the super schema.
		/// </summary>
		/// <param name="superSchema"></param>
		public abstract void AddSuperSchema(ObjectSchema superSchema);

		/// <summary>
		/// Adds a facet.
		/// </summary>
		/// <param name="slotName">The name of the facet.</param>
		/// <param name="f">The facet.</param>
		public abstract void AddFacet(string slotName, Facet f);
		
		/// <summary>
		/// Sets the property EncodingByOrder of slots.
		/// </summary>
		/// <param name="b">TRUE or FALSE</param>
		public void setEncodingByOrder(bool b) 
		{
			encodingByOrder = b;
		}
		
		/// <summary>
		/// Gets the value of the EncodingByOrder property
		/// </summary>
		/// <returns>TRUE or FALSE.</returns>
		public bool GetEncodingByOrder() 
		{
			return encodingByOrder;
		}
		
		/// <summary>
		/// Retrieves the name of the type of this schema.
		/// </summary>
		/// <returns>The name of the type of the schema.</returns>
		public abstract string GetTypeName();

		/// <summary>
		/// Returns all the names of the slots ( including the slots of super schemas ).
		/// </summary>
		/// <returns></returns>
		public abstract string[] GetNames();

		/// <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 abstract void Validate(AbsObject abs, Ontology onto);

		/// <summary>
		/// Gets the schema of a given slot.
		/// </summary>
		/// <param name="name">The name of the slot.</param>
		/// <returns></returns>
		public abstract ObjectSchema GetSchema(string name);

		/// <summary>
		/// Returns true if this schema contanins a slot with a given name.
		/// </summary>
		/// <param name="name">The name of the slot.</param>
		/// <returns></returns>
		public abstract bool ContainsSlot(string name);

		/// <summary>
		/// Checks if the given slot is mandatory.
		/// </summary>
		/// <param name="name">The name of the slot.</param>
		/// <returns></returns>
		public abstract bool IsMandatory(string name);
	
		/// <summary>
		/// Checks if a given schema is compatible with this schema.
		/// </summary>
		/// <param name="s">The object to check.</param>
		/// <returns></returns>
		public abstract bool IsCompatibleWith(ObjectSchema s);
  	
		/// <summary>
		/// Returns true if the given schema descends from this schema.
		/// </summary>
		/// <param name="s">The object.</param>
		/// <returns></returns>
		public abstract bool DescendsFrom(ObjectSchema s);
  	
		/// <summary>
		/// Returns an array containing the facets of a given slot.
		/// </summary>
		/// <param name="slotName">The name of the slot.</param>
		/// <returns></returns>
		public abstract Facet[] GetFacets(string slotName);

		/// <summary>
		/// Returns an abstract object that represents this schema.
		/// </summary>
		/// <returns></returns>
		public abstract AbsObject NewInstance();

    }
}