kaos.core.csi.query
Interface QueryKAoSOntologyService

All Known Subinterfaces:
OntologyRepositoryService

public interface QueryKAoSOntologyService

Defines the operations querying a ontology repository about Actors Actions and Entities.

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

Method Summary
 ActionClassDescription getActionDesc(java.lang.String actionClassName)
          Get descriptions of the Action classes
 java.util.Set<java.lang.String> getActionsActorCanPerform(java.lang.String forActor)
           
 java.util.Set<ActionClassDescription> getActionsDescActorCanPerform(java.lang.String forActor)
          Get descriptions of the Action classes the specified Actor class or instance can perform based on its class.
 java.util.Set<java.lang.String> getClassesOfActors(java.lang.String baseActorClass)
          Get names of the Actors classes known to the ontology repository being a subclass of the specified base class.
 java.util.Set<java.lang.String> getClassesOfGroups(java.lang.String baseGroupClass)
          Get names of the Group classes known to the ontology repository being a subclass of the specified base class.
 java.util.Set<java.lang.String> getClassesOfPlaces(java.lang.String basePlaceClass)
          Get names of the Places classes known to the ontology repository being a subclass of the specified base class.
 java.util.Set<java.lang.String> getClassesOfResources(java.lang.String baseResourceClass)
          Get names of the resources (Actors or Entities) classes known to the ontology repository being a subclass of the specified base class.
 java.util.Set<java.lang.String> getIndividualActors(java.lang.String baseActorClass)
          Get names of the individual Actors known to the ontology repository being an instance of the specified base class.
 java.util.Set<java.lang.String> getIndividualGroups(java.lang.String baseGroupClass)
          Get names of the individual Groups known to the ontology repository being an instance of the specified base class.
 java.util.Set<java.lang.String> getIndividualPlaces(java.lang.String basePlaceClass)
          Get names of the individual Places known to the ontology repository being an instance of the specified base class.
 java.util.Set<java.lang.String> getIndividualResources(java.lang.String baseResourceClass)
          Get names of the individual resources (Actors or Entities) known to the ontology repository being an instance of the specified base class.
 

Method Detail

getIndividualActors

java.util.Set<java.lang.String> getIndividualActors(java.lang.String baseActorClass)
                                                    throws QueryState.UnknownConceptException,
                                                           DirectoryFailure
Get names of the individual Actors known to the ontology repository being an instance of the specified base class.

Parameters:
baseActorClass - The name of the Actor class which the return elements have to be an instance of If the name is empty uses Actor as a base class
Returns:
Set of names of individual Actors
Throws:
QueryState.UnknownConceptException - if baseActorClass is unknown for the ontology repository
DirectoryFailure

getClassesOfActors

java.util.Set<java.lang.String> getClassesOfActors(java.lang.String baseActorClass)
                                                   throws QueryState.UnknownConceptException,
                                                          DirectoryFailure
Get names of the Actors classes known to the ontology repository being a subclass of the specified base class.

Parameters:
baseActorClass - The name of the Actor class which the return classes have to be a subclass of If the name is empty uses Actor as a base class
Returns:
Set of names of Actor subclasses
Throws:
QueryState.UnknownConceptException - if baseActorClass is unknown for the ontology repository
DirectoryFailure

getIndividualPlaces

java.util.Set<java.lang.String> getIndividualPlaces(java.lang.String basePlaceClass)
                                                    throws QueryState.UnknownConceptException,
                                                           DirectoryFailure
Get names of the individual Places known to the ontology repository being an instance of the specified base class.

Parameters:
basePlaceClass - The name of the Place class which the return elements have to be an instance of If the name is empty uses Place as a base class
Returns:
Set of names of individual Places
Throws:
QueryState.UnknownConceptException - if basePlaceClass is unknown for the ontology repository
DirectoryFailure

getClassesOfPlaces

java.util.Set<java.lang.String> getClassesOfPlaces(java.lang.String basePlaceClass)
                                                   throws QueryState.UnknownConceptException,
                                                          DirectoryFailure
Get names of the Places classes known to the ontology repository being a subclass of the specified base class.

Parameters:
basePlaceClass - The name of the Place class which the return classes have to be a subclass of If the name is empty uses Place as a base class
Returns:
Set of names of Place subclasses
Throws:
QueryState.UnknownConceptException - if basePlaceClass is unknow for the ontology repository
DirectoryFailure

getIndividualGroups

java.util.Set<java.lang.String> getIndividualGroups(java.lang.String baseGroupClass)
                                                    throws QueryState.UnknownConceptException,
                                                           DirectoryFailure
Get names of the individual Groups known to the ontology repository being an instance of the specified base class.

Parameters:
baseGroupClass - The name of the Group class which the return elements have to be an instance of If the name is empty uses Group as a base class
Returns:
Set of names of individual Groups
Throws:
QueryState.UnknownConceptException - if baseGroupClass is unknown for the ontology repository
DirectoryFailure

getClassesOfGroups

java.util.Set<java.lang.String> getClassesOfGroups(java.lang.String baseGroupClass)
                                                   throws QueryState.UnknownConceptException,
                                                          DirectoryFailure
Get names of the Group classes known to the ontology repository being a subclass of the specified base class.

Parameters:
baseGroupClass - The name of the Group class which the return elements have to be an instance of If the name is empty uses Group as a base class
Returns:
Set of names of individual Groups
Throws:
QueryState.UnknownConceptException - if baseGroupClass is unknown for the ontology repository
DirectoryFailure

getIndividualResources

java.util.Set<java.lang.String> getIndividualResources(java.lang.String baseResourceClass)
                                                       throws QueryState.UnknownConceptException,
                                                              DirectoryFailure
Get names of the individual resources (Actors or Entities) known to the ontology repository being an instance of the specified base class.

Parameters:
baseResourceClass - The name of the resources (Actor or Entity) class which the return classes have to be a subclass of
Returns:
Set of names of individual targets (Actors or Entities)
Throws:
QueryState.UnknownConceptException - if baseResourceClass is unknown for the ontology repository
DirectoryFailure

getClassesOfResources

java.util.Set<java.lang.String> getClassesOfResources(java.lang.String baseResourceClass)
                                                      throws QueryState.UnknownConceptException,
                                                             DirectoryFailure
Get names of the resources (Actors or Entities) classes known to the ontology repository being a subclass of the specified base class.

Parameters:
baseResourceClass - The name of the resource (Actor or Entity) class which the return classes have to be a subclass of
Returns:
Set of names of resource (Actors or Entities) subclasses
Throws:
QueryState.UnknownConceptException - if baseResourceClass is unknown for the ontology repository
DirectoryFailure

getActionDesc

ActionClassDescription getActionDesc(java.lang.String actionClassName)
                                     throws QueryState.UnknownConceptException,
                                            DirectoryFailure
Get descriptions of the Action classes

Parameters:
actionClassName - The name of the Action class
Returns:
ActionClassDescription
Throws:
QueryState.UnknownConceptException - if forActor is unknown for the ontology repository
DirectoryFailure

getActionsActorCanPerform

java.util.Set<java.lang.String> getActionsActorCanPerform(java.lang.String forActor)
                                                          throws QueryState.UnknownConceptException,
                                                                 DirectoryFailure
Throws:
QueryState.UnknownConceptException
DirectoryFailure

getActionsDescActorCanPerform

java.util.Set<ActionClassDescription> getActionsDescActorCanPerform(java.lang.String forActor)
                                                                    throws QueryState.UnknownConceptException,
                                                                           DirectoryFailure
Get descriptions of the Action classes the specified Actor class or instance can perform based on its class.

Parameters:
forActor - The name of the Actor class or instance
Returns:
Set of ActionClassDescription
Throws:
QueryState.UnknownConceptException - if forActor is unknown for the ontology repository
DirectoryFailure


Copyright © 2006 IHMC All Rights Reserved.