org.omwg.ontology
Interface Ontology

All Superinterfaces:

Entity, TopEntity

public interface Ontology
extends TopEntity

This interface represents a WSMO ontology.

Version:

$Revision: 1946 $ $Date: 2007-04-02 15:13:28 +0300 (Mon, 02 Apr 2007) $

Author:

not attributable

Method Summary

void	addAxiom(Axiom axiom) Adds a new axiom to the set of axioms defined by this ontology.
void	addConcept(Concept concept) Adds a new concept to this ontology.
void	addInstance(Instance instance) Adds a new instance to the list of instances defined by this ontology.
void	addRelation(Relation relation) Adds a new relation to the list of relations defined by this ontology.
void	addRelationInstance(RelationInstance instance) Adds a new relationInstance to the list of relationInstances defined by this ontology.
Axiom	findAxiom(Identifier id) Finds an axiom in the set of axioms defined by this ontology (returns NULL if none found).
Concept	findConcept(Identifier id) Finds a concept in the set of concepts defined by this ontology (returns null if none found).
Set<Entity>	findEntity(Identifier id) Finds an object (axiom, concept, function, instance, relation, etc), returns NULL if none found.
Instance	findInstance(Identifier id) Finds an instance in the set of instances defined by this ontology (returns NULL if none found).
Relation	findRelation(Identifier id) Finds a relation in the set of relations defined by this ontology (returns NULL if none found).
RelationInstance	findRelationInstance(Identifier id) Finds a relation instance in the set of relation instances defined by this ontology (returns NULL if none found).
Set<Axiom>	listAxioms() Lists the axioms defined by this ontology.
Set<Concept>	listConcepts() Lists the concepts defined by this ontology.
Set<Instance>	listInstances() Lists the instances defined by this ontology.
Set<RelationInstance>	listRelationInstances() Lists the relationInstances defined by this ontology.
Set<Relation>	listRelations() Lists the relations defined by this ontology.
void	removeAxiom(Axiom axiom) Removes an axiom from the set of axioms defined by this ontology.
void	removeAxiom(Identifier id) Removes an axiom from the set of axioms defined by this ontology.
void	removeConcept(Concept concept) Removes a particular concept from this ontology.
void	removeConcept(Identifier id) Removes a particular concept from this ontology.
void	removeInstance(Identifier id) Removes an instance from the list of instances defined by this ontology.
void	removeInstance(Instance instance) Removes an instance from the list of instances defined by this ontology.
void	removeRelation(Identifier id) Removes a relation from the list of relations defined by this ontology.
void	removeRelation(Relation relation) Removes a relation from the list of relations defined by this ontology.
void	removeRelationInstance(Identifier id) Removes a relationInstance from the list of relationInstances defined by this ontology.
void	removeRelationInstance(RelationInstance instance) Removes a relationInstance from the list of relationInstances defined by this ontology.

Methods inherited from interface org.wsmo.common.TopEntity

addMediator, addNamespace, addOntology, findNamespace, getDefaultNamespace, getWsmlVariant, listMediators, listNamespaces, listOntologies, removeMediator, removeNamespace, removeNamespace, removeOntology, removeOntology, setDefaultNamespace, setDefaultNamespace, setWsmlVariant

Methods inherited from interface org.wsmo.common.Entity

addNFPValue, addNFPValue, getIdentifier, listNFPValues, listNFPValues, removeNFP, removeNFPValue, removeNFPValue

Method Detail

addConcept

void addConcept(Concept concept)
                throws SynchronisationException,
                       InvalidModelException

Adds a new concept to this ontology. Note that a call to addXXX() i.e. adding an element to an ontology, should also invoke the respective element's setOntology() method

Parameters:

concept - The new concept to be added.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeConcept(Concept concept), removeConcept(Identifier id), OntologyElement.setOntology(Ontology ontology)

removeConcept

void removeConcept(Concept concept)
                   throws SynchronisationException,
                          InvalidModelException

Removes a particular concept from this ontology.

Parameters:

concept - The concept to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeConcept(Identifier id)

removeConcept

void removeConcept(Identifier id)
                   throws SynchronisationException,
                          InvalidModelException

Removes a particular concept from this ontology.

Parameters:

concept - The concept to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeConcept(Concept)

listConcepts

Set<Concept> listConcepts()
                          throws SynchronisationException

Lists the concepts defined by this ontology.

Returns:

A set of concepts that this ontology contains.

Throws:

SynchronisationException

See Also:

Concept

findConcept

Concept findConcept(Identifier id)
                    throws SynchronisationException

Finds a concept in the set of concepts defined by this ontology (returns null if none found).

Parameters:

id - The Identifier of the requested concept.

Throws:

SynchronisationException

addRelation

void addRelation(Relation relation)
                 throws SynchronisationException,
                        InvalidModelException

Adds a new relation to the list of relations defined by this ontology. Note that a call to addXXX() i.e. adding an element to an ontology, should also invoke the respective element's setOntology() method

Parameters:

relation - The relatino ot be added.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeRelation(Relation relation), removeRelation(Identifier id), OntologyElement.setOntology(Ontology ontology)

removeRelation

void removeRelation(Relation relation)
                    throws SynchronisationException,
                           InvalidModelException

Removes a relation from the list of relations defined by this ontology.

Parameters:

relation - The relation to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeRelation(Identifier id)

removeRelation

void removeRelation(Identifier id)
                    throws SynchronisationException,
                           InvalidModelException

Removes a relation from the list of relations defined by this ontology.

Parameters:

relation - The relation to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeRelation(Relation)

listRelations

Set<Relation> listRelations()
                            throws SynchronisationException

Lists the relations defined by this ontology.

Returns:

A set of relations defined in this ontology.

Throws:

SynchronisationException

See Also:

Relation

findRelation

Relation findRelation(Identifier id)
                      throws SynchronisationException

Finds a relation in the set of relations defined by this ontology (returns NULL if none found).

Parameters:

id - The Identifier of the requested relation.

Throws:

SynchronisationException

addInstance

void addInstance(Instance instance)
                 throws SynchronisationException,
                        InvalidModelException

Adds a new instance to the list of instances defined by this ontology. Note that a call to addXXX() i.e. adding an element to an ontology, should also invoke the respective element's setOntology() method

Parameters:

instance - The new instance to be added.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeInstance(Instance instance), removeInstance(Identifier id), OntologyElement.setOntology(Ontology ontology)

removeInstance

void removeInstance(Instance instance)
                    throws SynchronisationException,
                           InvalidModelException

Removes an instance from the list of instances defined by this ontology.

Parameters:

instance - The instance to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeInstance(Identifier id)

removeInstance

void removeInstance(Identifier id)
                    throws SynchronisationException,
                           InvalidModelException

Removes an instance from the list of instances defined by this ontology.

Parameters:

instance - The instance to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeInstance(Instance)

listInstances

Set<Instance> listInstances()
                            throws SynchronisationException

Lists the instances defined by this ontology.

Returns:

The list of instances defined by this ontology.

Throws:

SynchronisationException

See Also:

Instance

findInstance

Instance findInstance(Identifier id)
                      throws SynchronisationException

Finds an instance in the set of instances defined by this ontology (returns NULL if none found).

Parameters:

id - The Identifier of the requested instance.

Throws:

SynchronisationException

addAxiom

void addAxiom(Axiom axiom)
              throws SynchronisationException,
                     InvalidModelException

Adds a new axiom to the set of axioms defined by this ontology. Note that a call to addXXX() i.e. adding an element to an ontology, should also invoke the respective element's setOntology() method

Parameters:

axiom - The new axioms to be added.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeAxiom(Axiom axiom), removeAxiom(Identifier id), OntologyElement.setOntology(Ontology ontology)

removeAxiom

void removeAxiom(Axiom axiom)
                 throws SynchronisationException,
                        InvalidModelException

Removes an axiom from the set of axioms defined by this ontology.

Parameters:

axiom - The axiom to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeAxiom(Identifier id)

removeAxiom

void removeAxiom(Identifier id)
                 throws SynchronisationException,
                        InvalidModelException

Removes an axiom from the set of axioms defined by this ontology.

Parameters:

id - The ID of the axiom to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeAxiom(Axiom axiom)

listAxioms

Set<Axiom> listAxioms()
                      throws SynchronisationException

Lists the axioms defined by this ontology.

Returns:

The set of axioms defined by this ontology.

Throws:

SynchronisationException

See Also:

Axiom

findAxiom

Axiom findAxiom(Identifier id)
                throws SynchronisationException

Finds an axiom in the set of axioms defined by this ontology (returns NULL if none found).

Parameters:

id - The Identifier of the requested axiom.

Throws:

SynchronisationException

listRelationInstances

Set<RelationInstance> listRelationInstances()
                                            throws SynchronisationException

Lists the relationInstances defined by this ontology.

Returns:

The list of relationInstances defined by this ontology.

Throws:

SynchronisationException

See Also:

RelationInstance

addRelationInstance

void addRelationInstance(RelationInstance instance)
                         throws SynchronisationException,
                                InvalidModelException

Adds a new relationInstance to the list of relationInstances defined by this ontology. Note that a call to addXXX() i.e. adding an element to an ontology, should also invoke the respective element's setOntology() method

Parameters:

instance - The new relationInstance to be added.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeRelationInstance(RelationInstance instance), removeRelationInstance(Identifier id), OntologyElement.setOntology(Ontology ontology)

removeRelationInstance

void removeRelationInstance(RelationInstance instance)
                            throws SynchronisationException,
                                   InvalidModelException

Removes a relationInstance from the list of relationInstances defined by this ontology.

Parameters:

instance - The relationInstance to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeRelationInstance(Identifier id)

removeRelationInstance

void removeRelationInstance(Identifier id)
                            throws SynchronisationException,
                                   InvalidModelException

Removes a relationInstance from the list of relationInstances defined by this ontology.

Parameters:

id - The ID of the relationInstance to be removed.

Throws:

SynchronisationException

InvalidModelException

See Also:

removeRelationInstance(RelationInstance instance)

findRelationInstance

RelationInstance findRelationInstance(Identifier id)
                                      throws SynchronisationException

Finds a relation instance in the set of relation instances defined by this ontology (returns NULL if none found).

Parameters:

id - The Identifier of the requested relation instance.

Throws:

SynchronisationException

findEntity

Set<Entity> findEntity(Identifier id)
                       throws SynchronisationException

Finds an object (axiom, concept, function, instance, relation, etc), returns NULL if none found. Note that if metamodelling is used (e.g. the WSMl variant is more powerful than WSML-Core) then more than one entity may correspond to a given ID.

Parameters:

id - The Identifier of the requested object.

Throws:

SynchronisationException

See Also:

Entity