/*
    * @author Giorgos Anestis, TUC/MUSIC
    * 
    * @version 2.0
    */
   package org.dbe.studio.tools.ontologyviewer.metamodels.odm;
   
   import java.util.Hashtable;
   import java.util.Vector;
  
  /***
   * An ontology class provides an abstraction mechanism for grouping 
   * resources with similar characteristics. Like RDF classes, every OWL 
   * class is associated with a set of individuals, called the class extension. 
   * The individuals in the class extension are called the instances of the class
   *   
   * Two OWL class identifiers are predefined, namely the classes
   * owl:Thing and  owl:Nothing. The class extension of owl:Thing is the set of
   * all individuals. The class extension of owl:Nothing is the empty set.
   * Consequently, every OWL class is a subclass of owl:Thing and owl:Nothing is
   * a subclass of every class
   * 
   * OWL and ODM distinguishes six types of class descriptions.
   * Each one of those types will be represented by subclasses of
   * this abstract class
   * 
   */
  
  public abstract class OdmOntologyClass {
  
  	String name;
  	String id;
  	OdmOntology ontology; 
  
  	Vector objectProperties;
  	Hashtable datatypeProperties;
  	Vector classExtension;
  	Vector annotationProps;  //list of OdmAnnotationProperty class instances
  	
  	Vector subClassOf ;			// the list of supper classes of this classes
  	Hashtable superClassOf;
  	Vector equivalentClasses;
  	Vector disjointWithClasses;
  	
  	
  	public OdmOntologyClass() {
  		
  	}
  	
  	public OdmOntologyClass(OdmOntology ontology) {
  		
  		//It keeps a reference to the ontology it belongs to
  		this.ontology = ontology;
  		//It adds itself to the ontology it belongs to !!
  		if (this instanceof OdmDataRange ) {
  			this.ontology.addDataRange((OdmDataRange)this);
  		}
  		else {
  			this.ontology.addClass(this);
  		}
  	}
  	
  	public OdmOntologyClass(OdmOntology ontology, String name, String id) {
  		super();
  		//It keeps a reference to the ontology it belongs to
  		this.ontology = ontology;
  		//It adds itself to the ontology it belongs to !!			
  		
  		this.name = name;
  		this.id = id;
  		
  		if (this instanceof OdmDataRange ) {
  			this.ontology.addDataRange((OdmDataRange)this);
  		}
  		else {
  			this.ontology.addClass(this);
  		}
  	}
  	
  	public void addObjectProperty(OdmObjectProperty p) {
  		if (objectProperties == null) {
  			objectProperties = new Vector();
  		}		
  		objectProperties.add(p);
  	}
  	
  	public void removeObjectProperty(OdmObjectProperty p) {
  		if (objectProperties != null) {
  			objectProperties.remove(p);
  		}
  	}
  	
  	public void addDatatypeProperty(OdmDatatypeProperty p) {
  		if (datatypeProperties == null) {
  			datatypeProperties = new Hashtable();
  		}		
  		datatypeProperties.put(p.getId(),p);
  	}
  	
 	public void removeDatatypeProperty(OdmDatatypeProperty p) {
 		if (datatypeProperties != null) {
 			datatypeProperties.remove(p.getId());
 		}
 	}
 	
 	public void addClassInstance(OdmOntologyClassInst oci) {
 		if (classExtension == null) {
 			classExtension = new Vector();
 		}
 		classExtension.add(oci);
 	}
 	
 	public void removeClassInstance(OdmOntologyClassInst oci) {
 		if (classExtension != null) {
 			classExtension.remove(oci);
 		}
 	}
 	
 	public void addAnnotationProp(OdmAnnotationProperty ap) {
 		if ( annotationProps == null ) {
 			annotationProps = new Vector();
 		}
 		annotationProps.add(ap);
 		
 	}
 	
 	public void removeAnnotationProp(OdmAnnotationProperty ap) {
 		if (annotationProps != null) {
 			annotationProps.remove(ap);
 		}
 	}
 	
 	public void addEquivalentClass(OdmOntologyClass oc) {
 		if (equivalentClasses == null) {
 			equivalentClasses = new Vector();			
 		}
 		equivalentClasses.add(oc);
 	}
 
 	public void removeEquivalentClass(OdmOntologyClass oc) {
 		if (equivalentClasses != null) {
 			equivalentClasses.remove(oc);
 		}
 	}
 	
 	public void addSubClass(OdmOntologyClass oc) {
 		if (subClassOf == null) {
 			subClassOf = new Vector();			
 		}
 		subClassOf.add(oc);
 	}
 
 	public void removeSubClass(OdmOntologyClass oc) {
 		if (subClassOf != null) {
 			subClassOf.remove(oc);
 		}
 	}
 	
 	public void addSuperClass(OdmOntologyClass oc) {
 		if (superClassOf == null) {
 			superClassOf = new Hashtable();			
 		}
 		superClassOf.put(oc.getId(), oc);
 	}
 
 	public void removeSuperClass(OdmOntologyClass oc) {
 		if (superClassOf != null) {
 			superClassOf.remove(oc.getId());
 		}
 	}
 	
 	public void addDisjointWithClass(OdmOntologyClass oc) {
 		if (disjointWithClasses == null) {
 			disjointWithClasses = new Vector();			
 		}
 		disjointWithClasses.add(oc);
 	}
 
 	public void removeDisjointWithClass(OdmOntologyClass oc) {
 		if (disjointWithClasses != null) {
 			disjointWithClasses.remove(oc);
 		}
 	}
 			
 	public void setOntology(OdmOntology ontology) {
 		this.ontology = ontology;
 	}
 	public void setName(String name) {
 		this.name = name;
 	}
 	
 	public void setId( String id) {
 		this.id = id;
 	}
 	
 	public void setObjectProperties(Vector properties) {
 		this.objectProperties = properties;
 	}
 	
 	public void setDatatypeProperties(Hashtable properties) {
 		this.datatypeProperties = properties;
 	}
 	
 	public void setClassExtension(Vector ce) {
 		classExtension = ce;
 	}
 	
 	public void setAnnotationProps(Vector a) {
 		annotationProps = a;
 	}
 	
 	public OdmOntology getOntology() {
 		return ontology;
 	}
 	
 	public String getName() {
 		return name;
 	}
 	
 	public String getId() {
 		return id;
 	}
 	
 	public Vector getObjectProperties() {
 		return objectProperties;
 	}
 	
 	public Hashtable getDatatypeProperties() {
 		return datatypeProperties;
 	}
 	
 	public OdmDatatypeProperty findDatatypeProperty (String propID){
 		return (OdmDatatypeProperty)datatypeProperties.get(propID);
 	}
 	
 	public Vector getClassExtension() {
 		return classExtension;
 	}
 	
 	public Vector getAnnotationProps() {
 		return annotationProps;
 	}
 	
 	public Vector getSubClassOf() {
 		return subClassOf;
 	}
 		
 	public Hashtable getSuperClassOf() {
 		return superClassOf;
 	}
 	
 	public Vector getEquivalentClasses() {
 		return equivalentClasses;
 	}
 	
 	public Vector getDisjointWithClasses() {
 		return disjointWithClasses;
 	}
 	
 }