|
| |
|
| com.hp.hpl.jena.ontology.OntProperty
All known Subclasses: com.hp.hpl.jena.ontology.impl.OntPropertyImpl,
| OntProperty | | public interface OntProperty extends OntResource,Property(Code) | |
Interface encapsulating a property in an ontology. This is an extension to the
standard
Property interface, adding a collection of convenience methods
for accessing the additional semantic features of properties in OWL, RDFS and DAML+OIL,
such as domain, range, inverse, etc. Not all such capabilities exist in all
supported ontology languages.
author:
Ian Dickinson, HP Labs
author:
(email)
version:
CVS $Id: OntProperty.java,v 1.21 2008/01/02 12:06:41 andy_seaborne Exp $ |
| addDomain | | public void addDomain(Resource res)(Code) | | Add a resource representing the domain of this property.
Parameters:
res - A resource that represents a domain class for this property.
exception:
OntProfileException - If the Profile.DOMAIN property is not supported in the current language profile. |
| addEquivalentProperty | | public void addEquivalentProperty(Property prop)(Code) | | Add a property that is equivalent to this property.
Parameters:
prop - A property that is equivalent to this property.
exception:
OntProfileException - If the Profile.EQUIVALENT_PROPERTY property is not supported in the current language profile. |
| addInverseOf | | public void addInverseOf(Property prop)(Code) | | Add a property that this property is the inverse of.
Parameters:
prop - A property that is the inverse of this property.
exception:
OntProfileException - If the Profile.INVERSE_OF property is not supported in the current language profile. |
| addRange | | public void addRange(Resource res)(Code) | | Add a resource representing the range of this property. The resource denotes the class
or datatype that objects of statements using this property as predicate should
belong to. For datatype properties, XML Schema Datatype names are pre-declared
as resources in the
com.hp.hpl.jena.vocabulary.XSD XSD vocabulary class. For object properties,
the resource should be represent the range class. Note that
OntClass is
a Java sub-class of
Resource , so OntClass objects can be passed directly.
Parameters:
res - A resource that represents a range class for this property.
exception:
OntProfileException - If the Profile.RANGE property is not supported in the current language profile. |
| addSubProperty | | public void addSubProperty(Property prop)(Code) | | Add a sub-property of this property.
Parameters:
prop - A property that is a sub-property of this property.
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| addSuperProperty | | public void addSuperProperty(Property prop)(Code) | | Add a super-property of this property.
Parameters:
prop - A property that is a super-property of this property.
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| asDatatypeProperty | | public DatatypeProperty asDatatypeProperty()(Code) | | Answer a view of this property as a datatype property
This property, but viewed as a DatatypeProperty node
exception:
ConversionException - if the resource cannot be converted to a datatype propertygiven the language profile and the current state of the underlying model. |
| asFunctionalProperty | | public FunctionalProperty asFunctionalProperty()(Code) | | Answer a view of this property as a functional property
This property, but viewed as a FunctionalProperty node
exception:
ConversionException - if the resource cannot be converted to a functional propertygiven the language profile and the current state of the underlying model. |
| asInverseFunctionalProperty | | public InverseFunctionalProperty asInverseFunctionalProperty()(Code) | | Answer a view of this property as an inverse functional property
This property, but viewed as an InverseFunctionalProperty node
exception:
ConversionException - if the resource cannot be converted to an inverse functional propertygiven the language profile and the current state of the underlying model. |
| asObjectProperty | | public ObjectProperty asObjectProperty()(Code) | | Answer a view of this property as an object property
This property, but viewed as an ObjectProperty node
exception:
ConversionException - if the resource cannot be converted to an object propertygiven the language profile and the current state of the underlying model. |
| asSymmetricProperty | | public SymmetricProperty asSymmetricProperty()(Code) | | Answer a view of this property as a symmetric property
This property, but viewed as a SymmetricProperty node
exception:
ConversionException - if the resource cannot be converted to a symmetric propertygiven the language profile and the current state of the underlying model. |
| asTransitiveProperty | | public TransitiveProperty asTransitiveProperty()(Code) | | Answer a view of this property as a transitive property
This property, but viewed as a TransitiveProperty node
exception:
ConversionException - if the resource cannot be converted to a transitive propertygiven the language profile and the current state of the underlying model. |
| convertToDatatypeProperty | | public DatatypeProperty convertToDatatypeProperty()(Code) | | Answer a facet of this property as a datatype property, adding additional information to the model if necessary.
This property, but converted to a DatatypeProperty facet |
| convertToFunctionalProperty | | public FunctionalProperty convertToFunctionalProperty()(Code) | | Answer a facet of this property as a functional property, adding additional information to the model if necessary.
This property, but converted to a FunctionalProperty facet |
| convertToInverseFunctionalProperty | | public InverseFunctionalProperty convertToInverseFunctionalProperty()(Code) | | Answer a facet of this property as an inverse functional property, adding additional information to the model if necessary.
This property, but converted to an InverseFunctionalProperty facet |
| convertToObjectProperty | | public ObjectProperty convertToObjectProperty()(Code) | | Answer a facet of this property as an object property, adding additional information to the model if necessary.
This property, but converted to an ObjectProperty facet |
| convertToSymmetricProperty | | public SymmetricProperty convertToSymmetricProperty()(Code) | | Answer a facet of this property as a symmetric property, adding additional information to the model if necessary.
This property, but converted to a SymmetricProperty facet |
| convertToTransitiveProperty | | public TransitiveProperty convertToTransitiveProperty()(Code) | | Answer a facet of this property as a transitive property, adding additional information to the model if necessary.
This property, but converted to a TransitiveProperty facet |
| getDomain | | public OntResource getDomain()(Code) | | Answer a resource that represents the domain class of this property. If there is
more than one such resource, an arbitrary selection is made.
An resource representing the class that forms the domain of this property
exception:
OntProfileException - If the Profile.DOMAIN property is not supported in the current language profile. |
| getEquivalentProperty | | public OntProperty getEquivalentProperty()(Code) | | Answer a property that is equivalent to this property. If there is
more than one such property, an arbitrary selection is made.
A property equivalent to this property
exception:
OntProfileException - If the Profile.EQUIVALENT_PROPERTY property is not supported in the current language profile. |
| getInverse | | public OntProperty getInverse()(Code) | | Answer the property that has declared itself to be the inverse of this property,
if any such property is defined.
If no such property is defined,
return null. If more than one inverse is defined, return an abritrary selection.
Note that this method is slightly different from
OntProperty.getInverseOf . Suppose that
we have:
:p an owl:ObjectProperty.
:q an owl:ObjectProperty.
:p owl:inverseOf :q.
Then, getInverse() called on the OntProperty
corresponding to q will return p, since q
declares itself to be p's inverse. However, unless an OWL
reasoner is used, calling getInverse() on p
will return null. Conversely, absent a reasoner,
OntProperty.getInverseOf on p will return q,
but will return null when called on q. In the presence of an OWL
reasoner, getInverse() and getInverseOf() are
equivalent, since owl:inverseOf is a symmetric property.
The property that is the inverse of this property, or null. |
| getInverseOf | | public OntProperty getInverseOf()(Code) | | Answer a property of which this property is the inverse, if known,
or null if there is no such property. If there is
more than one such property, an arbitrary selection is made.
Note that this method is slightly different to
OntProperty.getInverse . See
the Javadoc on
OntProperty.getInverse for a detailed explanation.
A property which this property is the inverse of, or null.
exception:
OntProfileException - If the Profile.INVERSE_OF property is not supported in the current language profile. |
| getRange | | public OntResource getRange()(Code) | | Answer a resource that represents the range class of this property. If there is
more than one such resource, an arbitrary selection is made.
An resource representing the class that forms the range of this property
exception:
OntProfileException - If the Profile.RANGE property is not supported in the current language profile. |
| getSubProperty | | public OntProperty getSubProperty()(Code) | | Answer a property that is the sub-property of this property. If there is
more than one such property, an arbitrary selection is made.
A sub-property of this property
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| getSuperProperty | | public OntProperty getSuperProperty()(Code) | | Answer a property that is the super-property of this property. If there is
more than one such property, an arbitrary selection is made.
A super-property of this property
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| hasDomain | | public boolean hasDomain(Resource res)(Code) | | Answer true if the given resource a class specifying the domain of this property.
Parameters:
res - A resource representing a class True if the given resource is one of the domain classes of this property.
exception:
OntProfileException - If the Profile.DOMAIN property is not supported in the current language profile. |
| hasEquivalentProperty | | public boolean hasEquivalentProperty(Property prop)(Code) | | Answer true if the given property is equivalent to this property.
Parameters:
prop - A property to test for True if the given property is equivalent to this property.
exception:
OntProfileException - If the Profile.EQUIVALENT_PROPERTY property is not supported in the current language profile. |
| hasInverse | | public boolean hasInverse()(Code) | | Answer true if there is at least one inverse property for this property.
True if property has an inverse. |
| hasRange | | public boolean hasRange(Resource res)(Code) | | Answer true if the given resource a class specifying the range of this property.
Parameters:
res - A resource representing a class True if the given resource is one of the range classes of this property.
exception:
OntProfileException - If the Profile.RANGE property is not supported in the current language profile. |
| hasSubProperty | | public boolean hasSubProperty(Property prop, boolean direct)(Code) | | Answer true if the given property is a sub-property of this property.
Parameters:
prop - A property to test.
Parameters:
direct - If true, only consider the directly adjacent properties in theproperty hierarchy True if the given property is a sub-property of this property.
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| hasSuperProperty | | public boolean hasSuperProperty(Property prop, boolean direct)(Code) | | Answer true if the given property is a super-property of this property.
Parameters:
prop - A property to test.
Parameters:
direct - If true, only consider the directly adjacent properties in theproperty hierarchy True if the given property is a super-property of this property.
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| isDatatypeProperty | | public boolean isDatatypeProperty()(Code) | | Answer true if this property is a datatype property
True if this this property has an rdf:type that defines it as a datatype property. |
| isFunctionalProperty | | public boolean isFunctionalProperty()(Code) | | Answer true if this property is a functional property
True if this this property has an rdf:type that defines it as a functional property. |
| isInverseFunctionalProperty | | public boolean isInverseFunctionalProperty()(Code) | | Answer true if this property is an inverse functional property
True if this this property has an rdf:type that defines it as an inverse functional property. |
| isInverseOf | | public boolean isInverseOf(Property prop)(Code) | | Answer true if this property is the inverse of the given property.
Parameters:
prop - A property to test for True if the this property is the inverse of the the given property.
exception:
OntProfileException - If the Profile.INVERSE_OF property is not supported in the current language profile. |
| isObjectProperty | | public boolean isObjectProperty()(Code) | | Answer true if this property is an object property
True if this this property has an rdf:type that defines it as an object property. |
| isSymmetricProperty | | public boolean isSymmetricProperty()(Code) | | Answer true if this property is a symmetric property
True if this this property has an rdf:type that defines it as a symmetric property. |
| isTransitiveProperty | | public boolean isTransitiveProperty()(Code) | | Answer true if this property is a transitive property
True if this this property has an rdf:type that defines it as a transitive property. |
| listDeclaringClasses | | public ExtendedIterator listDeclaringClasses()(Code) | | Answer an iterator of all of the classes in this ontology, such
that each returned class has this property as one of its
properties in
OntClass.listDeclaredProperties . This
simulates a frame-like view of properties and classes; for more
details see the
RDF frames how-to.
An iterator of the classes having this property as oneof their declared properties |
| listDeclaringClasses | | public ExtendedIterator listDeclaringClasses(boolean direct)(Code) | | Answer an iterator of all of the classes in this ontology, such
that each returned class has this property as one of its
properties in
OntClass.listDeclaredProperties(boolean) . This
simulates a frame-like view of properties and classes; for more
details see the
RDF frames how-to.
Parameters:
direct - If true, use only direct associations between classesand properties An iterator of the classes having this property as oneof their declared properties |
| listDomain | | public ExtendedIterator listDomain()(Code) | | Answer an iterator over all of the declared domain classes of this property.
Each element of the iterator will be an
OntResource .
An iterator over the classes that form the domain of this property.
exception:
OntProfileException - If the Profile.DOMAIN property is not supported in the current language profile. |
| listEquivalentProperties | | public ExtendedIterator listEquivalentProperties()(Code) | | 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 .
An iterator over the properties equivalent to this property.
exception:
OntProfileException - If the Profile.EQUIVALENT_PROPERTY property is not supported in the current language profile. |
| listInverse | | public ExtendedIterator listInverse()(Code) | | Answer an iterator over the properties that are defined to be inverses of this property.
An iterator over the properties that declare themselves the inverseOf this property. |
| listInverseOf | | public ExtendedIterator listInverseOf()(Code) | | 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 .
An iterator over the properties inverse to this property.
exception:
OntProfileException - If the Profile.INVERSE_OF property is not supported in the current language profile. |
| listRange | | public ExtendedIterator listRange()(Code) | | Answer an iterator over all of the declared range classes of this property.
Each element of the iterator will be an
OntResource .
An iterator over the classes that form the range of this property.
exception:
OntProfileException - If the Profile.RANGE property is not supported in the current language profile. |
| listReferringRestrictions | | public ExtendedIterator listReferringRestrictions()(Code) | | Answer an iterator over any restrictions that mention this property as
the property that the restriction is adding some constraint to. For example:
<owl:Restriction>
<owl:onProperty rdf:resource="#childOf" />
<owl:hasValue rdf:resource="#ian" />
</owl:Restriction> Note that any such restrictions do not affect the global
semantics of this property itself. Restrictions define new class expressions,
and the property constraints are local to that class expression. This method
is provided as a convenience to assist callers to navigate the relationships
in the model.
An iterator whose values are the restrictions from the localmodel that reference this property. |
| listSubProperties | | public ExtendedIterator listSubProperties()(Code) | | 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 .
An iterator over the sub-properties of this property.
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| listSubProperties | | public ExtendedIterator listSubProperties(boolean direct)(Code) | | 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 directly adjacent properties in theproperty hierarchy: i.e. eliminate any property for which there is a longer routeto reach that child under the sub-property relation. An iterator over the sub-properties of this property.
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| listSuperProperties | | public ExtendedIterator listSuperProperties()(Code) | | 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 .
An iterator over the super-properties of this property.
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| listSuperProperties | | public ExtendedIterator listSuperProperties(boolean direct)(Code) | | 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 directly adjacent properties in theproperty hierarchy: i.e. eliminate any property for which there is a longer routeto reach that child under the super-property relation. An iterator over the super-properties of this property.
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| removeDomain | | public void removeDomain(Resource cls)(Code) | | 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
exception:
OntProfileException - If the Profile.DOMAIN property is not supported in the current language profile. |
| removeEquivalentProperty | | public void removeEquivalentProperty(Property prop)(Code) | | 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
exception:
OntProfileException - If the Profile.EQUIVALENT_PROPERTY property is not supported in the current language profile. |
| removeInverseProperty | | public void removeInverseProperty(Property prop)(Code) | | 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
exception:
OntProfileException - If the Profile.INVERSE_OF property is not supported in the current language profile. |
| removeRange | | public void removeRange(Resource cls)(Code) | | 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
exception:
OntProfileException - If the Profile.RANGE property is not supported in the current language profile. |
| removeSubProperty | | public void removeSubProperty(Property prop)(Code) | | 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
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| removeSuperProperty | | public void removeSuperProperty(Property prop)(Code) | | 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
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| setDomain | | public void setDomain(Resource res)(Code) | | 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.
exception:
OntProfileException - If the Profile.DOMAIN property is not supported in the current language profile. |
| setEquivalentProperty | | public void setEquivalentProperty(Property prop)(Code) | | 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.
exception:
OntProfileException - If the Profile.EQUIVALENT_PROPERTY property is not supported in the current language profile. |
| setInverseOf | | public void setInverseOf(Property prop)(Code) | | 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.
exception:
OntProfileException - If the Profile.INVERSE_OF property is not supported in the current language profile. |
| setRange | | public void setRange(Resource res)(Code) | | 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
first removed. Therefore, if the property is known not to have a range declaration, it
is more efficient to use
OntProperty.addRange since no removal step is necessary.
See
OntProperty.addRange for additional usage notes on the value of res.
Parameters:
res - The resource that represents the range class for this property.
exception:
OntProfileException - If the Profile.RANGE property is not supported in the current language profile. |
| setSubProperty | | public void setSubProperty(Property prop)(Code) | | 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
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
| setSuperProperty | | public void setSuperProperty(Property prop)(Code) | | 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
exception:
OntProfileException - If the Profile.SUB_PROPERTY_OF property is not supported in the current language profile. |
|
|
|