casa.ontology.v3

Class CASAOntology

java.lang.Object

casa.ontology.v3.CASAOntology

All Implemented Interfaces:

Ontology

public class CASAOntology
extends Object
implements Ontology

Implements an efficient ontology of terms and relations. A primary feature of this ontology is its ability to define relations based on other relations and maintain the integrity of the relationships between these relations. It's persistent form consists of lisp-like sentences of the following form:

 
 (declRelation rel) 
 (declRelation rel :base rel { :inverse|:transitive|:reflexive|:symmetric
                             | :assignable
                             | :domain-constraint constraint
                             | :range-constraint constraint
                             | :uses rel
                             }*)
 (declType type)
 (declIndividual ind) 
 (declMaplet rel type {type}|({type}*))
 (constraint type? {:type-only|:individual-only}?) 
 (rel id id) 
 (rel id) 
 (describe '{id|rel}) 
 
 (declSlot id slot { :type type | :value val | :uses rel }*) 
 (typeExp) 
 (typeExp id)
 (slot id slot)
 
 

where

rel, type, ind

is either an identifier representing a relation, type, or individual. However, if rel/type/ind is first being declared (such as in "(declType type)") then the type/relation/individual should be a quoted string (since it isn't already a type/relation/individual).

id

is an identifier representing either a type or an indivudal (as above).

The functions are defined informally as follows:

declRelation

define a base relation (which is essentially a list of pairs of types (domain-element, range-element) or a relation based on another relation with certain additional properties as follows:

:inverse

The relation is the inverse of the base relation (axb iff bxa in the base relation).

:transitive

The relation is transitive (axb /\ bxc -> axc).

:reflexive

The relation is reflexive (axa always holds).

:symmetric

The relation is symmetric (axb -> bxa).

:assignable

The relation is assignable. An assignable relation can appear in (rel type type) expression, but a non-assignable relation cannot. By default relations based on other relations are NOT assignable, but base relations are assignable. Transitive relations cannot be assignable because the maplet in the base relation is ambiguous.

:domain-constraint constraint

A constraint on the type of the domain of the relation.

:range-constraint constraint

A constraint on the type of the range of the relation.

:uses rel

This relation will apply relation rel before computing results (eg: isa would normally use equal to allow synonyms in the type hierarchy).

declType

Declares an identifier to be a type

declIndividual

Declares an identifier to be an individual

declMaplet

define one or more maplets (domain, range) in relation. If the relation is isa-parent (or isa-child) settbox declares a type.

constraint

Creates a constraint by declaring the most general type and/or weather the object must be an individual only or a type only.

rel

• 2-parameter form: returns true if the relation exists between the two arguments.
• 1-parameter from: returns a list of types that appear in the range of the relation, given the domain as the first argument.

describe

returns a lisp description of the type including definitions of any types and relations that the argument type is dependent on.

To facilitate the type lattice, there are 8 primitive relations and one type that pre-defined:

 (deftboxrel "isa-parent" :domain-constraint (constraint :type type) :range-constraint (constraint :type type)) 
 (deftboxrel "isa-ancestor"  :base isa-parent   :transitive) 
 (deftboxrel "isa"           :base isa-ancestor :transitive :reflexive ) 
 (deftboxrel "isa-child"     :base isa-parent   :inverse :assignable) 
 (deftboxrel "isa-decendant" :base isa-child    :inverse :transitive ) 
 (declRelation "isequal" :transitive :reflexive :symmetric :assignable)
 (declType "TOP")  
 

Copyright: Copyright 2003-2014,Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Version:

0.9

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static Map<String,CASAOntology>	allOntologies Records all "public" (within the process) ontologies.
(package private) static Type	bottom A primitive type
static String	BOTTOM The name of the primitive type bottom
static String	DEFAULT_FILE_EXTENSION
private String	filePath The filename that this ontology was loaded from.
(package private) static ConcreteRelation	instanceOf A primitive relation
static String	INSTANCEOF The name of the primitive relation isequal
(package private) static ConcreteRelation	isa A primitive relation
static String	ISA The name of the primitive relation isa
(package private) static ConcreteRelation	isaAncestor A primitive relation
static String	ISAANCESTOR The name of the primitive relation isaAncestor
(package private) static ConcreteRelation	isaChild A primitive relation
static String	ISACHILD The name of the primitive relation isaChild
(package private) static ConcreteRelation	isaDescendant A primitive relation
static String	ISADESCENDANT The name of the primitive relation isaDescendant
(package private) static ConcreteRelation	isaParent A primitive relation
static String	ISAPARENT The name of the primitive relation isaParent
(package private) static ConcreteRelation	isequal A primitive relation
static String	ISEQUAL The name of the primitive relation isequal
private String	name The name of the ontology.
(package private) static String	PRIMITIVE_ONTOLOGY The name of the primitive ontology
(package private) static CASAOntology	primitiveOntology The primitive ontology
(package private) static ConcreteRelation	properInstanceOf A primitive relation
static String	PROPERINSTANCEOF The name of the primitive relation isaDescendant
(package private) HierarchicalDictionary<Relation>	relations A specialized HierarchicalDictionary used to contain relation objects in this ontology.
(package private) List<CASAOntology>	superOntologies The list of the super ontologies of this ontology
(package private) HierarchicalDictionary<BaseType>	tBox A specialized HierarchicalDictionary used to contain type objects in this ontology.
(package private) static Type	top A primitive type
static String	TOP The name of the primitive type top

Fields inherited from interface casa.ontology.Ontology

ONT__ASSERT, ONT__DESCRIBE, ONT__GET, ONT__GET_RESIDENT, ONT__IMPORT, ONT__INDIVIDUAL, ONT__IS_INDIVIDUAL, ONT__IS_OBJECT, ONT__IS_TYPE, ONT__RELATED_TO, ONT__RELATION, ONT__SET_DEFAULT, ONT__TYPE, ONTOLOGY

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CASAOntology(String name, CASAOntology... superOntologies) Instantiates a new ontology with parents specified by superOntologies.

Method Summary

Modifier and Type	Method and Description
int	add(String description) CASAOntolgy does not implement this method, and throws an IncompatableTypeHierarchiesException.
void	addIndividual(String name, String... parents)
void	addIndividual(String name, String parent)
void	addSuperOntologies(Ontology... parentOntologies)
void	addSuperOntologies(String... superOntologyNames)
void	addType(String name, String... parents) Adds an isa-parent relationship between name and each of the parents to the ontology.
void	addType(String name, String parent) Adds an isa-parent relationship between name and parent to the ontology.
private int	appendMapletDecl(StringBuffer b, BaseType t, Relation rel)
private boolean	canBeBase(Set<Relation.Property> properties)
BaseType	declIndividual(String name) Adds a new individual to this ontology.
protected void	declMaplet(Relation relation, BaseType domain, BaseType range) Adds a new pair in relationName to this ontology.
void	declMaplet(Relation relation, String domainName, String rangeName) Adds a new pair in relationName to this ontology.
void	declMaplet(String relationName, String domainName, String rangeName) Adds a new pair in relationName to this ontology.
ConcreteRelation	declRelation(String name, ConcreteRelation basedOn, Relation.Property[] properties, ConstraintSimple domConstraint, ConstraintSimple ranConstraint, Object... otherParams) Convenience method that calls #declRelation(String, ConcreteRelation, Property[], ConstraintSimple, ConstraintSimple, Object...) after converting the properties parameter.
ConcreteRelation	declRelation(String name, ConcreteRelation basedOn, Set<Relation.Property> properties, Constraint domConstraint, Constraint ranConstraint, Object... otherParams) Create and record a new relation in this ontology.
void	declRelation(String name, String basedOn, Set<Relation.Property> properties, Constraint domConstraint, Constraint ranConstraint, Object... otherParams)
BaseType	declType(String name) Adds a new type to this ontology.
String	describe(BaseType type) This method is not fully implemented in this implementation
String	describe(String name) This method is not fully implemented in this implementation
private String	describe2(Type theType, TreeSet<Type> doneTypes, TreeSet<String> doneRels) This method is not fully implemented in this implementation
String	describeIndividual(String type)
private String	describeRel(Relation relation, TreeSet<String> doneRels) This method is not fully implemented in this implementation
String	describeRelation(String relation)
String	describeType(String type)
Status	extendWith(String spec) Not implemented.
String	getDefaultFileExtension()
String	getName()
static CASAOntology	getOntology(String name) Find or read in a CASAOntology.
Relation	getRelation(String name) Retrieves the relation object based on the name.
static String[]	getResident()
BaseType	getType(String name) Retrieves the type object based on the name.
boolean	instanceOf(String child, String parent)
Set<String>	isa(String child) Finals all ancestors of child.
boolean	isa(String child, String parent) Shortcut for the (isa child parent) lisp operator, or this.relatedTo(isa,child,parent).
Set<String>	isAncestor(String child)
private boolean	isAssignable(Set<Relation.Property> properties)
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	isPrivate()
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.
static CASAOntology	makeOntology(String name, Ontology... superOntologies) Constructs a new CASAOntology
static CASAOntology	makeOntology2(String name, String... superOntologies)
static Status	ontology_lispImpl(TransientAgent agent, ParamsMap params, AgentUI ui, Environment env)
private boolean	primitiveRelation(String name)
protected boolean	queryMaplet(Relation relation, Type domain, Type range) Determines if domainName and rangeName are related through relation relationName WITHOUT TAKING INTO ACCOUNT the isa relationships of the domain and range.
boolean	queryMaplet(String relationName, String domainName, String rangeName) Determines if domainName and rangeName are related through relation relationName WITHOUT TAKING INTO ACCOUNT the isa relationships of the domain and range.
protected boolean	relatedTo(Relation relation, String domain, String range) Determines if domain and range are related through relation relation.
protected Set<Type>	relatedTo(Relation relation, Type domain)
protected boolean	relatedTo(Relation relation, Type domain, Type range) Determines if domain and range are related through relation relation.
Set<String>	relatedTo(String relation, String domain)
boolean	relatedTo(String relation, String domain, String range) Determines if domain and range are related through relation relation.
private void	setSymbol(String name) Set TWO symbols for the parameter name: one for the unqualified name, and another for the qualified name (ontology and name).
String	toString() Returns a string describing the ontolog in the following form (for example):

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_FILE_EXTENSION

public static final String DEFAULT_FILE_EXTENSION

See Also:

Constant Field Values

primitiveOntology

static CASAOntology primitiveOntology

The primitive ontology

PRIMITIVE_ONTOLOGY

static final String PRIMITIVE_ONTOLOGY

The name of the primitive ontology

See Also:

Constant Field Values

isaParent

static ConcreteRelation isaParent

A primitive relation

isaAncestor

static ConcreteRelation isaAncestor

A primitive relation

isa

static ConcreteRelation isa

A primitive relation

isaChild

static ConcreteRelation isaChild

A primitive relation

isaDescendant

static ConcreteRelation isaDescendant

A primitive relation

isequal

static ConcreteRelation isequal

A primitive relation

properInstanceOf

static ConcreteRelation properInstanceOf

A primitive relation

instanceOf

static ConcreteRelation instanceOf

A primitive relation

ISAPARENT

public static final String ISAPARENT

The name of the primitive relation isaParent

See Also:

Constant Field Values

ISAANCESTOR

public static final String ISAANCESTOR

The name of the primitive relation isaAncestor

See Also:

Constant Field Values

ISA

public static final String ISA

The name of the primitive relation isa

See Also:

Constant Field Values

ISACHILD

public static final String ISACHILD

The name of the primitive relation isaChild

See Also:

Constant Field Values

ISADESCENDANT

public static final String ISADESCENDANT

The name of the primitive relation isaDescendant

See Also:

Constant Field Values

ISEQUAL

public static final String ISEQUAL

The name of the primitive relation isequal

See Also:

Constant Field Values

PROPERINSTANCEOF

public static final String PROPERINSTANCEOF

The name of the primitive relation isaDescendant

See Also:

Constant Field Values

INSTANCEOF

public static final String INSTANCEOF

The name of the primitive relation isequal

See Also:

Constant Field Values

top

static Type top

A primitive type

TOP

public static final String TOP

The name of the primitive type top

See Also:

Constant Field Values

bottom

static Type bottom

A primitive type

BOTTOM

public static final String BOTTOM

The name of the primitive type bottom

See Also:

Constant Field Values

name

private String name

The name of the ontology.

filePath

private String filePath

The filename that this ontology was loaded from. Note that this value cannot always be filed out accurately (especially when more than one ontology is loaded from the same file), so you can't assume that this value is going to be available.

allOntologies

static Map<String,CASAOntology> allOntologies

Records all "public" (within the process) ontologies. Ontologies with no name (null or "") or with a name beginning with a dot (.) are NOT recorded here (these are considered "private").

superOntologies

List<CASAOntology> superOntologies

The list of the super ontologies of this ontology

tBox

HierarchicalDictionary<BaseType> tBox

A specialized HierarchicalDictionary used to contain type objects in this ontology.

relations

HierarchicalDictionary<Relation> relations

A specialized HierarchicalDictionary used to contain relation objects in this ontology.

Constructor Detail

CASAOntology

private CASAOntology(String name,
                     CASAOntology... superOntologies)
              throws IllegalOperationException

Instantiates a new ontology with parents specified by superOntologies. The ontology is registered in allOntologies unless it's name is null, empty, or begins with ".".

Parameters:

name -

superOntologies -

Throws:

IllegalOperationException

Method Detail

getName

public String getName()

Specified by:

getName in interface Ontology

Returns:

the name of this ontology

isPrivate

public boolean isPrivate()

Returns:

true iff the ontology has no name (null or "") or has a name beginning with a dot (.).

getOntology

public static CASAOntology getOntology(String name)

Find or read in a CASAOntology. If the named ontology has been created already it is returned, otherwise it is instantiated from a file ("[ontology-name].ont.lisp"), recorded and returned. The ontology is NOT recorded if is private (see isPrivate()).

Parameters:

name - the name of the ontology as specified in it's constructor and return by getName()

Returns:

the found ontology

makeOntology

public static CASAOntology makeOntology(String name,
                                        Ontology... superOntologies)
                                 throws IllegalOperationException

Constructs a new CASAOntology

Parameters:

name -

superOntologies -

Returns:

a newly constructed CASAOntology

Throws:

IllegalOperationException - If a CASAOntology with that name already exists.

makeOntology2

public static CASAOntology makeOntology2(String name,
                                         String... superOntologies)
                                  throws IllegalOperationException

Throws:

IllegalOperationException

addSuperOntologies

public void addSuperOntologies(Ontology... parentOntologies)
                        throws IllegalOperationException

Specified by:

addSuperOntologies in interface Ontology

Throws:

IllegalOperationException

addSuperOntologies

public void addSuperOntologies(String... superOntologyNames)
                        throws IllegalOperationException

Specified by:

addSuperOntologies in interface Ontology

Throws:

IllegalOperationException

declRelation

public ConcreteRelation declRelation(String name,
                                     ConcreteRelation basedOn,
                                     Relation.Property[] properties,
                                     ConstraintSimple domConstraint,
                                     ConstraintSimple ranConstraint,
                                     Object... otherParams)
                              throws IllegalOperationException

Convenience method that calls #declRelation(String, ConcreteRelation, Property[], ConstraintSimple, ConstraintSimple, Object...) after converting the properties parameter.

Parameters:

name -

basedOn -

properties -

otherParams - any additional parameters

Returns:

a new relation

Throws:

IllegalOperationException

See Also:

#declRelation(String, ConcreteRelation, Property[], ConstraintSimple, ConstraintSimple, Object...)

declRelation

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

Specified by:

declRelation in interface Ontology

Throws:

IllegalOperationException

declRelation

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

Create and record a new relation in this ontology. This method automatically instantiates a lisp operator with the same name as the relation to test a pair in the relation.

Parameters:

name - The name of the new relation.

basedOn - The relation on which to base this relation; if null indicates that this relation is a either a primitive relation itself (no properties case), or (if there are properties specified) we should generate an auxilliary primitive relation (named uniquely based on the relation name). on which to base this relation.

properties - the set of properties (INVERSE, SYMMETRIC, ASYMMETRIC, TRANSITIVE, REFLEXIVE, USES) for that the new relation should exhibit.

otherParams - TODO

Returns:

the relation object recorded in this ontology.

Throws:

IllegalOperationException - if the relation name attempts to override a reserved relation or you are attempting base a primitive (no properties) relation on another relation (basedOn!=null & properties.isEmpty).

canBeBase

private boolean canBeBase(Set<Relation.Property> properties)

Parameters:

properties -

Returns:

true iff properties is null or empty.

isAssignable

private boolean isAssignable(Set<Relation.Property> properties)

Parameters:

properties -

Returns:

true iff there is no property that is not assignable.

declType

public BaseType declType(String name)
                  throws IllegalOperationException

Adds a new type to this ontology. Also defines the type as a symbol in the Lisp system.

Parameters:

name -

Returns:

the type that was added.

Throws:

IllegalOperationException - if the name was illegal, or the type couldn't be added for some reason.

declIndividual

public BaseType declIndividual(String name)
                        throws IllegalOperationException

Adds a new individual to this ontology. Also defines the individual as a symbol in the Lisp system.

Parameters:

name -

Returns:

the type that was added.

Throws:

IllegalOperationException - if the name was illegal, or the type couldn't be added for some reason.

setSymbol

private void setSymbol(String name)
                throws IllegalOperationException

Set TWO symbols for the parameter name: one for the unqualified name, and another for the qualified name (ontology and name).

Parameters:

name - the symbol to be defined; this may be the qualified or unqualified name.

Throws:

IllegalOperationException - if the name was illegal.

declMaplet

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

Adds a new pair in relationName to this ontology. After this call, the lisp operator (relationName domainName rangeName) should return true.

Specified by:

declMaplet in interface Ontology

Parameters:

relationName -

domainName -

rangeName -

Throws:

IllegalOperationException - if the name was illegal, or the maplet couldn't be added for some reason.

See Also:

declMaplet(Relation, BaseType, BaseType)

declMaplet

public void declMaplet(Relation relation,
                       String domainName,
                       String rangeName)
                throws IllegalOperationException

Adds a new pair in relationName to this ontology. After this call, the lisp operator (relationName domainName rangeName) should return true.

Parameters:

relation -

domainName -

rangeName -

Throws:

IllegalOperationException - if the name was illegal, or the maplet couldn't be added for some reason.

See Also:

declMaplet(Relation, BaseType, BaseType)

declMaplet

protected void declMaplet(Relation relation,
                          BaseType domain,
                          BaseType range)
                   throws IllegalOperationException

Adds a new pair in relationName to this ontology. After this call, the lisp operator (relationName domainName rangeName) should return true.

Parameters:

relationName -

domainName -

rangeName -

Throws:

IllegalOperationException - if the relation is non-assignable, or the maplet couldn't be added for some reason.

queryMaplet

public boolean queryMaplet(String relationName,
                           String domainName,
                           String rangeName)
                    throws IllegalOperationException

Determines if domainName and rangeName are related through relation relationName WITHOUT TAKING INTO ACCOUNT the isa relationships of the domain and range.

Parameters:

relationName -

domainName -

rangeName -

Returns:

true iff domaionName and rangeName are related through relation relationName

Throws:

IllegalOperationException - if any of the parameters can't be found, etc

See Also:

queryMaplet(Relation, Type, Type)

queryMaplet

protected boolean queryMaplet(Relation relation,
                              Type domain,
                              Type range)

Determines if domainName and rangeName are related through relation relationName WITHOUT TAKING INTO ACCOUNT the isa relationships of the domain and range.

Parameters:

relation -

domain -

range -

Returns:

true iff domaionName and rangeName are related through relation relationName

Throws:

IllegalOperationException - if any of the parameters can't be found, etc

toString

public String toString()

Returns a string describing the ontolog in the following form (for example):

 (declOntology "events" ;loaded from file /Apple/CASA/dataFiles/events.ont.lisp
  ��'(isa) ;super ontologies (the search path is events, isa)
  ��'( ;ontology declarations
   ����(declType "event")
   ����(declType "event_AdvertisementAdded")
       ...
       (declMaplet event isa:TOP)
       (declMaplet event_advertisementEvent events:event)
       ...
 ��*    )
 ) 
 

Note that some of the commented information might not be available.

Specified by:

toString in interface Ontology

Overrides:

toString in class Object

Returns:

a string containing the persistent representation of this TypeHierarchy

See Also:

Object.toString()

appendMapletDecl

private int appendMapletDecl(StringBuffer b,
                             BaseType t,
                             Relation rel)

getRelation

public Relation getRelation(String name)
                     throws IllegalOperationException

Retrieves the relation object based on the name.

Parameters:

name -

Returns:

The relation object for name.

Throws:

IllegalOperationException

getType

public BaseType getType(String name)
                 throws IllegalOperationException

Retrieves the type object based on the name.

Parameters:

name -

Returns:

The type object for name.

Throws:

IllegalOperationException

addType

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

Adds an isa-parent relationship between name and each of the parents to the ontology. This method will also preform a behind-the-scenes declType(String) for name if it doesn't already exist.

Specified by:

addType in interface Ontology

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

DuplicateNodeException

See Also:

Ontology.addType(java.lang.String, java.lang.String)

addType

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

Adds an isa-parent relationship between name and parent to the ontology. This method will also preform a behind-the-scenes declType(String) for name if it doesn't already exist.

Specified by:

addType in interface Ontology

Parameters:

name - the name of new type

parent - the super-type of name.

Throws:

ParentNodeNotFoundException - if parent isn't in the hierarchy.

IllegalOperationException

DuplicateNodeException

See Also:

Ontology.addType(java.lang.String, java.lang.String)

add

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

CASAOntolgy does not implement this method, and throws an IncompatableTypeHierarchiesException. Instead execute the lisp commands (declOntology ...) or (with-ontology ...).

Specified by:

add in interface Ontology

Returns:

the number of types added to the hierarchy

Throws:

IncompatableTypeHierarchiesException

ParentNodeNotFoundException

ParseException

DuplicateNodeException

See Also:

Ontology.add(java.lang.String)

describe

public String describe(String name)
                throws IllegalOperationException

This method is not fully implemented in this implementation

Specified by:

describe in interface Ontology

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

See Also:

Ontology.describe(java.lang.String)

describe

public String describe(BaseType type)
                throws IllegalOperationException

This method is not fully implemented in this implementation

Parameters:

type -

Returns:

the String describing the type.

Throws:

IllegalOperationException

See Also:

Ontology.describe(String)

describe2

private String describe2(Type theType,
                         TreeSet<Type> doneTypes,
                         TreeSet<String> doneRels)
                  throws IllegalOperationException

This method is not fully implemented in this implementation

Throws:

IllegalOperationException

See Also:

Ontology.describe(java.lang.String)

describeRelation

public String describeRelation(String relation)
                        throws IllegalOperationException

Specified by:

describeRelation in interface Ontology

Throws:

IllegalOperationException

describeType

public String describeType(String type)
                    throws IllegalOperationException

Specified by:

describeType in interface Ontology

Throws:

IllegalOperationException

describeIndividual

public String describeIndividual(String type)
                          throws IllegalOperationException

Specified by:

describeIndividual in interface Ontology

Throws:

IllegalOperationException

describeRel

private String describeRel(Relation relation,
                           TreeSet<String> doneRels)

This method is not fully implemented in this implementation

See Also:

Ontology.describe(java.lang.String)

primitiveRelation

private boolean primitiveRelation(String name)

Parameters:

name - The name of a relation

Returns:

true iff the named relation is a primitive (system defined, non-overrideable, non-modifiable) relation

isCompatable

public boolean isCompatable(Ontology other)

Description copied from interface: Ontology

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

Specified by:

isCompatable in interface Ontology

Parameters:

other - the TypeHierarchy ot compare to this one for compatability

Returns:

true iff other is compatable

isCompatableThrow

public void isCompatableThrow(Ontology other)
                       throws IncompatableTypeHierarchiesException

Description copied from interface: Ontology

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.

Specified by:

isCompatableThrow in interface Ontology

Parameters:

other - the TypeHierarchy ot compare to this one for compatability

Throws:

IncompatableTypeHierarchiesException - iff other is incompatable

isObject

public boolean isObject(String name)
                 throws IllegalOperationException

Description copied from interface: Ontology

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

Specified by:

isObject in interface Ontology

Parameters:

name - the name of the type

Returns:

true iff this type name is included in the ontology or one of the super ontologies.

Throws:

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

See Also:

Ontology.isObject(java.lang.String)

isType

public boolean isType(String name)
               throws IllegalOperationException

Description copied from interface: Ontology

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

Specified by:

isType in interface Ontology

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

public boolean isIndividual(String name)
                     throws IllegalOperationException

Description copied from interface: Ontology

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

Specified by:

isIndividual in interface Ontology

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.

isa

public boolean isa(String child,
                   String parent)
            throws IllegalOperationException

Shortcut for the (isa child parent) lisp operator, or this.relatedTo(isa,child,parent).

Specified by:

isa in interface Ontology

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

See Also:

Ontology.isa(java.lang.String, java.lang.String), relatedTo(Relation, Type, Type)

relatedTo

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

Determines if domain and range are related through relation relation. This method takes into account the superOntologies and this isa relations (unlike queryMaplet(Relation, Type, Type) and queryMaplet(String, String, String)).

Specified by:

relatedTo in interface Ontology

Parameters:

relation -

domain -

rang -

Returns:

true iff domaion and range are related through relation relation

Throws:

IllegalOperationException - if any of the parameters can't be found, etc

UnsupportedOperationException

See Also:

queryMaplet(Relation, Type, Type)

relatedTo

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

Determines if domain and range are related through relation relation. This method takes into account the superOntologies and this isa relations (unlike queryMaplet(Relation, Type, Type) and queryMaplet(String, String, String)).

Parameters:

relation -

domain -

rang -

Returns:

true iff domaion and range are related through relation relation

Throws:

IllegalOperationException - if any of the parameters can't be found, etc

UnsupportedOperationException

See Also:

#queryRelation(Relation, Type, Type)

relatedTo

protected boolean relatedTo(Relation relation,
                            Type domain,
                            Type range)

Determines if domain and range are related through relation relation. This method takes into account the superOntologies and this isa relations (unlike queryMaplet(Relation, Type, Type) and queryMaplet(String, String, String)).

Parameters:

relation -

domain -

rang -

Returns:

true iff domaion and range are related through relation relation

Throws:

IllegalOperationException - if any of the parameters can't be found, etc

relatedTo

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

Specified by:

relatedTo in interface Ontology

Throws:

UnsupportedOperationException

IllegalOperationException

relatedTo

protected Set<Type> relatedTo(Relation relation,
                              Type domain)

Parameters:

relation -

domain -

Returns:

the set of Types domain is related to via relation.

extendWith

public Status extendWith(String spec)

Not implemented.

Specified by:

extendWith in interface 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

See Also:

Ontology.extendWith(java.lang.String)

addIndividual

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

Specified by:

addIndividual in interface Ontology

Throws:

ParentNodeNotFoundException

DuplicateNodeException

IllegalOperationException

ontology_lispImpl

public static Status ontology_lispImpl(TransientAgent agent,
                                       ParamsMap params,
                                       AgentUI ui,
                                       Environment env)
                                throws ControlTransfer

Throws:

ControlTransfer

getResident

public static String[] getResident()

addIndividual

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

Specified by:

addIndividual in interface Ontology

Throws:

ParentNodeNotFoundException

DuplicateNodeException

IllegalOperationException

instanceOf

public boolean instanceOf(String child,
                          String parent)
                   throws IllegalOperationException

Specified by:

instanceOf in interface Ontology

Throws:

IllegalOperationException

isRelation

public boolean isRelation(String name)
                   throws IllegalOperationException

Description copied from interface: Ontology

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

Specified by:

isRelation in interface Ontology

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.

isa

public Set<String> isa(String child)
                throws IllegalOperationException

Description copied from interface: Ontology

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

Specified by:

isa in interface Ontology

Parameters:

child - the name if a node in the TypeHierarchy

Returns:

all ancestors of child

Throws:

IllegalOperationException

isParent

public Set<String> isParent(String child)
                     throws IllegalOperationException

Description copied from interface: Ontology

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

Specified by:

isParent in interface Ontology

Parameters:

child - the name if a node in the TypeHierarchy

Returns:

all parents (direct ancestors) of child

Throws:

IllegalOperationException

isAncestor

public Set<String> isAncestor(String child)
                       throws IllegalOperationException

Specified by:

isAncestor in interface Ontology

Throws:

IllegalOperationException

isChild

public Set<String> isChild(String parent)
                    throws IllegalOperationException

Specified by:

isChild in interface Ontology

Throws:

IllegalOperationException

isDescendant

public Set<String> isDescendant(String parent)
                         throws IllegalOperationException

Specified by:

isDescendant in interface Ontology

Throws:

IllegalOperationException

getDefaultFileExtension

public String getDefaultFileExtension()

Specified by:

getDefaultFileExtension in interface Ontology