com.hp.hpl.jena.daml
Interface DAMLClass

All Superinterfaces:

DAMLClassExpression, DAMLCommon, RDFNode, Resource

All Known Subinterfaces:

DAMLRestriction

All Known Implementing Classes:

DAMLClassImpl

public interface DAMLClass

extends DAMLCommon, DAMLClassExpression

Java representation of a DAML ontology Class. Note that the ontology classes are not the same as Java classes: think of classifications rather than active data structures.

Version:

CVS info: $Id: DAMLClass.java,v 1.4 2002/01/06 13:30:06 ijd Exp $

Author:

Ian Dickinson, HP Labs (email)

Method Summary

java.util.Iterator	getDefinedProperties() Answer an iteration of the properties that may be used for instances of this class: i.e.
java.util.Iterator	getDefinedProperties(boolean closed) Answer an iteration of the properties that may be used for instances of this class: i.e.
java.util.Iterator	getEquivalentValues() Answer an iterator over all of the DAML objects that are equivalent to this class, which will be the union of daml:equivalentTo and daml:sameClassAs.
java.util.Iterator	getInstances() Answer an iterator over the instances of this class that currently exist in the model.
java.util.Iterator	getSameClasses() Answer an iterator over all of the DAML classes that are equivalent to this value under the daml:sameClassAs relation.
java.util.Iterator	getSubClasses() Answer an iterator over the DAML classes (or, strictly, class expressions) that mention this class as one of its super-classes.
java.util.Iterator	getSubClasses(boolean closed) Answer an iterator over the DAML classes (or, strictly, class expressions) that mention this class as one of its super-classes.
java.util.Iterator	getSuperClasses() Answer an iterator over the DAML classes (or, strictly, class expressions) that mention this class as one of its sub-classes.
java.util.Iterator	getSuperClasses(boolean closed) Answer an iterator over the DAML classes (or, strictly, class expressions) that mention this class as one of its sub-classes.
boolean	hasSubClass(DAMLClass cls) Answer true if the given class is a sub-class of this class, using information from the rdf:subClassOf or daml:subClassOf relation.
boolean	hasSuperClass(DAMLClass cls) Answer true if the given class is a super-class of this class, using information from the rdf:subClassOf or daml:subClassOf relation.
PropertyAccessor	prop_complementOf() Property accessor for the property 'compelementOf', which is one element of the range of boolean expressions over classes permitted by DAML.
PropertyAccessor	prop_disjointUnionOf() Property accessor for the 'disjointUnionOf' property of a class.
PropertyAccessor	prop_disjointWith() Property accessor for the 'disjointWith' property of a class.
PropertyAccessor	prop_intersectionOf() Property accessor for the property 'intersectionOf', which is one element of the range of boolean expressions over classes permitted by DAML.
PropertyAccessor	prop_oneOf() Property accessor for the 'oneOf' property, which defines a class expression denoting that the class is exactly one of the given list of class expressions.
PropertyAccessor	prop_sameClassAs() Property accessor for the 'sameClassAs' property of a class.
PropertyAccessor	prop_subClassOf() Property accessor for the 'subClassOf' property of a class.
PropertyAccessor	prop_unionOf() Property accessor for the property 'unionOf', which is one element of the range of boolean expressions over classes permitted by DAML.

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.jena.daml.DAMLClassExpression

isComplement, isDisjointUnion, isEnumeration, isIntersection, isNamedClass, isRestriction, isUnion

Method Detail

prop_subClassOf

public PropertyAccessor prop_subClassOf()

Property accessor for the 'subClassOf' property of a class. This denotes a class-expression that is a super-class of this class.

Returns:

Property accessor for 'onProperty'.

prop_disjointWith

public PropertyAccessor prop_disjointWith()

Property accessor for the 'disjointWith' property of a class. This denotes a class-expression with which this class has no instances in common.

Returns:

Property accessor for 'disjointWith'.

prop_disjointUnionOf

public PropertyAccessor prop_disjointUnionOf()

Property accessor for the 'disjointUnionOf' property of a class. This denotes a list of class expressions that are each pair-wise disjoint, and whose union describes this class.

Returns:

Property accessor for 'disjointUnionOf'.

prop_sameClassAs

public PropertyAccessor prop_sameClassAs()

Property accessor for the 'sameClassAs' property of a class. This denotes a class-expression whose instances are the same those of this class.

Returns:

Property accessor for 'sameClassAs'.

prop_unionOf

public PropertyAccessor prop_unionOf()

Property accessor for the property 'unionOf', which is one element of the range of boolean expressions over classes permitted by DAML.

Returns:

property accessor for 'unionOf'.

prop_intersectionOf

public PropertyAccessor prop_intersectionOf()

Property accessor for the property 'intersectionOf', which is one element of the range of boolean expressions over classes permitted by DAML.

Returns:

property accessor for 'intersectionOf'.

prop_complementOf

public PropertyAccessor prop_complementOf()

Property accessor for the property 'compelementOf', which is one element of the range of boolean expressions over classes permitted by DAML.

Returns:

property accessor for 'complementOf'.

prop_oneOf

public PropertyAccessor prop_oneOf()

Property accessor for the 'oneOf' property, which defines a class expression denoting that the class is exactly one of the given list of class expressions.

Returns:

property accessor for 'oneOf'

getSubClasses

public java.util.Iterator getSubClasses()

Answer an iterator over the DAML classes (or, strictly, class expressions) that mention this class as one of its super-classes. Will generate the closure of the iteration over the sub-class relationship.

Returns:

an iterator over this class's sub-classes. The members of the iteration will be DAMLClass objects.

getSubClasses

public java.util.Iterator getSubClasses(boolean closed)

Answer an iterator over the DAML classes (or, strictly, class expressions) that mention this class as one of its super-classes.

Parameters:

closed - If true, close the iteration over the sub-class relation: i.e. return the sub-classes of the sub-classes, etc.

Returns:

an iterator over this class's super-classes. The members of the iteration will be DAMLClass objects.

getSuperClasses

public java.util.Iterator getSuperClasses()

Answer an iterator over the DAML classes (or, strictly, class expressions) that mention this class as one of its sub-classes. Will generate the closure of the iteration over the super-class relationship.

Returns:

an iterator over this class's super-classes. The members of the iteration will be DAMLClass objects.

getSuperClasses

public java.util.Iterator getSuperClasses(boolean closed)

Answer an iterator over the DAML classes (or, strictly, class expressions) that mention this class as one of its sub-classes.

Parameters:

closed - If true, close the iteration over the super-class relation: i.e. return the super-classes of the super-classes, etc.

Returns:

an iterator over this class's sub-classes. The members of the iteration will be DAMLClass objects.

getSameClasses

public java.util.Iterator getSameClasses()

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

Returns:

an iterator ranging over every equivalent DAML class - each value of the iteration will be a DAMLClass object.

getEquivalentValues

public java.util.Iterator getEquivalentValues()

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

Specified by:

getEquivalentValues in interface DAMLCommon

Returns:

an iterator ranging over every equivalent DAML class - each value of the iteration should be a DAMLClass object.

hasSubClass

public boolean hasSubClass(DAMLClass cls)

Answer true if the given class is a sub-class of this class, using information from the rdf:subClassOf or daml:subClassOf relation.

Parameters:

cls - A DAMLClass object

Returns:

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

hasSuperClass

public boolean hasSuperClass(DAMLClass cls)

Answer true if the given class is a super-class of this class, using information from the rdf:subClassOf or daml:subClassOf relation.

Parameters:

cls - A DAMLClass object

Returns:

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

getInstances

public java.util.Iterator getInstances()

Answer an iterator over the instances of this class that currently exist in the model.

Returns:

An iterator over those instances that have this class as one of the classes to which they belong

See Also:

DAMLCommon.getRDFTypes(boolean)

getDefinedProperties

public java.util.Iterator getDefinedProperties()

Answer an iteration of the properties that may be used for instances of this class: i.e. the properties that have this class, or one of its super-classes, as domain.

Returns:

An iteration of the properties that have this class as domain

getDefinedProperties

public java.util.Iterator getDefinedProperties(boolean closed)

Answer an iteration of the properties that may be used for instances of this class: i.e. the properties that have this class, or optionally one of its super-classes, as domain.

Parameters:

closed - If true, close the iteration over the super-classes of this class.

Returns:

An iteration of the properties that have this class as domain