prajna.ontology

Class OwlRestriction

java.lang.Object

prajna.ontology.OwlRestriction

All Implemented Interfaces:

Validating

public class OwlRestriction
extends java.lang.Object
implements Validating

Class representing an Owl restriction. An OwlRestriction may be one of several types. The restriction defines what objects may be assigned to a particular property for a particular class.

Author:

Edward Swing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OwlRestriction.ValueRange Restriction type enumeration.

Constructor Summary

Constructors

Constructor and Description
OwlRestriction(org.w3c.dom.Element element) Create a DataType property from an owl:Restriction Element.
OwlRestriction(java.lang.String propertyName, OwlRestriction.ValueRange resType, java.util.Set<java.lang.String> values) Create a restriction from a property name, type, and range of values

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAssign(OwlThing owlThing, java.lang.String value) Determine whether the OwlThing can be assigned the value for the property associated with this restriction.
OwlRestriction	getInverse() Create a restriction which is the inverse of this restriction.
int	getMaxCardinality() Get the maximum cardinality for this restriction.
int	getMinCardinality() Get the minimum cardinality for this restriction.
java.lang.String	getPropertyName() Get the name of the property this restriction applies to.
OwlRestriction	getRangeRestriction() Get a restriction which applies to the allowed values.
OwlRestriction.ValueRange	getRangeType() Return the type of restriction
OwlClass	getRestrictionClass() Get the class of objects this restriction restricts the values to.
java.util.Set<java.lang.String>	getValues() Get the set of values which the property can take.
boolean	isInEquivalence() Return whether this restriction is in an equivalence clause for its containing OwlClass
boolean	isValid(OwlThing owlThing) Determine whether the specified OwlThing conforms to this restriction.
boolean	isValidProperty(java.lang.String propertyName, OwlThing owlThing) Determines whether the given OwlThing may be assigned to the property in a valid way according to this restriction.
void	setInEquivalence(boolean equivFlag) Set whether this restriction is in an equivalence clause
java.lang.String	toString() Return a string representation of this OwlRestriction

Methods inherited from class java.lang.Object

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

Constructor Detail

OwlRestriction

public OwlRestriction(org.w3c.dom.Element element)

Create a DataType property from an owl:Restriction Element. The element must conform to the OWL RDF schema.

Parameters:

element - the restriction element

OwlRestriction

public OwlRestriction(java.lang.String propertyName,
              OwlRestriction.ValueRange resType,
              java.util.Set<java.lang.String> values)

Create a restriction from a property name, type, and range of values

Parameters:

propertyName - the property name

resType - the restriction type

values - the range of values allowed

Method Detail

canAssign

public boolean canAssign(OwlThing owlThing,
                java.lang.String value)

Determine whether the OwlThing can be assigned the value for the property associated with this restriction. The check determines whether adding the value to the list of values for the property would still allow the OwlThing to meet the criteria for this restriction.

Parameters:

owlThing - the OwlThing to check

value - the value for the property

Returns:

true if the OwlThing can be assigned the provided value, false otherwise

getInverse

public OwlRestriction getInverse()

Create a restriction which is the inverse of this restriction.

Returns:

the restriction which is the inverse of this one.

getMaxCardinality

public int getMaxCardinality()

Get the maximum cardinality for this restriction. If not set, the maximum cardinality is set to -1

Returns:

the minimum cardinality

getMinCardinality

public int getMinCardinality()

Get the minimum cardinality for this restriction. If not set, the minimum cardinality is set to -1

Returns:

the minimum cardinality

getPropertyName

public java.lang.String getPropertyName()

Get the name of the property this restriction applies to.

Returns:

the property name

getRangeRestriction

public OwlRestriction getRangeRestriction()

Get a restriction which applies to the allowed values. The Range Restriction essentially defines a restriction that any valid value must obey.

Returns:

the range restriction

getRangeType

public OwlRestriction.ValueRange getRangeType()

Return the type of restriction

Returns:

the type of restriction

getRestrictionClass

public OwlClass getRestrictionClass()

Get the class of objects this restriction restricts the values to. If this restriction is a HAS_VALUE restriction, the OwlClass returned by this method is the class of the specified value. Typically, either a restriction class or a list of values are specified for a restriction.

Returns:

the restriction class

getValues

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

Get the set of values which the property can take. This method returns a list of OwlThing values for the property. If the restriction class was not specified with a list of values, this method returns the empty set. Typically, either a restriction class or a list of values are specified for a restriction.

Returns:

the set of valid values, or the empty set

isInEquivalence

public boolean isInEquivalence()

Return whether this restriction is in an equivalence clause for its containing OwlClass

Returns:

true if the restriction is in an equivalence clause, false otherwise

isValid

public boolean isValid(OwlThing owlThing)

Determine whether the specified OwlThing conforms to this restriction. This method checks the values assigned to the restriction property field. If the values conform to the restriction limits, the thing is valid.

Specified by:

isValid in interface Validating

Parameters:

owlThing - the OwlThing to check

Returns:

true if the OwlThing is completely valid, false otherwise.

isValidProperty

public boolean isValidProperty(java.lang.String propertyName,
                      OwlThing owlThing)

Determines whether the given OwlThing may be assigned to the property in a valid way according to this restriction. If the property name matches the restriction property name, and the value is allowed by the restriction parameters, the property assignment is valid.

Specified by:

isValidProperty in interface Validating

Parameters:

propertyName - the name of the property

owlThing - the OwlThing to test for assignment to the property

Returns:

true if the property assignment is valid, false otherwise

setInEquivalence

public void setInEquivalence(boolean equivFlag)

Set whether this restriction is in an equivalence clause

Parameters:

equivFlag - the equivalence clause flag

toString

public java.lang.String toString()

Return a string representation of this OwlRestriction

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this restriction