kaos.core.csi.ontology
Interface OntologyService

All Superinterfaces:
QueryState
All Known Subinterfaces:
OntologyRepositoryService

public interface OntologyService
extends QueryState

Defines the operations allowing to load ontology into the repository, methods allowing to modify instance types and values of properties. Additional it has methods allowing to configures filtering out values from specific namespaces from the set of values returned by its methods. Adds methods allowing to query the ontology. The queries do not depend on any specific ontology.

Version:
1.0 $Revision: 1.22 $
Author:
KAoS Team

Nested Class Summary
static class OntologyService.ReasoningException
           
 
Nested classes/interfaces inherited from interface kaos.core.csi.query.QueryState
QueryState.UnknownConceptException, QueryState.UnknownNamespaceException
 
Method Summary
 void addFilteredNamespace(java.lang.String namespace)
          This method add a namespace to the set of urls depicting ontology namespaces concept of which are filtered out when returned by methods of this repository.
 void addOntologicalTypeToEntity(java.lang.String entityName, java.lang.String typeName, java.lang.String typeDesc)
          Add new type to the entity
 void addPropertyToEntity(java.lang.String entityName, java.lang.String propertyName, java.lang.String propertyValue, java.lang.String propertyValueDesc)
          Add a property value to an entity
 java.util.Set<java.lang.String> getFilteredNamespaces()
          This method returns a set of urls depicting ontology namespaces concept of which are filtered out when returned by methods of this repository.
 void loadOntology(java.lang.String loadedOWL)
          Loads ontology in OWL into the repository of the Ontology Service
 java.util.Set<java.lang.String> loadOntology(java.lang.String myURL, boolean recursiveLoad)
          Loads ontology in OWL from given URL into the repository of the Ontology Service
 void modifyEntityProperties(java.lang.String entityGUID, java.util.List<Property> properties)
          Modify properties of the specified entity
 void removeFilteredNamespace(java.lang.String namespace)
          This method remove a namespace from the set of urls depicting ontology namespaces concept of which are filtered out when returned by methods of this repository.
 void removeOntologicalTypeFromEntity(java.lang.String entityName, java.lang.String typeName)
          Remove a type from the entity
 void removePropertyFromEntity(java.lang.String entityName, java.lang.String propertyName, java.lang.String propertyValue)
          Remove a property value from an entity
 
Methods inherited from interface kaos.core.csi.query.QueryState
areClassesDisjoint, askQuery, getAllNamespaces, getClassDesc, getClassesDefInNamespace, getImmediateSubClassesOf, getIndividualDesc, getInstancesDefInNamespace, getInstancesOf, getListOfLoadedOntologies, getNamspacesImportedByNamespace, getOntologyDefinitionForConcept, getOntologyTypesOfIndividual, getPropertiesApplicableTo, getPropertiesDefInNamespace, getRangeOnPropertyForClass, getResourcesWithValueForProperty, getSubClassesOf, getSubPropertiesOf, getSuperClassesOf, getSuperPropertiesOf, getUniqueValueForProperty, getValuesForProperty, testTrue
 

Method Detail

loadOntology

void loadOntology(java.lang.String loadedOWL)
                  throws OntologyService.ReasoningException,
                         DirectoryFailure
Loads ontology in OWL into the repository of the Ontology Service

Parameters:
loadedOWL - string containing a syntactically correctly OWL
Throws:
OntologyService.ReasoningException - when loading of the ontology failed.
DirectoryFailure

loadOntology

java.util.Set<java.lang.String> loadOntology(java.lang.String myURL,
                                             boolean recursiveLoad)
                                             throws OntologyService.ReasoningException,
                                                    java.io.IOException,
                                                    DirectoryFailure
Loads ontology in OWL from given URL into the repository of the Ontology Service

Parameters:
myURL - string containing a syntactically correct URI to an OWL source
recursiveLoad - whether to load the OWL imported by the given URI
Returns:
Returns a set to of namespaces loaded during this step
Throws:
OntologyService.ReasoningException - when loading of the ontology failed.
java.io.IOException
DirectoryFailure

addOntologicalTypeToEntity

void addOntologicalTypeToEntity(java.lang.String entityName,
                                java.lang.String typeName,
                                java.lang.String typeDesc)
                                throws OntologyService.ReasoningException,
                                       QueryState.UnknownConceptException,
                                       DirectoryFailure
Add new type to the entity

Parameters:
entityName - - the uri of the entity
typeName - - the type name
typeDesc - - optional ontology description of the type
Throws:
OntologyService.ReasoningException
QueryState.UnknownConceptException
DirectoryFailure

removeOntologicalTypeFromEntity

void removeOntologicalTypeFromEntity(java.lang.String entityName,
                                     java.lang.String typeName)
                                     throws OntologyService.ReasoningException,
                                            QueryState.UnknownConceptException,
                                            DirectoryFailure
Remove a type from the entity

Parameters:
entityName - - the uri of the entity
typeName - - the type name
Throws:
OntologyService.ReasoningException
DirectoryFailure
QueryState.UnknownConceptException

addPropertyToEntity

void addPropertyToEntity(java.lang.String entityName,
                         java.lang.String propertyName,
                         java.lang.String propertyValue,
                         java.lang.String propertyValueDesc)
                         throws OntologyService.ReasoningException,
                                QueryState.UnknownConceptException,
                                DirectoryFailure
Add a property value to an entity

Parameters:
entityName - - the uri of the entity
propertyName - - the name of the property
propertyValue - - the value of the property
propertyValueDesc - - optional ontology description of the property value
Throws:
OntologyService.ReasoningException
QueryState.UnknownConceptException
DirectoryFailure

removePropertyFromEntity

void removePropertyFromEntity(java.lang.String entityName,
                              java.lang.String propertyName,
                              java.lang.String propertyValue)
                              throws OntologyService.ReasoningException,
                                     QueryState.UnknownConceptException,
                                     DirectoryFailure
Remove a property value from an entity

Parameters:
entityName - - the uri of the entity
propertyName - - the name of the property
propertyValue - - the value of the property
Throws:
OntologyService.ReasoningException
QueryState.UnknownConceptException
DirectoryFailure

modifyEntityProperties

void modifyEntityProperties(java.lang.String entityGUID,
                            java.util.List<Property> properties)
                            throws DirectoryFailure,
                                   NotRegisteredException,
                                   kaos.core.service.directory.ModificationException
Modify properties of the specified entity

Parameters:
entityGUID - - the uri of the entity
properties - - list of properties with new values
Throws:
DirectoryFailure, - NotRegisteredException, ModificationException
DirectoryFailure
NotRegisteredException
kaos.core.service.directory.ModificationException

getFilteredNamespaces

java.util.Set<java.lang.String> getFilteredNamespaces()
                                                      throws DirectoryFailure
This method returns a set of urls depicting ontology namespaces concept of which are filtered out when returned by methods of this repository.

Throws:
DirectoryFailure

addFilteredNamespace

void addFilteredNamespace(java.lang.String namespace)
                          throws DirectoryFailure
This method add a namespace to the set of urls depicting ontology namespaces concept of which are filtered out when returned by methods of this repository.

Parameters:
namespace - The name of the namespace
Throws:
DirectoryFailure

removeFilteredNamespace

void removeFilteredNamespace(java.lang.String namespace)
                             throws DirectoryFailure
This method remove a namespace from the set of urls depicting ontology namespaces concept of which are filtered out when returned by methods of this repository.

Parameters:
namespace - The name of the namespace
Throws:
DirectoryFailure


Copyright © 2006 IHMC All Rights Reserved.