com.hp.hpl.jena.ontology.daml
Interface DAMLProperty

All Superinterfaces:
DAMLCommon, FrontsNode, OntProperty, OntResource, Property, RDFNode, Resource
All Known Subinterfaces:
DAMLDatatypeProperty, DAMLObjectProperty

public interface DAMLProperty
extends DAMLCommon, OntProperty

Encapsulates a property in a DAML ontology. According to the specification, a daml:Property is an alias for rdf:Property. It also acts as the super-class for more semantically meaningful property classes: datatype properties and object properties. The DAML spec also allows any property to be unique (that is, it defines UniqueProperty as a sub-class of Property), so uniqueness is modelled here as an attribute of a DAMLProperty.

Version:
CVS info: $Id: DAMLProperty.java,v 1.7 2004/12/06 13:50:18 andy_seaborne Exp $
Author:
Ian Dickinson, HP Labs (email)

Method Summary
 ExtendedIterator getDomainClasses()
          Answer an iterator over all of the DAML classes that form the domain of this property.
 ExtendedIterator getEquivalentValues()
          Answer an iterator over all of the DAML objects that are equivalent to this property, which will be the union of daml:equivalentTo and daml:samePropertyAs.
 ExtendedIterator getRangeClasses()
          Answer an iterator over all of the DAML classes that form the range of this property.
 ExtendedIterator getSameProperties()
          Answer an iterator over all of the DAML properties that are equivalent to this value under the daml:samePropertyAs relation.
 ExtendedIterator getSubProperties()
          Answer an iterator over all of the sub-properties of this property.
 ExtendedIterator getSubProperties(boolean closed)
          Answer an iterator over all of the sub-properties of this property.
 ExtendedIterator getSuperProperties()
          Answer an iterator over all of the super-properties of this property, using the rdfs:subPropertyOf relation (or one of its aliases).
 ExtendedIterator getSuperProperties(boolean closed)
          Answer an iterator over all of the super-properties of this property.
 boolean isUnique()
          Answer true if this property is to be considered unique, that is it is characterised by the DAML class UniqueProperty
 PropertyAccessor prop_domain()
          Property accessor for the domain of a property.
 PropertyAccessor prop_range()
          Property accessor for the range of a property.
 PropertyAccessor prop_samePropertyAs()
          Property accessor for the samePropertyAs property of a DAML Property.
 PropertyAccessor prop_subPropertyOf()
          Property accessor for the subPropertyOf property of a property.
 void setIsUnique(boolean unique)
          Set the flag to indicate that this property is to be considered unique - that is, it is defined by the DAML class UniqueProperty.
 
Methods inherited from interface com.hp.hpl.jena.ontology.daml.DAMLCommon
getDAMLModel, getEquivalenceSet, getRDFTypes, getVocabulary, prop_comment, prop_equivalentTo, prop_label, prop_type, setRDFType
 
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, asDataRange, asIndividual, asOntology, asProperty, getCardinality, getComment, getDifferentFrom, getIsDefinedBy, getLabel, getProfile, getPropertyValue, getRDFType, getRDFType, getSameAs, getSeeAlso, getVersionInfo, hasComment, hasComment, hasLabel, hasLabel, hasRDFType, hasRDFType, hasRDFType, hasSeeAlso, hasVersionInfo, isAllDifferent, isAnnotationProperty, isClass, isDataRange, isDefinedBy, isDifferentFrom, isIndividual, isOntology, isProperty, 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, getModel, getNode, getProperty, getRequiredProperty, getURI, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasURI, isAnon, listProperties, listProperties, removeAll, removeProperties, toString
 
Methods inherited from interface com.hp.hpl.jena.rdf.model.RDFNode
as, canAs, inModel, visitWith
 
Methods inherited from interface com.hp.hpl.jena.graph.FrontsNode
asNode
 
Methods inherited from interface com.hp.hpl.jena.ontology.OntProperty
addDomain, addEquivalentProperty, addInverseOf, addRange, addSubProperty, addSuperProperty, asDatatypeProperty, asFunctionalProperty, asInverseFunctionalProperty, asObjectProperty, asSymmetricProperty, asTransitiveProperty, convertToDatatypeProperty, convertToFunctionalProperty, convertToInverseFunctionalProperty, convertToObjectProperty, convertToSymmetricProperty, convertToTransitiveProperty, getDomain, getEquivalentProperty, getInverse, getInverseOf, getRange, getSubProperty, getSuperProperty, hasDomain, hasEquivalentProperty, hasInverse, hasRange, hasSubProperty, hasSuperProperty, isDatatypeProperty, isFunctionalProperty, isInverseFunctionalProperty, isInverseOf, isObjectProperty, isSymmetricProperty, isTransitiveProperty, listDomain, listEquivalentProperties, listInverse, listInverseOf, listRange, listSubProperties, listSubProperties, listSuperProperties, listSuperProperties, removeDomain, removeEquivalentProperty, removeInverseProperty, removeRange, removeSubProperty, removeSuperProperty, setDomain, setEquivalentProperty, setInverseOf, setRange, setSubProperty, setSuperProperty
 
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, asDataRange, asIndividual, asOntology, asProperty, getCardinality, getComment, getDifferentFrom, getIsDefinedBy, getLabel, getProfile, getPropertyValue, getRDFType, getRDFType, getSameAs, getSeeAlso, getVersionInfo, hasComment, hasComment, hasLabel, hasLabel, hasRDFType, hasRDFType, hasRDFType, hasSeeAlso, hasVersionInfo, isAllDifferent, isAnnotationProperty, isClass, isDataRange, isDefinedBy, isDifferentFrom, isIndividual, isOntology, isProperty, 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, getModel, getNode, getProperty, getRequiredProperty, getURI, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasURI, isAnon, listProperties, listProperties, removeAll, removeProperties, toString
 
Methods inherited from interface com.hp.hpl.jena.rdf.model.RDFNode
as, canAs, inModel, visitWith
 
Methods inherited from interface com.hp.hpl.jena.graph.FrontsNode
asNode
 
Methods inherited from interface com.hp.hpl.jena.rdf.model.Property
getLocalName, getNameSpace, getOrdinal, isProperty
 
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, getModel, getNode, getProperty, getRequiredProperty, getURI, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasProperty, hasURI, isAnon, listProperties, listProperties, removeAll, removeProperties, toString
 
Methods inherited from interface com.hp.hpl.jena.rdf.model.RDFNode
as, canAs, inModel, visitWith
 
Methods inherited from interface com.hp.hpl.jena.graph.FrontsNode
asNode
 

Method Detail

setIsUnique

void setIsUnique(boolean unique)

Set the flag to indicate that this property is to be considered unique - that is, it is defined by the DAML class UniqueProperty.

Parameters:
unique - True for a unique property

isUnique

boolean isUnique()

Answer true if this property is to be considered unique, that is it is characterised by the DAML class UniqueProperty

Returns:
True if this property is unique

prop_domain

PropertyAccessor prop_domain()

Property accessor for the domain of a property. This denotes the class that is the domain of the relation denoted by the property.

Returns:
Property accessor for 'domain'.

prop_subPropertyOf

PropertyAccessor prop_subPropertyOf()

Property accessor for the subPropertyOf property of a property. This denotes the property that is the super-property of this property.

Returns:
Property accessor for daml:subPropertyOf

prop_samePropertyAs

PropertyAccessor prop_samePropertyAs()

Property accessor for the samePropertyAs property of a DAML Property. This denotes that the named property and this one have the same elements.

Returns:
PropertyAccessor for samePropertyAs

prop_range

PropertyAccessor prop_range()
Property accessor for the range of a property. This denotes the class that is the range of the relation denoted by the property.

Returns:
Property accessor for range.

getSameProperties

ExtendedIterator getSameProperties()

Answer an iterator over all of the DAML properties that are equivalent to this value under the daml:samePropertyAs relation. Note: only considers daml:samePropertyAs, for general equivalence, see getEquivalentValues(). Note also that the first member of the iteration is always the DAMLProperty on which the method is invoked: trivially, a property is a member of the set of properties equivalent to itself. If the caller wants the set of properties equivalent to this one, not including itself, simply ignore the first element of the iteration.

Returns:
an iterator ranging over every equivalent DAML property.

getEquivalentValues

ExtendedIterator getEquivalentValues()

Answer an iterator over all of the DAML objects that are equivalent to this property, which will be the union of daml:equivalentTo and daml:samePropertyAs.

Specified by:
getEquivalentValues in interface DAMLCommon
Returns:
an iterator ranging over every equivalent DAML property.

getDomainClasses

ExtendedIterator getDomainClasses()

Answer an iterator over all of the DAML classes that form the domain of this property. The actual domain of the relation denoted by this property is the conjunction of all of the classes mention by the RDFS:domain property of this DAML property and all of its super-properties.

Returns:
an iterator whose values will be the DAML classes that define the domain of the relation

getRangeClasses

ExtendedIterator getRangeClasses()

Answer an iterator over all of the DAML classes that form the range of this property. The actual range of the relation denoted by this property is the conjunction of all of the classes mention by the RDFS:range property of this DAML property and all of its super-properties.

Returns:
an iterator whose values will be the DAML classes that define the range of the relation

getSuperProperties

ExtendedIterator getSuperProperties()

Answer an iterator over all of the super-properties of this property, using the rdfs:subPropertyOf relation (or one of its aliases). The set of super-properties is transitively closed over the subPropertyOf relation.

Returns:
An iterator over the super-properties of this property, whose values will be DAMLProperties.

getSuperProperties

ExtendedIterator getSuperProperties(boolean closed)

Answer an iterator over all of the super-properties of this property.

Note: In a change to the Jena 1 DAML API, whether this iterator includes inferred super-properties is determined not by a flag at the API level, but by the construction of the DAML model itself. See the model factory for details. The boolean parameter closed is now re-interpreted to mean the inverse of direct, see OntClass.listSubClasses(boolean) for more details.

Parameters:
closed - If true, return all available values; otherwise, return only local (direct) super-properties. See note for details.
Returns:
An iterator over this property's super-properties.

getSubProperties

ExtendedIterator getSubProperties()

Answer an iterator over all of the sub-properties of this property.

Returns:
An iterator over the sub-properties of this property.

getSubProperties

ExtendedIterator getSubProperties(boolean closed)

Answer an iterator over all of the sub-properties of this property.

Note: In a change to the Jena 1 DAML API, whether this iterator includes inferred sub-properties is determined not by a flag at the API level, but by the construction of the DAML model itself. See the model factory for details. The boolean parameter closed is now re-interpreted to mean the inverse of direct, see OntClass.listSubClasses(boolean) for more details.

Parameters:
closed - If true, return all available values; otherwise, return only local (direct) sub-properties. See note for details.
Returns:
An iterator over this property's sub-properties.


Copyright © 2000, 2001, 2002, 2003, 2004 Hewlett-Packard Development Company, LP