com.hp.hpl.jena.ontology
Interface OntProperty

All Superinterfaces:

OntResource, Property, RDFNode, Resource

All Known Subinterfaces:

DatatypeProperty, FunctionalProperty, InverseFunctionalProperty, ObjectProperty, SymmetricProperty, TransitiveProperty

public interface OntProperty

extends OntResource, Property

Interface encapsulating a property in an ontology.

Version:

CVS $Id: OntProperty.java,v 1.11 2003/06/21 13:04:01 ian_dickinson Exp $

Author:

Ian Dickinson, HP Labs (email)

Method Summary

void	addDomain(Resource res) Add a resource representing the domain of this property.
void	addEquivalentProperty(Property prop) Add a property that is equivalent to this property.
void	addInverseOf(Property prop) Add a property that this property is the inverse of.
void	addRange(Resource res) Add a resource representing the range of this property.
void	addSubProperty(Property prop) Add a sub-property of this property.
void	addSuperProperty(Property prop) Add a super-property of this property.
DatatypeProperty	asDatatypeProperty() Answer a view of this property as a datatype property
FunctionalProperty	asFunctionalProperty() Answer a view of this property as a functional property
InverseFunctionalProperty	asInverseFunctionalProperty() Answer a view of this property as an inverse functional property
ObjectProperty	asObjectProperty() Answer a view of this property as an object property
SymmetricProperty	asSymmetricProperty() Answer a view of this property as a symmetric property
TransitiveProperty	asTransitiveProperty() Answer a view of this property as a transitive property
DatatypeProperty	convertToDatatypeProperty() Answer a facet of this property as a datatype property, adding additional information to the model if necessary.
FunctionalProperty	convertToFunctionalProperty() Answer a facet of this property as a functional property, adding additional information to the model if necessary.
InverseFunctionalProperty	convertToInverseFunctionalProperty() Answer a facet of this property as an inverse functional property, adding additional information to the model if necessary.
ObjectProperty	convertToObjectProperty() Answer a facet of this property as an object property, adding additional information to the model if necessary.
SymmetricProperty	convertToSymmetricProperty() Answer a facet of this property as a symmetric property, adding additional information to the model if necessary.
TransitiveProperty	convertToTransitiveProperty() Answer a facet of this property as a transitive property, adding additional information to the model if necessary.
OntResource	getDomain() Answer a resource that represents the domain class of this property.
OntProperty	getEquivalentProperty() Answer a property that is equivalent to this property.
OntProperty	getInverse() Answer the property that is the inverse of this property.
OntProperty	getInverseOf() Answer a property of which this property is the inverse.
OntResource	getRange() Answer a resource that represents the range class of this property.
OntProperty	getSubProperty() Answer a property that is the sub-property of this property.
OntProperty	getSuperProperty() Answer a property that is the super-property of this property.
boolean	hasDomain(Resource res) Answer true if the given resource a class specifying the domain of this property.
boolean	hasEquivalentProperty(Property prop) Answer true if the given property is equivalent to this property.
boolean	hasInverse() Answer true if there is at least one inverse property for this property.
boolean	hasRange(Resource res) Answer true if the given resource a class specifying the range of this property.
boolean	hasSubProperty(Property prop, boolean direct) Answer true if the given property is a sub-property of this property.
boolean	hasSuperProperty(Property prop, boolean direct) Answer true if the given property is a super-property of this property.
boolean	isDatatypeProperty() Answer true if this property is a datatype property
boolean	isFunctionalProperty() Answer true if this property is a functional property
boolean	isInverseFunctionalProperty() Answer true if this property is an inverse functional property
boolean	isInverseOf(Property prop) Answer true if this property is the inverse of the given property.
boolean	isObjectProperty() Answer true if this property is an object property
boolean	isSymmetricProperty() Answer true if this property is a symmetric property
boolean	isTransitiveProperty() Answer true if this property is a transitive property
ExtendedIterator	listDomain() Answer an iterator over all of the declared domain classes of this property.
ExtendedIterator	listEquivalentProperties() Answer an iterator over all of the properties that are declared to be equivalent properties to this property.
ExtendedIterator	listInverse() Answer an iterator over the properties that are defined to be inverses of this property.
ExtendedIterator	listInverseOf() Answer an iterator over all of the properties that this property is declared to be the inverse of.
ExtendedIterator	listRange() Answer an iterator over all of the declared range classes of this property.
ExtendedIterator	listSubProperties() Answer an iterator over all of the properties that are declared to be sub-properties of this property.
ExtendedIterator	listSubProperties(boolean direct) Answer an iterator over all of the properties that are declared to be sub-properties of this property.
ExtendedIterator	listSuperProperties() Answer an iterator over all of the properties that are declared to be super-properties of this property.
ExtendedIterator	listSuperProperties(boolean direct) Answer an iterator over all of the properties that are declared to be super-properties of this property.
void	removeDomain(Resource cls) Remove the given class from the stated domain(s) of this property.
void	removeEquivalentProperty(Property prop) Remove the statement that this property and the given property are equivalent.
void	removeInverseProperty(Property prop) Remove the statement that this property is the inverse of the given property.
void	removeRange(Resource cls) Remove the given class from the stated range(s) of this property.
void	removeSubProperty(Property prop) Remove the given property from the sub-properties of this property.
void	removeSuperProperty(Property prop) Remove the given property from the super-properties of this property.
void	setDomain(Resource res) Assert that the given resource represents the class of individuals that form the domain of this property.
void	setEquivalentProperty(Property prop) Assert that the given property is equivalent to this property.
void	setInverseOf(Property prop) Assert that this property is the inverse of the given property.
void	setRange(Resource res) Assert that the given resource represents the class of individuals that form the range of this property.
void	setSubProperty(Property prop) Assert that this property is super-property of the given property.
void	setSuperProperty(Property prop) Assert that this property is sub-property of the given property.

Methods inherited from interface com.hp.hpl.jena.ontology.OntResource

accessor, accessor, addComment, addComment, addDifferentFrom, addIsDefinedBy, addLabel, addLabel, addRDFType, addSameAs, addSeeAlso, addVersionInfo, asAllDifferent, asAnnotationProperty, asClass, asIndividual, asOntology, asProperty, getCardinality, getComment, getDifferentFrom, getIsDefinedBy, getLabel, getProfile, getPropertyValue, getRDFType, getRDFType, getSameAs, getSeeAlso, getVersionInfo, hasComment, hasComment, hasLabel, hasLabel, hasRDFType, hasRDFType, hasRDFType, hasSeeAlso, hasVersionInfo, isDefinedBy, isDifferentFrom, isSameAs, listComments, listDifferentFrom, listIsDefinedBy, listLabels, listPropertyValues, listRDFTypes, listSameAs, listSeeAlso, listVersionInfo, remove, removeComment, removeComment, removeDefinedBy, removeDifferentFrom, removeLabel, removeLabel, removeProperty, removeRDFType, removeSameAs, removeSeeAlso, removeVersionInfo, setComment, setDifferentFrom, setIsDefinedBy, setLabel, setPropertyValue, setRDFType, setSameAs, setSeeAlso, setVersionInfo

Methods inherited from interface com.hp.hpl.jena.rdf.model.Resource

abort, addProperty, addProperty, addProperty, addProperty, addProperty, addProperty, addProperty, addProperty, addProperty, begin, commit, equals, getId, getLocalName, getModel, getNameSpace, getNode, getProperty, getURI, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, isAnon, listProperties, listProperties, removeAll, removeProperties, toString

Methods inherited from interface com.hp.hpl.jena.rdf.model.RDFNode

as, asNode, canAs, inModel, visitWith

Methods inherited from interface com.hp.hpl.jena.rdf.model.Property

getLocalName, getNameSpace, getOrdinal, isProperty

Method Detail

setSuperProperty

public void setSuperProperty(Property prop)

Assert that this property is sub-property of the given property. Any existing statements for subPropertyOf will be removed.

Parameters:

prop - The property that this property is a sub-property of

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

addSuperProperty

public void addSuperProperty(Property prop)

Add a super-property of this property.

Parameters:

prop - A property that is a super-property of this property.

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

getSuperProperty

public OntProperty getSuperProperty()

Answer a property that is the super-property of this property. If there is more than one such property, an arbitrary selection is made.

Returns:

A super-property of this property

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

listSuperProperties

public ExtendedIterator listSuperProperties()

Answer an iterator over all of the properties that are declared to be super-properties of this property. Each element of the iterator will be an OntProperty.

Returns:

An iterator over the super-properties of this property.

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

listSuperProperties

public ExtendedIterator listSuperProperties(boolean direct)

Answer an iterator over all of the properties that are declared to be super-properties of this property. Each element of the iterator will be an OntProperty.

Parameters:

direct - If true, only answer the direcly adjacent properties in the property hierarchy: i.e. eliminate any property for which there is a longer route to reach that child under the super-property relation.

Returns:

An iterator over the super-properties of this property.

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

hasSuperProperty

public boolean hasSuperProperty(Property prop,
                                boolean direct)

Answer true if the given property is a super-property of this property.

Parameters:

prop - A property to test.

direct - If true, only consider the direcly adjacent properties in the property hierarchy

Returns:

True if the given property is a super-property of this property.

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

removeSuperProperty

public void removeSuperProperty(Property prop)

Remove the given property from the super-properties of this property. If this statement is not true of the current model, nothing happens.

Parameters:

prop - A property to be removed from the super-properties of this property

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

setSubProperty

public void setSubProperty(Property prop)

Assert that this property is super-property of the given property. Any existing statements for subPropertyOf on prop will be removed.

Parameters:

prop - The property that is a sub-property of this property

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

addSubProperty

public void addSubProperty(Property prop)

Add a sub-property of this property.

Parameters:

prop - A property that is a sub-property of this property.

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

getSubProperty

public OntProperty getSubProperty()

Answer a property that is the sub-property of this property. If there is more than one such property, an arbitrary selection is made.

Returns:

A sub-property of this property

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

listSubProperties

public ExtendedIterator listSubProperties()

Answer an iterator over all of the properties that are declared to be sub-properties of this property. Each element of the iterator will be an OntProperty.

Returns:

An iterator over the sub-properties of this property.

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

listSubProperties

public ExtendedIterator listSubProperties(boolean direct)

Answer an iterator over all of the properties that are declared to be sub-properties of this property. Each element of the iterator will be an OntProperty.

Parameters:

direct - If true, only answer the direcly adjacent properties in the property hierarchy: i.e. eliminate any property for which there is a longer route to reach that child under the sub-property relation.

Returns:

An iterator over the sub-properties of this property.

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

hasSubProperty

public boolean hasSubProperty(Property prop,
                              boolean direct)

Answer true if the given property is a sub-property of this property.

Parameters:

prop - A property to test.

direct - If true, only consider the direcly adjacent properties in the property hierarchy

Returns:

True if the given property is a sub-property of this property.

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

removeSubProperty

public void removeSubProperty(Property prop)

Remove the given property from the sub-properties of this property. If this statement is not true of the current model, nothing happens.

Parameters:

prop - A property to be removed from the sub-properties of this property

Throws:

OntProfileException - If the Profile.SUB_PROPERTY_OF() property is not supported in the current language profile.

setDomain

public void setDomain(Resource res)

Assert that the given resource represents the class of individuals that form the domain of this property. Any existing domain statements for this property are removed.

Parameters:

res - The resource that represents the domain class for this property.

Throws:

OntProfileException - If the Profile.DOMAIN() property is not supported in the current language profile.

addDomain

public void addDomain(Resource res)

Add a resource representing the domain of this property.

Parameters:

res - A resource that represents a domain class for this property.

Throws:

OntProfileException - If the Profile.DOMAIN() property is not supported in the current language profile.

getDomain

public OntResource getDomain()

Answer a resource that represents the domain class of this property. If there is more than one such resource, an arbitrary selection is made.

Returns:

An resource representing the class that forms the domain of this property

Throws:

OntProfileException - If the Profile.DOMAIN() property is not supported in the current language profile.

listDomain

public ExtendedIterator listDomain()

Answer an iterator over all of the declared domain classes of this property. Each element of the iterator will be an OntResource.

Returns:

An iterator over the classes that form the domain of this property.

Throws:

OntProfileException - If the Profile.DOMAIN() property is not supported in the current language profile.

hasDomain

public boolean hasDomain(Resource res)

Answer true if the given resource a class specifying the domain of this property.

Parameters:

res - A resource representing a class

Returns:

True if the given resource is one of the domain classes of this property.

Throws:

OntProfileException - If the Profile.DOMAIN() property is not supported in the current language profile.

removeDomain

public void removeDomain(Resource cls)

Remove the given class from the stated domain(s) of this property. If this statement is not true of the current model, nothing happens.

Parameters:

cls - A class to be removed from the declared domain(s) of this property

Throws:

OntProfileException - If the Profile.DOMAIN() property is not supported in the current language profile.

setRange

public void setRange(Resource res)

Assert that the given resource represents the class of individuals that form the range of this property. Any existing range statements for this property are removed.

Parameters:

res - The resource that represents the range class for this property.

Throws:

OntProfileException - If the Profile.RANGE() property is not supported in the current language profile.

addRange

public void addRange(Resource res)

Add a resource representing the range of this property.

Parameters:

res - A resource that represents a range class for this property.

Throws:

OntProfileException - If the Profile.RANGE() property is not supported in the current language profile.

getRange

public OntResource getRange()

Answer a resource that represents the range class of this property. If there is more than one such resource, an arbitrary selection is made.

Returns:

An resource representing the class that forms the range of this property

Throws:

OntProfileException - If the Profile.RANGE() property is not supported in the current language profile.

listRange

public ExtendedIterator listRange()

Answer an iterator over all of the declared range classes of this property. Each element of the iterator will be an OntResource.

Returns:

An iterator over the classes that form the range of this property.

Throws:

OntProfileException - If the Profile.RANGE() property is not supported in the current language profile.

hasRange

public boolean hasRange(Resource res)

Answer true if the given resource a class specifying the range of this property.

Parameters:

res - A resource representing a class

Returns:

True if the given resource is one of the range classes of this property.

Throws:

OntProfileException - If the Profile.RANGE() property is not supported in the current language profile.

removeRange

public void removeRange(Resource cls)

Remove the given class from the stated range(s) of this property. If this statement is not true of the current model, nothing happens.

Parameters:

cls - A class to be removed from the declared range(s) of this property

Throws:

OntProfileException - If the Profile.RANGE() property is not supported in the current language profile.

setEquivalentProperty

public void setEquivalentProperty(Property prop)

Assert that the given property is equivalent to this property. Any existing statements for equivalentProperty will be removed.

Parameters:

prop - The property that this property is a equivalent to.

Throws:

OntProfileException - If the Profile.EQUIVALENT_PROPERTY() property is not supported in the current language profile.

addEquivalentProperty

public void addEquivalentProperty(Property prop)

Add a property that is equivalent to this property.

Parameters:

prop - A property that is equivalent to this property.

Throws:

OntProfileException - If the Profile.EQUIVALENT_PROPERTY() property is not supported in the current language profile.

getEquivalentProperty

public OntProperty getEquivalentProperty()

Answer a property that is equivalent to this property. If there is more than one such property, an arbitrary selection is made.

Returns:

A property equivalent to this property

Throws:

OntProfileException - If the Profile.EQUIVALENT_PROPERTY() property is not supported in the current language profile.

listEquivalentProperties

public ExtendedIterator listEquivalentProperties()

Answer an iterator over all of the properties that are declared to be equivalent properties to this property. Each element of the iterator will be an OntProperty.

Returns:

An iterator over the properties equivalent to this property.

Throws:

OntProfileException - If the Profile.EQUIVALENT_PROPERTY() property is not supported in the current language profile.

hasEquivalentProperty

public boolean hasEquivalentProperty(Property prop)

Answer true if the given property is equivalent to this property.

Parameters:

prop - A property to test for

Returns:

True if the given property is equivalent to this property.

Throws:

OntProfileException - If the Profile.EQUIVALENT_PROPERTY() property is not supported in the current language profile.

removeEquivalentProperty

public void removeEquivalentProperty(Property prop)

Remove the statement that this property and the given property are equivalent. If this statement is not true of the current model, nothing happens.

Parameters:

prop - A property that may be declared to be equivalent to this property

Throws:

OntProfileException - If the Profile.EQUIVALENT_PROPERTY() property is not supported in the current language profile.

setInverseOf

public void setInverseOf(Property prop)

Assert that this property is the inverse of the given property. Any existing statements for inverseOf will be removed.

Parameters:

prop - The property that this property is a inverse to.

Throws:

OntProfileException - If the Profile.INVERSE_OF() property is not supported in the current language profile.

addInverseOf

public void addInverseOf(Property prop)

Add a property that this property is the inverse of.

Parameters:

prop - A property that is the inverse of this property.

Throws:

OntProfileException - If the Profile.INVERSE_OF() property is not supported in the current language profile.

getInverseOf

public OntProperty getInverseOf()

Answer a property of which this property is the inverse. If there is more than one such property, an arbitrary selection is made.

Returns:

A property inverse to this property

Throws:

OntProfileException - If the Profile.INVERSE_OF() property is not supported in the current language profile.

listInverseOf

public ExtendedIterator listInverseOf()

Answer an iterator over all of the properties that this property is declared to be the inverse of. Each element of the iterator will be an OntProperty.

Returns:

An iterator over the properties inverse to this property.

Throws:

OntProfileException - If the Profile.INVERSE_OF() property is not supported in the current language profile.

isInverseOf

public boolean isInverseOf(Property prop)

Answer true if this property is the inverse of the given property.

Parameters:

prop - A property to test for

Returns:

True if the this property is the inverse of the the given property.

Throws:

OntProfileException - If the Profile.INVERSE_OF() property is not supported in the current language profile.

removeInverseProperty

public void removeInverseProperty(Property prop)

Remove the statement that this property is the inverse of the given property. If this statement is not true of the current model, nothing happens.

Parameters:

prop - A property that may be declared to be inverse to this property

Throws:

OntProfileException - If the Profile.INVERSE_OF() property is not supported in the current language profile.

asFunctionalProperty

public FunctionalProperty asFunctionalProperty()

Answer a view of this property as a functional property

Returns:

This property, but viewed as a FunctionalProperty node

Throws:

ConversionException - if the resource cannot be converted to a functional property given the lanuage profile and the current state of the underlying model.

asDatatypeProperty

public DatatypeProperty asDatatypeProperty()

Answer a view of this property as a datatype property

Returns:

This property, but viewed as a DatatypeProperty node

Throws:

ConversionException - if the resource cannot be converted to a datatype property given the lanuage profile and the current state of the underlying model.

asObjectProperty

public ObjectProperty asObjectProperty()

Answer a view of this property as an object property

Returns:

This property, but viewed as an ObjectProperty node

Throws:

ConversionException - if the resource cannot be converted to an object property given the lanuage profile and the current state of the underlying model.

asTransitiveProperty

public TransitiveProperty asTransitiveProperty()

Answer a view of this property as a transitive property

Returns:

This property, but viewed as a TransitiveProperty node

Throws:

ConversionException - if the resource cannot be converted to a transitive property given the lanuage profile and the current state of the underlying model.

asInverseFunctionalProperty

public InverseFunctionalProperty asInverseFunctionalProperty()

Answer a view of this property as an inverse functional property

Returns:

This property, but viewed as an InverseFunctionalProperty node

Throws:

ConversionException - if the resource cannot be converted to an inverse functional property given the lanuage profile and the current state of the underlying model.

asSymmetricProperty

public SymmetricProperty asSymmetricProperty()

Answer a view of this property as a symmetric property

Returns:

This property, but viewed as a SymmetricProperty node

Throws:

ConversionException - if the resource cannot be converted to a symmetric property given the lanuage profile and the current state of the underlying model.

convertToFunctionalProperty

public FunctionalProperty convertToFunctionalProperty()

Answer a facet of this property as a functional property, adding additional information to the model if necessary.

Returns:

This property, but converted to a FunctionalProperty facet

convertToDatatypeProperty

public DatatypeProperty convertToDatatypeProperty()

Answer a facet of this property as a datatype property, adding additional information to the model if necessary.

Returns:

This property, but converted to a DatatypeProperty facet

convertToObjectProperty

public ObjectProperty convertToObjectProperty()

Answer a facet of this property as an object property, adding additional information to the model if necessary.

Returns:

This property, but converted to an ObjectProperty facet

convertToTransitiveProperty

public TransitiveProperty convertToTransitiveProperty()

Answer a facet of this property as a transitive property, adding additional information to the model if necessary.

Returns:

This property, but converted to a TransitiveProperty facet

convertToInverseFunctionalProperty

public InverseFunctionalProperty convertToInverseFunctionalProperty()

Answer a facet of this property as an inverse functional property, adding additional information to the model if necessary.

Returns:

This property, but converted to an InverseFunctionalProperty facet

convertToSymmetricProperty

public SymmetricProperty convertToSymmetricProperty()

Answer a facet of this property as a symmetric property, adding additional information to the model if necessary.

Returns:

This property, but converted to a SymmetricProperty facet

isFunctionalProperty

public boolean isFunctionalProperty()

Answer true if this property is a functional property

Returns:

True if this this property has an rdf:type that defines it as a functional property.

isDatatypeProperty

public boolean isDatatypeProperty()

Answer true if this property is a datatype property

Returns:

True if this this property has an rdf:type that defines it as a datatype property.

isObjectProperty

public boolean isObjectProperty()

Answer true if this property is an object property

Returns:

True if this this property has an rdf:type that defines it as an object property.

isTransitiveProperty

public boolean isTransitiveProperty()

Answer true if this property is a transitive property

Returns:

True if this this property has an rdf:type that defines it as a transitive property.

isInverseFunctionalProperty

public boolean isInverseFunctionalProperty()

Answer true if this property is an inverse functional property

Returns:

True if this this property has an rdf:type that defines it as an inverse functional property.

isSymmetricProperty

public boolean isSymmetricProperty()

Answer true if this property is a symmetric property

Returns:

True if this this property has an rdf:type that defines it as a symmetric property.

getInverse

public OntProperty getInverse()

Answer the property that is the inverse of this property. If no such property is defined, return null. If more than one inverse is defined, return an abritrary selection.

Returns:

The property that is the inverse of this property, or null.

listInverse

public ExtendedIterator listInverse()

Answer an iterator over the properties that are defined to be inverses of this property.

Returns:

An iterator over the properties that declare themselves the inverseOf this property.

hasInverse

public boolean hasInverse()

Answer true if there is at least one inverse property for this property.

Returns:

True if property has an inverse.