View Javadoc

1   /*
2    wsmo4j - a WSMO API and Reference Implementation
3   
4    Copyright (c) 2004-2005, OntoText Lab. / SIRMA
5   
6    This library is free software; you can redistribute it and/or modify it under
7    the terms of the GNU Lesser General Public License as published by the Free
8    Software Foundation; either version 2.1 of the License, or (at your option)
9    any later version.
10   This library is distributed in the hope that it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12   FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13   details.
14   You should have received a copy of the GNU Lesser General Public License along
15   with this library; if not, write to the Free Software Foundation, Inc.,
16   59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17   */
18  
19  /**
20   * <p>Title: WSMO4J</p>
21   * <p>Description: WSMO API and a Reference Implementation</p>
22   * <p>Copyright:  Copyright (c) 2004-2005</p>
23   * <p>Company: OntoText Lab. / SIRMA </p>
24   */
25  
26  package org.omwg.ontology;
27  
28  
29  import org.wsmo.common.*;
30  import org.wsmo.common.exception.*;
31  
32  /**
33   * this is a helper super-interface for ontology elements:
34   *    - axioms
35   *    - concepts
36   *    - instances
37   *    - relations
38   *    - relation instances
39   *
40   * @see Ontology
41   * @author not attributable
42   * @version $Revision: 1482 $ $Date: 2006-01-16 15:37:08 +0200 (Mon, 16 Jan 2006) $
43   */
44  
45  public interface OntologyElement
46      extends Entity {
47  
48      /**
49       * Retrieve the ontology containing this entity.
50       * @throws org.wsmo.common.exception.SynchronisationException
51       */
52      Ontology getOntology()
53          throws SynchronisationException;
54  
55      /**
56       * Sets the ontology containing this entity
57       * Note that a call to setOntology() i.e. adding an element to an ontology, should also
58       * invoke the respective Ontology::addXXX() method and Ontology::removeXXX() method
59       * (of the old ontology if existing).
60       * @param ontology the ontology
61       * @throws org.wsmo.common.exception.SynchronisationException
62       * @throws org.wsmo.common.exception.InvalidModelException
63       * @see #getOntology()
64       * @see Ontology#addAxiom(Axiom axiom)
65       * @see Ontology#addConcept(Concept concept)
66       * @see Ontology#addInstance(Instance instance)
67       * @see Ontology#addRelation(Relation relation)
68       * @see Ontology#addRelationInstance(RelationInstance instance)
69       */
70      void setOntology(Ontology ontology)
71          throws SynchronisationException, InvalidModelException;
72  }
73  
74  /*
75   * $Log$
76   * Revision 1.2  2006/01/16 13:37:08  vassil_momtchev
77   * javadoc fixed
78   *
79   * Revision 1.1  2005/06/01 10:13:58  marin_dimitrov
80   * v0.4.0
81   *
82   * Revision 1.5  2005/05/13 15:38:26  marin
83   * fixed javadoc errors
84   *
85   * Revision 1.4  2005/05/13 13:29:57  marin
86   * javadoc, header, footer, etc
87   *
88   */