casa.ontology.v3

Class BaseType

java.lang.Object

casa.ontology.v3.BaseType

All Implemented Interfaces:

OntologyEntity, Type, Comparable<OntologyEntity>

Direct Known Subclasses:

SimpleType, TypeListType

abstract class BaseType
extends Object
implements Type

Helper class for Ontology; not to be used by any other class other than Ontology. A BaseType stores all the relations it participates in through a BaseType.Role, which is the

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.

Company: Knowledge Science Group

Version:

0.9

Author:

Rob Kremer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BaseType.Role Responsible to store a Relation (BaseType.Role.rel) together with: BaseType.Role.inDomain: a list of other types in which this type is in relation in the domain position BaseType.Role.inRange: a list of other types in which this type is in relation in the range position

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mark Used by TypeHierarchy to help in visiting the nodes
private Name	name Name of the type.
(package private) TreeMap<String,BaseType.Role>	roles

Constructor Summary

Constructors

Constructor and Description
BaseType()
BaseType(String name, Ontology ont)

Method Summary

Modifier and Type	Method and Description
int	compareTo(OntologyEntity x) Used by TreeMap as a sorting comparitor.
int	compareTo(String x) Used by TreeMap as a sorting comparitor.
boolean	equals(Type x) Determines if this Node is equal to x, where "equal" means that the names are the same, and the name of each of the parents is the same.
String	getName()
Ontology	getOntology()
String	getRelativeName(Ontology ont)
protected Set<String>	getRoles() Returns the set of roles (relation names) that this Type is in the domain for.
String	getUnqualifiedName()
private void	insertRelationFrom(Relation relation, BaseType x) Primitive method to add a link to the Type oo the range end of relation.
protected boolean	insertRelationTo(Relation relation, BaseType roleFiller) Primitive method to add a relation to link this Type through relation to another Type.
protected void	insertRelationTo(Relation relation, Vector<BaseType> roleFiller)
protected Set<Type>	relatedFrom(Relation relation)
protected boolean	relatedFrom(Relation relation, BaseType domain)
protected Set<Type>	relatedFrom(String relation)
protected Set<Type>	relatedTo(Relation relation)
protected boolean	relatedTo(Relation relation, BaseType range)
protected Set<Type>	relatedTo(String relation)
protected boolean	removeRelationTo(Relation relation, BaseType roleFiller) Primitive method to remove a relation link from this Type through relation to rolefiller.
void	resetMark() Traverses the hierarchy setting each node's mark element to the number of parents of the node.
String	toString()
protected String	toStringNonIsa()
protected String	toStringParent()
protected String	toStringWithIsaChildren() Recursive method to print to a String a node and all it's children in the persistent format in the an order such that no node definition comes before the definition of all it's ancestors.

Methods inherited from class java.lang.Object

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

Methods inherited from interface casa.ontology.Type

isIndividual

Field Detail

roles

TreeMap<String,BaseType.Role> roles

mark

protected int mark

Used by TypeHierarchy to help in visiting the nodes

name

private Name name

Name of the type.

Constructor Detail

BaseType

BaseType(String name,
         Ontology ont)
  throws IllegalOperationException

Throws:

IllegalOperationException

BaseType

BaseType()

Method Detail

insertRelationTo

protected boolean insertRelationTo(Relation relation,
                                   BaseType roleFiller)

Primitive method to add a relation to link this Type through relation to another Type. This type will the domain, and other rolefiller type will be the range. The back link will automatically be created using insertRelationFrom(Relation, BaseType).

Parameters:

relation - the relation to add or extend (depending if it exists or not)

x - the child to add

getName

public String getName()

Specified by:

getName in interface OntologyEntity

Returns:

getRelativeName

public String getRelativeName(Ontology ont)

getOntology

public Ontology getOntology()

Specified by:

getOntology in interface OntologyEntity

getUnqualifiedName

public String getUnqualifiedName()

Returns:

insertRelationTo

protected void insertRelationTo(Relation relation,
                                Vector<BaseType> roleFiller)

Parameters:

relation -

roleFiller -

Throws:

IllegalOperationException

insertRelationFrom

private void insertRelationFrom(Relation relation,
                                BaseType x)

Primitive method to add a link to the Type oo the range end of relation. Users of the ontology should use only insertRelationFrom(Relation, BaseType) or insertRelationTo(Relation, Vector)

Parameters:

relation - the relation to add or extend (dependint if it exists or not)

x - the child to add

removeRelationTo

protected boolean removeRelationTo(Relation relation,
                                   BaseType roleFiller)

Primitive method to remove a relation link from this Type through relation to rolefiller. This type will the domain, and other rolefiller type will be the range. The back link will automatically be deleted using insertRelationFrom(Relation, BaseType). The the role (relation) is now empty, delete it to clean up.

Parameters:

relation - the relation to add or extend (depending if it exists or not)

x - the child to add

Returns:

true if the relationship was removed or false if the relationship wasn't there or couldn't be removed

resetMark

public void resetMark()

Traverses the hierarchy setting each node's mark element to the number of parents of the node.

Specified by:

resetMark in interface Type

relatedTo

protected Set<Type> relatedTo(String relation)

Returns:

a reference to the set of types that this type is related to (by "relation", ie: this type is in the domain and the others are in the range) or null if this type has no such role (note that the return set could also be empty if the role exists but there are no fillers).

relatedFrom

protected Set<Type> relatedFrom(String relation)

Returns:

a reference to the set of types that have a relation to this type (by "relation", ie: this type is in the range and the others are in domain) or null if this type has no such role between any type.

relatedTo

protected Set<Type> relatedTo(Relation relation)

Returns:

a reference to the set of types that this type is related to (by "relation", ie: this type is in the domain and the others are in the range) or null if this type has no such role (note that the return set could also be empty if the role exists but there are no fillers).

relatedTo

protected boolean relatedTo(Relation relation,
                            BaseType range)

Returns:

true if this Type is related to range (by relation, ie: this type is in the domain and the other is in the range) or null if this type has no such role or the role doesn't contain range.

relatedFrom

protected Set<Type> relatedFrom(Relation relation)

Returns:

a reference to the set of types that have a relation to this type (by "relation", ie: this type is in the range and the others are in domain) or null if this type has no such role between any type.

relatedFrom

protected boolean relatedFrom(Relation relation,
                              BaseType domain)

Returns:

true if this Type is on the range side of relation rlations with domain on the domain side; or null if this type has no such role or the role doesn't contain domain.

getRoles

protected Set<String> getRoles()

Returns the set of roles (relation names) that this Type is in the domain for.

Returns:

a reference to the parents Vector.

toString

public String toString()

Specified by:

toString in interface OntologyEntity

Overrides:

toString in class Object

toStringParent

protected String toStringParent()

Returns:

A string of the form "(declType isa-parent [thisType] [rangetype]...)" describing all the non-isa relations for this type, or if there is no isa relation the string is "(declType [thisType)".

toStringNonIsa

protected String toStringNonIsa()

Returns:

A string of the form "(settbpx [role] [thisType] [rangetype]...) [newline] ..." describing all the non-isa relations for this type.

toStringWithIsaChildren

protected String toStringWithIsaChildren()

Recursive method to print to a String a node and all it's children in the persistent format in the an order such that no node definition comes before the definition of all it's ancestors. A call to resetMark() must precede the call to this method in order for it to function correctly.

Parameters:

x - the node to print to the String

Returns:

a String representing the persistent format of the node and all it's children

compareTo

public int compareTo(String x)

Used by TreeMap as a sorting comparitor. Compares on the basis of the name.

Parameters:

x - A String to be compared to name.

Returns:

-1 if name is less than x.name; 0 if name is equal to x.name; 1 if name is greater than x.name

compareTo

public int compareTo(OntologyEntity x)

Used by TreeMap as a sorting comparitor. Compares on the basis of the name.

Specified by:

compareTo in interface Comparable<OntologyEntity>

Parameters:

x - Another Node object to be compared with

Returns:

-1 if name is less than x.name; 0 if name is equal to x.name; 1 if name is greater than x.name

equals

public boolean equals(Type x)

Determines if this Node is equal to x, where "equal" means that the names are the same, and the name of each of the parents is the same. This is non-recursive.

Parameters:

x - A Node to be compared with

Returns:

true iff this and x are equal.