com.hp.hpl.jena.daml
Interface DAMLProperty

All Superinterfaces:

DAMLCommon, Property, RDFNode, Resource

All Known Subinterfaces:

DAMLDatatypeProperty, DAMLObjectProperty

All Known Implementing Classes:

DAMLPropertyImpl

public interface DAMLProperty

extends DAMLCommon, Property

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.2 2002/01/07 15:23:58 ijd Exp $

Author:

Ian Dickinson, HP Labs (email)

Method Summary

java.util.Iterator	getDomainClasses() Answer an iterator over all of the DAML classes that form the domain of this property.
java.util.Iterator	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.
java.util.Iterator	getRangeClasses() Answer an iterator over all of the DAML classes that form the range of this property.
java.util.Iterator	getSameProperties() Answer an iterator over all of the DAML properties that are equivalent to this value under the daml:samePropertyAs relation.
java.util.Iterator	getSubProperties() Answer an iterator over all of the sub-properties of this property, using the rdfs:subPropertyOf relation (or one of its aliases).
java.util.Iterator	getSubProperties(boolean closed) Answer an iterator over all of the sub-properties of this property, using the rdfs:subPropertyOf relation (or one of its aliases).
java.util.Iterator	getSuperProperties() Answer an iterator over all of the super-properties of this property, using the rdfs:subPropertyOf relation (or one of its aliases).
java.util.Iterator	getSuperProperties(boolean closed) Answer an iterator over all of the super-properties of this property, using the rdfs:subPropertyOf relation (or one of its aliases).
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' property of a property.
PropertyAccessor	prop_range() Property accessor for the 'range' property 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.daml.DAMLCommon

getAll, getDAMLModel, getEquivalenceSet, getNumPropertyValues, getPropertyValue, getPropertyValues, getRDFTypes, getVocabulary, hasRDFType, hasRDFType, prop_comment, prop_equivalentTo, prop_label, prop_type, remove, removeAll, removeProperty, replaceProperty, setPropertyValue, setRDFType, setRDFType

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

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

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

getLocalName, getNameSpace, getOrdinal

Method Detail

setIsUnique

public 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

public 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

public PropertyAccessor prop_domain()

Property accessor for the 'domain' property 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

public 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 'subPropertyOf'.

prop_samePropertyAs

public 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

public PropertyAccessor prop_range()

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

Returns:

Property accessor for 'range'.

getSameProperties

public java.util.Iterator 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 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 - each value of the iteration will be a DAMLProperty object.

getEquivalentValues

public java.util.Iterator 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 - each value of the iteration should be a DAMLProperty object or one of its sub-classes.

getDomainClasses

public java.util.Iterator 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

public java.util.Iterator 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

public java.util.Iterator 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

public java.util.Iterator getSuperProperties(boolean closed)

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 optionally transitively closed over the subPropertyOf relation.

Parameters:

closed - If true, iterate over the super-properties of my super-properties, etc.

Returns:

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

getSubProperties

public java.util.Iterator getSubProperties()

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

Returns:

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

getSubProperties

public java.util.Iterator getSubProperties(boolean closed)

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

Parameters:

closed - If true, iterate over the sub-properties of my sub-properties, etc.

Returns:

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