casa.ontology

Interface Ontology

All Known Implementing Classes:

CASAOntology, OWLOntology

public interface Ontology

Field Summary

Fields

Modifier and Type	Field and Description
static CasaLispOperator	ONT__ASSERT
static CasaLispOperator	ONT__DESCRIBE
static CasaLispOperator	ONT__GET
static CasaLispOperator	ONT__GET_RESIDENT
static CasaLispOperator	ONT__IMPORT
static CasaLispOperator	ONT__INDIVIDUAL
static CasaLispOperator	ONT__IS_INDIVIDUAL
static CasaLispOperator	ONT__IS_OBJECT
static CasaLispOperator	ONT__IS_TYPE
static CasaLispOperator	ONT__RELATED_TO
static CasaLispOperator	ONT__RELATION Lisp operator: (DEFTBOXREL name {keys {rel}}*)
static CasaLispOperator	ONT__SET_DEFAULT
static CasaLispOperator	ONT__TYPE
static CasaLispOperator	ONTOLOGY

Method Summary

Modifier and Type	Method and Description
int	add(String description) Equivalent to add(new TypeHierarchy(description)).
void	addIndividual(String name, String... parents)
void	addIndividual(String name, String parent)
void	addSuperOntologies(Ontology... parentOntologies)
void	addSuperOntologies(String... parentOntologies)
void	addType(String name, String... parents) Adds name to the hierarchy with super-type links to each of the nodes in parents.
void	addType(String name, String parent) Equivalent to add(name,new String[]{parent}).
void	declMaplet(String relationName, String domainName, String rangeName)
void	declRelation(String name, String basedOn, Set<Relation.Property> properties, Constraint domConstraint, Constraint ranConstraint, Object... otherParams)
String	describe(String name) Print to the return String the complete path (in persistent form) from the root node to the node named name.
String	describeIndividual(String type)
String	describeRelation(String relation)
String	describeType(String type)
Status	extendWith(String spec) Add the persistent Ontology data in spec to this Ontology.
String	getDefaultFileExtension()
String	getName()
boolean	instanceOf(String child, String parent)
Set<String>	isa(String child) Finals all ancestors of child.
boolean	isa(String child, String parent) Determines if parent is an ancestor of child.
Set<String>	isAncestor(String child)
Set<String>	isChild(String parent)
boolean	isCompatable(Ontology other) Determines if other is a compatible description (see #describe(TypeNode)) to this TypeHierarchy.
void	isCompatableThrow(Ontology other) Determines if other is a compatible description (see #describe(TypeNode)) to this TypeHierarchy.
Set<String>	isDescendant(String parent)
boolean	isIndividual(String name) Returns true if the agent "knows" about the token string in the parameter and it's an individual.
boolean	isObject(String name) Returns true if the agent "knows" about the token string in the parameter: it's either a type or an individual.
Set<String>	isParent(String child) Finals all parents (direct ancestors) of child.
boolean	isRelation(String name) Returns true if the agent "knows" about the token string in the parameter and it's an relation.
boolean	isType(String name) Returns true if the agent "knows" about the token string in the parameter and it's a type.
Set<String>	relatedTo(String relation, String domain)
boolean	relatedTo(String relation, String domain, String range) Determines if an element is related to another element by the relation.
String	toString() Create a string containing the persistent representation of this object.

Field Detail

ONTOLOGY

static final CasaLispOperator ONTOLOGY

ONT__IS_OBJECT

static final CasaLispOperator ONT__IS_OBJECT

ONT__IS_TYPE

static final CasaLispOperator ONT__IS_TYPE

ONT__IS_INDIVIDUAL

static final CasaLispOperator ONT__IS_INDIVIDUAL

ONT__GET_RESIDENT

static final CasaLispOperator ONT__GET_RESIDENT

ONT__SET_DEFAULT

static final CasaLispOperator ONT__SET_DEFAULT

ONT__GET

static final CasaLispOperator ONT__GET

ONT__DESCRIBE

static final CasaLispOperator ONT__DESCRIBE

ONT__RELATED_TO

static final CasaLispOperator ONT__RELATED_TO

ONT__ASSERT

static final CasaLispOperator ONT__ASSERT

ONT__INDIVIDUAL

static final CasaLispOperator ONT__INDIVIDUAL

ONT__TYPE

static final CasaLispOperator ONT__TYPE

ONT__IMPORT

static final CasaLispOperator ONT__IMPORT

ONT__RELATION

static final CasaLispOperator ONT__RELATION

Lisp operator: (DEFTBOXREL name {keys {rel}}*)

 The function's lambda list is:
  (RELATION-NAME &KEY BASE INVERSE REFLEXIVE SYMMETRIC TRANSITIVE
   ASSIGNABLE)
 Function documentation:
  Define a relation in the agent's casa ontology.
  Lambda List:  RELATION-NAME  &KEY BASE  INVERSE  REFLEXIVE  SYMMETRIC  TRANSITIVE  ASSIGNABLE 
    RELATION-NAME   The name of the relation.
    :BASE           The relation on which this is based.
    :INVERSE        This relation is to be an inverse relation (x->y => y->x) of the base relation.
    :REFLEXIVE      This relation is a reflexive (x->x) version of the base relation.
    :SYMMETRIC      This relation is a symmetric (x->y => y->x) version of the base relation.
    :TRANSITIVE     This relation is a transitive (x->y & y->z => x->y) version of the base relation.
    :ASSIGNABLE     This relation is assignable (that is one can use it as first argument in a (declMaplet ...) operator
 

Method Detail

getDefaultFileExtension

String getDefaultFileExtension()

addType

void addType(String name,
             String... parents)
      throws ParentNodeNotFoundException,
             DuplicateNodeException,
             IllegalOperationException

Adds name to the hierarchy with super-type links to each of the nodes in parents. Each member of parents must already exist in the hierarchy.

Parameters:

name - the name of new type

parents - the super-types of name. Each member of parents must already exist in the hierarchy.

Throws:

ParentNodeNotFoundException - if any of the members of parents isn't in the hierarchy.

IllegalOperationException

DuplicateNode - if name already exists in the hierarchy

DuplicateNodeException

addType

void addType(String name,
             String parent)
      throws ParentNodeNotFoundException,
             DuplicateNodeException,
             IllegalOperationException

Equivalent to add(name,new String[]{parent}). Use for types that only have a single super-type.

Parameters:

name - the name of new type

parent - the super-type of name.

Throws:

ParentNodeNotFoundException - if parent isn't in the hierarchy.

IllegalOperationException

DuplicateNode - if name already exists in the hierarchy

DuplicateNodeException

add

int add(String description)
 throws DuplicateNodeException,
        IncompatableTypeHierarchiesException,
        ParentNodeNotFoundException,
        ParseException

Equivalent to add(new TypeHierarchy(description)).

Parameters:

description -

Returns:

the number of types added to the hierarchy

Throws:

DuplicateNode

IncompatableTypeHierarchiesException

ParentNodeNotFoundException

ParseException

DuplicateNodeException

relatedTo

boolean relatedTo(String relation,
                  String domain,
                  String range)
           throws UnsupportedOperationException,
                  IllegalOperationException

Determines if an element is related to another element by the relation. In terms of description logics, whether domain has a role of type range.

Parameters:

domain - the thing that is a the "source" of the relation

range - the thing that is the "destination" of the relation

Returns:

true iff domain is related to range

Throws:

UnsupportedOperationException

IllegalOperationException

isa

boolean isa(String child,
            String parent)
     throws IllegalOperationException

Determines if parent is an ancestor of child. This should be equivalent to relatedTo("isa",child,parent) if relatedTo() is supported.

Parameters:

child - the name if a node in the TypeHierarchy

parent - the name of a node in the TypeHierarchy

Returns:

true iff parent is an ancestor of child

Throws:

IllegalOperationException

isa

Set<String> isa(String child)
         throws IllegalOperationException

Finals all ancestors of child. This should be equivalent to relatedTo("isa",child) if relatedTo() is supported.

Parameters:

child - the name if a node in the TypeHierarchy

Returns:

all ancestors of child

Throws:

IllegalOperationException

isParent

Set<String> isParent(String child)
              throws IllegalOperationException

Finals all parents (direct ancestors) of child. This should be equivalent to relatedTo("isa-parent",child) if relatedTo() is supported.

Parameters:

child - the name if a node in the TypeHierarchy

Returns:

all parents (direct ancestors) of child

Throws:

IllegalOperationException

toString

String toString()

Create a string containing the persistent representation of this object. See the introduction to this entry for the details of the format.

Overrides:

toString in class Object

Returns:

a string containing the persistent representation of this TypeHierarchy

isObject

boolean isObject(String name)
          throws IllegalOperationException

Returns true if the agent "knows" about the token string in the parameter: it's either a type or an individual.

Parameters:

name - the name of a node in the TypeHiearchy

Returns:

true iff the node is in the TypeHiearchy as either a type or an individual.

Throws:

IllegalOperationException - if the qualified syntax explicitly specifies a dictionary that is not the owner.

isType

boolean isType(String name)
        throws IllegalOperationException

Returns true if the agent "knows" about the token string in the parameter and it's a type.

Parameters:

name - the name of a node in the TypeHiearchy

Returns:

true iff the node is in the TypeHiearchy and it is a type.

Throws:

IllegalOperationException - if the qualified syntax explicitly specifies a dictionary that is not the owner.

isIndividual

boolean isIndividual(String name)
              throws IllegalOperationException

Returns true if the agent "knows" about the token string in the parameter and it's an individual.

Parameters:

name - the name of a node in the TypeHiearchy

Returns:

true iff the node is in the TypeHiearchy and it is an individual.

Throws:

IllegalOperationException - if the qualified syntax explicitly specifies a dictionary that is not the owner.

isRelation

boolean isRelation(String name)
            throws IllegalOperationException

Returns true if the agent "knows" about the token string in the parameter and it's an relation.

Parameters:

name - the name of the relation

Returns:

true iff the node is a relation in the ontology.

Throws:

IllegalOperationException - if the qualified syntax explicitly specifies a dictionary that is not the owner.

describe

String describe(String name)
         throws IllegalOperationException

Print to the return String the complete path (in persistent form) from the root node to the node named name. Every possible branch is (multiple inheritance) is included, and no nodes are included more than once.

Parameters:

name - the name of a node in the TypeHiearchy

Returns:

the complete path (in persistent form) from the root node to the node named name, or null if name isn't the name of a node in the TypeHiearchy.

Throws:

IllegalOperationException - TODO

isCompatable

boolean isCompatable(Ontology other)

Determines if other is a compatible description (see #describe(TypeNode)) to this TypeHierarchy. Node A is compatible with node B iff all nodes in A that have matched names in B are exactly the same as the corresponding node in B (that is, they have the same name, and each of the parents [recursively] are exactly the same). forall i:Node | i member B . exists j:Node | j member A . i.name = j.name

Parameters:

other - the TypeHierarchy ot compare to this one for compatability

Returns:

true iff other is compatable

isCompatableThrow

void isCompatableThrow(Ontology other)
                throws IncompatableTypeHierarchiesException

Determines if other is a compatible description (see #describe(TypeNode)) to this TypeHierarchy. Node A is compatible with node B iff all nodes in A that have matched names in B are exactly the same as the corresponding node in B (that is, they have the same name, and each of the parents [recursively] are exactly the same). forall i:Node | i member B . exists j:Node | j member A . i.name = j.name
Use this method instead of isCompatable() to get more detailed information (in the Exception thrown) about what the error was.

Parameters:

other - the TypeHierarchy ot compare to this one for compatability

Throws:

IncompatableTypeHierarchiesException - iff other is incompatable

extendWith

Status extendWith(String spec)

Add the persistent Ontology data in spec to this Ontology.

Parameters:

spec - A String containing the persistent for of an Ontology

Returns:

a Status object indicating:

• 0: success
• -1: Attempted insertion of duplicate type node name into performatives type hierarchy
• -2: Malformed content field: Parent node not found in performatives type hierarchy
• -3: Malformed content field: Parse exception
• -4: Type information is incompatible with existing performatives hierarchy
• -5: Input spec contains duplicate type node name

addSuperOntologies

void addSuperOntologies(Ontology... parentOntologies)
                 throws IllegalOperationException

Throws:

IllegalOperationException

addSuperOntologies

void addSuperOntologies(String... parentOntologies)
                 throws IllegalOperationException

Throws:

IllegalOperationException

getName

String getName()

addIndividual

void addIndividual(String name,
                   String parent)
            throws ParentNodeNotFoundException,
                   DuplicateNodeException,
                   IllegalOperationException

Throws:

ParentNodeNotFoundException

DuplicateNodeException

IllegalOperationException

addIndividual

void addIndividual(String name,
                   String... parents)
            throws ParentNodeNotFoundException,
                   DuplicateNodeException,
                   IllegalOperationException

Throws:

ParentNodeNotFoundException

DuplicateNodeException

IllegalOperationException

instanceOf

boolean instanceOf(String child,
                   String parent)
            throws IllegalOperationException

Throws:

IllegalOperationException

describeRelation

String describeRelation(String relation)
                 throws IllegalOperationException

Throws:

IllegalOperationException

describeType

String describeType(String type)
             throws IllegalOperationException

Throws:

IllegalOperationException

describeIndividual

String describeIndividual(String type)
                   throws IllegalOperationException

Throws:

IllegalOperationException

declMaplet

void declMaplet(String relationName,
                String domainName,
                String rangeName)
         throws IllegalOperationException

Throws:

IllegalOperationException

declRelation

void declRelation(String name,
                  String basedOn,
                  Set<Relation.Property> properties,
                  Constraint domConstraint,
                  Constraint ranConstraint,
                  Object... otherParams)
           throws IllegalOperationException

Throws:

IllegalOperationException

relatedTo

Set<String> relatedTo(String relation,
                      String domain)
               throws UnsupportedOperationException,
                      IllegalOperationException

Throws:

UnsupportedOperationException

IllegalOperationException

isAncestor

Set<String> isAncestor(String child)
                throws IllegalOperationException

Throws:

IllegalOperationException

isChild

Set<String> isChild(String parent)
             throws IllegalOperationException

Throws:

IllegalOperationException

isDescendant

Set<String> isDescendant(String parent)
                  throws IllegalOperationException

Throws:

IllegalOperationException