prajna.ontology

Class OwlThing

java.lang.Object

prajna.data.rdf.RdfThing

prajna.ontology.OwlThing

All Implemented Interfaces:

java.io.Serializable

public class OwlThing
extends RdfThing

Class representing a thing within an Owl Ontology. This class provides methods to manage properties and relationships, as well as creation of OwlThings.

Author:

Edward Swing

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addDatatypeValue(java.lang.String datatypeName, RdfDataThing<?> rdfThing) Add a value for a Datatype property to this OwlThing.
boolean	addDatatypeValue(java.lang.String datatypeName, java.lang.String value) Add a value for a Datatype property to this OwlThing.
boolean	addDatatypeValue(java.lang.String datatypeName, java.lang.String value, RdfTriple.TripleType relationType) Add a value for a Datatype property to this OwlThing.
static void	addOwlThing(OwlThing thing) Add an OwlThing to the cache if it hasn't been added, or if it had been previously removed
boolean	addRelation(java.lang.String relationName, OwlThing relatedTo, RdfTriple.TripleType relationType) Add a relation to this OwlThing, relating it to another OwlThing
void	addSameAs(java.lang.String altName) Create a sameAs reference for a particular object.
static void	clearDefined() Remove all defined OwlThings from the internal tables
void	copyValues(OwlThing otherThing) Copy explicit properties from another OwlThing to this one.
static OwlThing	createFromElement(org.w3c.dom.Element element) Create an OwlThing from an OWL RDF element.
void	delete() Delete this OwlThing from the cache, and remove it from any relations with other objects.
void	deriveValues() Derive all values for this OwlThing.
static OwlThing	findOwlThing(java.lang.String name) Find an OwlThing with the given name.
static java.util.Set<java.lang.String>	getAllThingNames() Get the names of all OwlThings defined.
static java.util.Set<OwlThing>	getAllThings() Get all OwlThings defined
java.util.Set<java.lang.String>	getAlternateNames() Get the set of names this thing is also known as.
OwlClass	getOwlClass() Get the OwlClass this OwlThing belongs to.
static OwlThing	getOwlThing(java.lang.String name) Get an OwlThing with the given name.
static OwlThing	getOwlThing(java.lang.String name, OwlClass owlClass) Get an OwlThing with the given name and class.
java.util.Set<OwlThing>	getRelated(java.lang.String relationName) Get all things that are related to this object by the given relationship name or its descendant properties.
java.util.Set<RdfTriple>	getRelationships() Get all relationships that this OwlThing has values for
java.util.Set<java.lang.String>	getValues(java.lang.String propertyName) Get all string values for the given property for this OwlThing.
void	mergeThing(OwlThing owlThing) Merge another defined thing with this thing
boolean	refineClass(OwlClass newCls) Refine this OwlThing to be a member of the provided class.
void	removeAllSameAs() Remove all sameAs links to this OwlThing
void	removeDatatypeValue(java.lang.String propName, java.lang.String value) Removes a datatype value to from OwlThing
static void	removeOwlThing(OwlThing thing) Remove an OwlThing from the cache of things
void	removeRelation(java.lang.String relationName, OwlThing relatedTo) Removes a relation to from OwlThing's list of relations.
void	removeRelations(java.lang.String relationName) Removes all relations of a given relationship name.
void	removeSameAs(java.lang.String altName) Remove a sameAs reference for a particular object.
static void	replaceRefsToThing(OwlThing oldThing, OwlThing newThing) Replace the references to an object with a different object.
void	setName(java.lang.String thingName) Set the name of this OwlThing.
java.lang.String	toString() Return a string representation of this OwlThing
boolean	validate() Validate this OwlThing.

Methods inherited from class prajna.data.rdf.RdfThing

getName, getUri, isVariableFlag, matches, setUri, setVariableFlag

Methods inherited from class java.lang.Object

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

Method Detail

addDatatypeValue

public boolean addDatatypeValue(java.lang.String datatypeName,
                       RdfDataThing<?> rdfThing)

Add a value for a Datatype property to this OwlThing.

Parameters:

datatypeName - the name of the DatatypeProperty

rdfThing - the value for the property

Returns:

true if the relation was added, false if the relation was already added and the relation list did not change.

addDatatypeValue

public boolean addDatatypeValue(java.lang.String datatypeName,
                       java.lang.String value)

Add a value for a Datatype property to this OwlThing. This method creates an RDF triple with an Explicit type.

Parameters:

datatypeName - the name of the DatatypeProperty

value - the value for the property

Returns:

true if the relation was added, false if the relation was already added and the relation list did not change.

addDatatypeValue

public boolean addDatatypeValue(java.lang.String datatypeName,
                       java.lang.String value,
                       RdfTriple.TripleType relationType)

Add a value for a Datatype property to this OwlThing.

Parameters:

datatypeName - the name of the DatatypeProperty

value - the value for the property

relationType - the type of relation

Returns:

true if the relation was added, false if the relation was already added and the relation list did not change.

addRelation

public boolean addRelation(java.lang.String relationName,
                  OwlThing relatedTo,
                  RdfTriple.TripleType relationType)

Add a relation to this OwlThing, relating it to another OwlThing

Parameters:

relationName - the relationship name. This should be the name of an OwlObjectProperty

relatedTo - the OwlThing this thing is related to

relationType - the type of relation

Returns:

true if the relation was added, false if the relation was already added and the relation list did not change.

addSameAs

public void addSameAs(java.lang.String altName)

Create a sameAs reference for a particular object. If no object exists yet with the specified name, it is linked to this object.

Parameters:

altName - the alternate name for the object

copyValues

public void copyValues(OwlThing otherThing)

Copy explicit properties from another OwlThing to this one. This operation has no effect on the other OwlThing

Parameters:

otherThing - the other OwlThing

delete

public void delete()

Delete this OwlThing from the cache, and remove it from any relations with other objects. Use with care.

deriveValues

public void deriveValues()

Derive all values for this OwlThing. This method calls the OwlClass.setDefinedValues() method on this OwlThing's OwlClass

getAlternateNames

public java.util.Set<java.lang.String> getAlternateNames()

Get the set of names this thing is also known as. This includes all SameAs references

Returns:

the set of alternate names for this thing

getOwlClass

public OwlClass getOwlClass()

Get the OwlClass this OwlThing belongs to.

Returns:

this thing's OwlClass

getRelated

public java.util.Set<OwlThing> getRelated(java.lang.String relationName)

Get all things that are related to this object by the given relationship name or its descendant properties. If the relationName is null, all related objects are returned.

Parameters:

relationName - the relationship name

Returns:

the set of OwlThings that are related to this thing with the given relationship

getRelationships

public java.util.Set<RdfTriple> getRelationships()

Get all relationships that this OwlThing has values for

Returns:

the set of all relationships for this OwlThing

getValues

public java.util.Set<java.lang.String> getValues(java.lang.String propertyName)

Get all string values for the given property for this OwlThing. Never returns null.

Parameters:

propertyName - the property name

Returns:

the values, as strings. For Objects, this returns the names

mergeThing

public void mergeThing(OwlThing owlThing)

Merge another defined thing with this thing

Parameters:

owlThing - the thing to merge

refineClass

public boolean refineClass(OwlClass newCls)

Refine this OwlThing to be a member of the provided class. This method checks to verify if this thing is valid for the new class, and if the existing class is an implied class of the new class. If both of these conditions are true, this thing is refined to be a member of the new class. If the thing can be refined by setting particular values on the object to meet HAS_VALUE restrictions, these are set.

Parameters:

newCls - the new class to refine this object into

Returns:

true if this OwlThing could be refined, false otherwise

removeAllSameAs

public void removeAllSameAs()

Remove all sameAs links to this OwlThing

removeDatatypeValue

public void removeDatatypeValue(java.lang.String propName,
                       java.lang.String value)

Removes a datatype value to from OwlThing

Parameters:

propName - the property name. This should be the name of an OwlDatatypeProperty. If null, this will match all properties.

value - the datatype value to remove

removeRelation

public void removeRelation(java.lang.String relationName,
                  OwlThing relatedTo)

Removes a relation to from OwlThing's list of relations.

Parameters:

relationName - the relationship name. This should be the name of an OwlObjectProperty. If null, this will match all properties.

relatedTo - the OwlThing this thing is related to

removeRelations

public void removeRelations(java.lang.String relationName)

Removes all relations of a given relationship name. This may be used for either OwlObjectProperties or OwlDatatypeProperties

Parameters:

relationName - the relationship name.

removeSameAs

public void removeSameAs(java.lang.String altName)

Remove a sameAs reference for a particular object.

Parameters:

altName - the alternate name for the object

setName

public void setName(java.lang.String thingName)

Set the name of this OwlThing. This leaves the old name in place as a sameAs reference.

Overrides:

setName in class RdfThing

Parameters:

thingName - the thing name

toString

public java.lang.String toString()

Return a string representation of this OwlThing

Overrides:

toString in class RdfThing

Returns:

a string representation of this OwlThing

validate

public boolean validate()

Validate this OwlThing. If this OwlThing has an OwlClass, that class is used to validate this thing. Otherwise, the OwlThing is not valid.

Returns:

true if this OwlThing is valid, false otherwise

addOwlThing

public static void addOwlThing(OwlThing thing)

Add an OwlThing to the cache if it hasn't been added, or if it had been previously removed

Parameters:

thing - the thing to add

clearDefined

public static void clearDefined()

Remove all defined OwlThings from the internal tables

createFromElement

public static OwlThing createFromElement(org.w3c.dom.Element element)

Create an OwlThing from an OWL RDF element. This method retrieves the thing's name from the element, and retrieves or creates an OwlThing with the given name. It then loads the OwlThing definition from the element.

Parameters:

element - the OWL RDF element containing the OwlThing definition

Returns:

the OwlThing created

findOwlThing

public static OwlThing findOwlThing(java.lang.String name)

Find an OwlThing with the given name.

Parameters:

name - the name of the OwlThing

Returns:

the OwlThing with the given name, or null if no such thing exists

getAllThingNames

public static java.util.Set<java.lang.String> getAllThingNames()

Get the names of all OwlThings defined. THis includes all names that are sameAs or aliases

Returns:

all OwlThings that have been created

getAllThings

public static java.util.Set<OwlThing> getAllThings()

Get all OwlThings defined

Returns:

all OwlThings that have been created

getOwlThing

public static OwlThing getOwlThing(java.lang.String name)

Get an OwlThing with the given name. If there is no OwlThing with the given name, one is created.

Parameters:

name - the name of the OwlThing

Returns:

the OwlThing with the given name

getOwlThing

public static OwlThing getOwlThing(java.lang.String name,
                   OwlClass owlClass)

Get an OwlThing with the given name and class. If there is no OwlThing with the given name, one is created. If an OwlThing exists, but is of a different class, it is returned anyway.

Parameters:

name - the name of the OwlThing

owlClass - the class of the OwlThing

Returns:

the OwlThing with the given name

removeOwlThing

public static void removeOwlThing(OwlThing thing)

Remove an OwlThing from the cache of things

Parameters:

thing - the OwlThing to remove

replaceRefsToThing

public static void replaceRefsToThing(OwlThing oldThing,
                      OwlThing newThing)

Replace the references to an object with a different object. Alternately, if the newThing is null, this method simply removes the references to oldThing in all current OwlThings.

Parameters:

oldThing - the old thing to replace

newThing - the new thing