prajna.ontology

Class OwlProperty

java.lang.Object

prajna.data.rdf.Property

prajna.ontology.OwlProperty

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

OwlDatatypeProperty, OwlObjectProperty

public abstract class OwlProperty
extends Property

Abstract class representing a property within an OWL ontology

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OwlProperty() Create an uninitialized OwlProperty
OwlProperty(java.lang.String propName) Construct an OwlProperty with the given name

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	addValueToThing(OwlThing thing, java.lang.String value) Apply the value to this property for the given OwlThing.
java.lang.String	getComment() Get the comment for this OwlProperty, if any.
java.lang.String	getDisplayName() Get the display name for this property.
OwlClass	getDomain() Get the OwlClass domain for this property.
static OwlProperty	getProperty(java.lang.String name) Get the named property.
boolean	isFunctional() Return whether the property is a functional property.
boolean	isInverseFunctional() Return whether the property is an inverse functional property.
void	setComment(java.lang.String newComment) Set the comment for this property
protected void	setDisplayName(java.lang.String display) Set the display name for this property.
void	setDomain(OwlClass domainClass) Set the domain class for this property
void	setFunctional(boolean flag) Set this property as a functional property
void	setInverseFunctional(boolean flag) Set this property as an inverse functional property

Methods inherited from class prajna.data.rdf.Property

addProperty, clearDefined, equals, getName, getParent, getPropertyNames, getUri, hashCode, isDescendant, isDescendant, putProperty, setName, setUri, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

OwlProperty

public OwlProperty()

Create an uninitialized OwlProperty

OwlProperty

public OwlProperty(java.lang.String propName)

Construct an OwlProperty with the given name

Parameters:

propName - the property name

Method Detail

addValueToThing

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

Apply the value to this property for the given OwlThing. Implementations of this method should ensure that the value is a valid value, and that the OwlThing matches the domain for this property.

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.

getComment

public java.lang.String getComment()

Get the comment for this OwlProperty, if any. This corresponds to the rdfs:comment element in the property definition. It is null if not set.

Returns:

the comment for the OwlClass

getDisplayName

public java.lang.String getDisplayName()

Get the display name for this property. The label is usually loaded from a rdfs:label tag in the property definition.

Returns:

the display name or the property name.

getDomain

public OwlClass getDomain()

Get the OwlClass domain for this property. The domain is the OwlClass that can have this property applied to it.

Returns:

the domain class

isFunctional

public boolean isFunctional()

Return whether the property is a functional property. A functional property is one where each Thing with this property can only have a single value

Returns:

true if the property is functional, false otherwise

isInverseFunctional

public boolean isInverseFunctional()

Return whether the property is an inverse functional property. An inverse functional property is one where each value for a property may only be assigned to a single thing, making it a unique key.

Returns:

true if the property is functional, false otherwise

setComment

public void setComment(java.lang.String newComment)

Set the comment for this property

Parameters:

newComment - the comment for the property

setDisplayName

protected void setDisplayName(java.lang.String display)

Set the display name for this property. THe display name is used to

Parameters:

display - the display name

setDomain

public void setDomain(OwlClass domainClass)

Set the domain class for this property

Parameters:

domainClass - the domain class

setFunctional

public void setFunctional(boolean flag)

Set this property as a functional property

Parameters:

flag - true if the property is functional

setInverseFunctional

public void setInverseFunctional(boolean flag)

Set this property as an inverse functional property

Parameters:

flag - true if the property is inverse functional

getProperty

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

Get the named property.

Parameters:

name - the name of the property

Returns:

the named datatype property