prajna.ontology

Class OwlObjectProperty

java.lang.Object

prajna.data.rdf.Property

prajna.ontology.OwlProperty

prajna.ontology.OwlObjectProperty

All Implemented Interfaces:

java.io.Serializable

public class OwlObjectProperty
extends OwlProperty

Representation of an Object property of an OwlClass. This class provides methods to set the property on an OwlThing, hooks for creating object properties, and property relationships.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OwlObjectProperty(java.lang.String name) Create a new OwlObjectProperty
OwlObjectProperty(java.lang.String name, OwlClass propDomain, OwlClass propRange) Create a new OwlObjectProperty with the specified domain and range.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addValueToThing(OwlThing thing, java.lang.String value) Apply the value to this property for the given OwlThing.
boolean	buildRelation(OwlThing owlThing, OwlThing related, RdfTriple.TripleType relationType) Build the relationship for this property for the OwlThings.
static OwlObjectProperty	createFromElement(org.w3c.dom.Element element) Create a property from an OWL RDF object property element.
OwlObjectProperty	getInverse() Get the inverse property for this property
Property	getParent() Get the parent Object property, if any, for this property
static OwlObjectProperty	getProperty(java.lang.String name) Get the Object property from the internal map of properties
static java.util.Set<java.lang.String>	getPropertyNames() Get the list of ObjectProperty names
OwlClass	getRange() Get the range for this Object Property.
boolean	isSymmetric() Return whether this ObjectProperty is symmetric
boolean	isTransitive() Return whether this ObjectProperty is transitive
void	removeRelation(OwlThing owlThing, OwlThing related) Removes the relationship for this property for the OwlThings.
void	setInverse(OwlObjectProperty inverseProperty) Set the inverse property.
void	setName(java.lang.String propName) Set the name of this object property
void	setParent(OwlObjectProperty prop) Set the parent for this property
void	setRange(OwlClass owlCls) Set the range for this property
void	setSymmetric(boolean flag) Set whether this property is symmetric
void	setTransitive(boolean flag) Set whether this property is transitive

Methods inherited from class prajna.ontology.OwlProperty

getComment, getDisplayName, getDomain, isFunctional, isInverseFunctional, setComment, setDisplayName, setDomain, setFunctional, setInverseFunctional

Methods inherited from class prajna.data.rdf.Property

addProperty, clearDefined, equals, getName, getUri, hashCode, isDescendant, isDescendant, putProperty, setUri, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OwlObjectProperty

public OwlObjectProperty(java.lang.String name)

Create a new OwlObjectProperty

Parameters:

name - the property name

OwlObjectProperty

public OwlObjectProperty(java.lang.String name,
                 OwlClass propDomain,
                 OwlClass propRange)

Create a new OwlObjectProperty with the specified domain and range.

Parameters:

name - property name

propDomain - the domain for the property

propRange - the range for the property

Method Detail

addValueToThing

public boolean addValueToThing(OwlThing thing,
                      java.lang.String value)

Apply the value to this property for the given OwlThing. This implementation ensures that the thing matches the domain for this property, and that the value is a valid element for the range.

Specified by:

addValueToThing in class OwlProperty

Parameters:

thing - The OwlThing to apply the property to.

value - The value for this property

Returns:

true if the value could be set, false if the value is not valid for this property.

buildRelation

public boolean buildRelation(OwlThing owlThing,
                    OwlThing related,
                    RdfTriple.TripleType relationType)

Build the relationship for this property for the OwlThings. This method assigns the related OwlThing as the value of this object property for the OwlThing owlThing. This method also sets any properties on objects due to symmetric or transitive relationships. If there is an inverse property, this method also sets the inverse property on the related OwlThing.

Parameters:

owlThing - the thing to set the property for

related - the thing to set as the value for this property.

relationType - the base relationship type

Returns:

true if the relationship was added, false otherwise

getInverse

public OwlObjectProperty getInverse()

Get the inverse property for this property

Returns:

the inverse property

getParent

public Property getParent()

Get the parent Object property, if any, for this property

Overrides:

getParent in class Property

Returns:

the parent property

getRange

public OwlClass getRange()

Get the range for this Object Property. The range is the class that can be assigned as values for this object property.

Returns:

the range

isSymmetric

public boolean isSymmetric()

Return whether this ObjectProperty is symmetric

Returns:

true if the property is symmetric, false otherwise

isTransitive

public boolean isTransitive()

Return whether this ObjectProperty is transitive

Returns:

true if the property is transitive, false otherwise

removeRelation

public void removeRelation(OwlThing owlThing,
                  OwlThing related)

Removes the relationship for this property for the OwlThings. This method removes the related OwlThing as a value of this object property for the OwlThing owlThing. This method also removes any properties on objects due to symmetric relationships. If there is an inverse property, this method also removes the inverse property on the related OwlThing.

Parameters:

owlThing - the thing to set the property for

related - the thing to set as the value for this property.

setInverse

public void setInverse(OwlObjectProperty inverseProperty)

Set the inverse property. The inverse property is an object property which is the reverse relationship of this one. For instance, X isChildOf Y could have an inverse property of Y isParentOf X.

Parameters:

inverseProperty - the inverse object property

setName

public void setName(java.lang.String propName)

Set the name of this object property

Overrides:

setName in class Property

Parameters:

propName - the property name

setParent

public void setParent(OwlObjectProperty prop)

Set the parent for this property

Parameters:

prop - the parent property

setRange

public void setRange(OwlClass owlCls)

Set the range for this property

Parameters:

owlCls - the range for the property

setSymmetric

public void setSymmetric(boolean flag)

Set whether this property is symmetric

Parameters:

flag - flag indicating a symmetric property

setTransitive

public void setTransitive(boolean flag)

Set whether this property is transitive

Parameters:

flag - flag indicating a transitive property

createFromElement

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

Create a property from an OWL RDF object property element. This method creates the property parameters and configuration from an owl:ObjectProperty element.

Parameters:

element - the element containing the object property parameters.

Returns:

the property created or augmented

getProperty

public static OwlObjectProperty getProperty(java.lang.String name)

Get the Object property from the internal map of properties

Parameters:

name - the name of the property

Returns:

the Object property

getPropertyNames

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

Get the list of ObjectProperty names

Returns:

the set of ObjectProperty names currently loaded