casa.ontology.v3

Class ConcreteRelation

java.lang.Object

casa.ontology.v3.ConcreteRelation

All Implemented Interfaces:

OntologyEntity, Relation, Comparable<OntologyEntity>

Direct Known Subclasses:

BasedRelation, PrimitiveRelation

public abstract class ConcreteRelation
extends Object
implements Relation

Author:

Rob Kremer

Nested Class Summary

Nested classes/interfaces inherited from interface casa.ontology.Relation

Relation.Property

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	mark
protected Name	name
(package private) boolean	visible

Constructor Summary

Constructors

Constructor and Description
ConcreteRelation(String name, Ontology ontology)

Method Summary

Modifier and Type	Method and Description
int	compareTo(OntologyEntity o)
String	getName()
Ontology	getOntology()
String	getRelativeName(Ontology ont)
abstract ConcreteRelation	getUses()
boolean	hasProperty(Relation.Property property)
abstract boolean	isBasedOn(Relation other)
boolean	isMark() Convenience method to check if a method is marked.
boolean	isVisible()
Set<Type>	relatedTo(Type domain) Returns all the types that this domain is related to.
abstract Set<Type>	relatedTo(Type domain, ConcreteRelation topOfStack)
boolean	relatedTo(Type domain, Type range) Determines if domain is related to range through this Relation.
protected abstract Maplet	relatedTo(Type domain, Type range, ConcreteRelation topOfStack)
Maplet	relatedToX(Type domain, Type range) Determines if domain is related to range through this Relation.
void	setMark(boolean mark) Convenience method to set or clear a mark in the relation when iterating relations.
void	setName(String name)
boolean	setVisible(boolean set) Some relations are not declared, but are created in some implementations in the process of creating other relations.
abstract String	toStringComment(Ontology relativeToOntology) A comment string appropriate for the relation (not inclding the prefix ";").
String	toStringOptions()

Methods inherited from class java.lang.Object

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

Methods inherited from interface casa.ontology.Relation

add, isAssignable, remove

Methods inherited from interface casa.ontology.OntologyEntity

toString

Field Detail

name

protected Name name

mark

private boolean mark

visible

boolean visible

Constructor Detail

ConcreteRelation

ConcreteRelation(String name,
                 Ontology ontology)
          throws IllegalOperationException

Throws:

IllegalOperationException

Method Detail

compareTo

public int compareTo(OntologyEntity o)

Specified by:

compareTo in interface Comparable<OntologyEntity>

getName

public String getName()

Specified by:

getName in interface OntologyEntity

Returns:

getOntology

public Ontology getOntology()

Specified by:

getOntology in interface OntologyEntity

setName

public void setName(String name)
             throws IllegalOperationException

Throws:

IllegalOperationException

isBasedOn

public abstract boolean isBasedOn(Relation other)

getRelativeName

public String getRelativeName(Ontology ont)

relatedTo

public final boolean relatedTo(Type domain,
                               Type range)

Determines if domain is related to range through this Relation. This is done by calling relatedToX(Type, Type) and returning FALSE if it returns null, and TRUE otherwise.

Specified by:

relatedTo in interface Relation

Parameters:

domain -

range -

Returns:

true iff domain is related to range through this Relation.

See Also:

Relation.relatedTo(casa.ontology.Type, casa.ontology.Type)

relatedToX

public final Maplet relatedToX(Type domain,
                               Type range)

Determines if domain is related to range through this Relation. This is done by calling relatedTo(Type, Type) and returning FALSE if it returns null, and TRUE otherwise.

Parameters:

domain -

range -

Returns:

the found most-specific Maplet if domain is related to range through this Relation, null otherwise.

relatedTo

protected abstract Maplet relatedTo(Type domain,
                                    Type range,
                                    ConcreteRelation topOfStack)

relatedTo

public final Set<Type> relatedTo(Type domain)

Description copied from interface: Relation

Returns all the types that this domain is related to. In terms of description logics, whether domain has a role of type range.

Specified by:

relatedTo in interface Relation

Parameters:

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

Returns:

The set of ranges that are related to this type, or an empty set if the domain has no such relationship.

relatedTo

public abstract Set<Type> relatedTo(Type domain,
                                    ConcreteRelation topOfStack)

isMark

public boolean isMark()

Description copied from interface: Relation

Convenience method to check if a method is marked. See Relation.setMark(boolean) .

Specified by:

isMark in interface Relation

Returns:

setMark

public void setMark(boolean mark)

Description copied from interface: Relation

Convenience method to set or clear a mark in the relation when iterating relations.

Specified by:

setMark in interface Relation

Parameters:

mark -

hasProperty

public boolean hasProperty(Relation.Property property)

Specified by:

hasProperty in interface Relation

Returns:

isVisible

public boolean isVisible()

Specified by:

isVisible in interface Relation

Returns:

true if the relations is visible, false if it's not.

See Also:

Relation.setVisible(boolean)

setVisible

public boolean setVisible(boolean set)

Description copied from interface: Relation

Some relations are not declared, but are created in some implementations in the process of creating other relations. It is sometimes convenient to "hide" these relations from the user and not have these show up in the persistent form (see OntologyEntity.toString() ). Use setVisible() to set the visibility attribute as read by Relation.isVisible() .

Specified by:

setVisible in interface Relation

Parameters:

set -

Returns:

toStringOptions

public String toStringOptions()

getUses

public abstract ConcreteRelation getUses()

Returns:

the Relation that this relation uses as its internal "equivalence" relation.

toStringComment

public abstract String toStringComment(Ontology relativeToOntology)

A comment string appropriate for the relation (not inclding the prefix ";"). Specifically the this should be a list in the form:

 name(class-name), name(class-name)...

describing the base and ordered decorators for this relation.

Parameters:

relativeToOntology - TODO

Returns:

A string as described above.