|
| |
|
| com.hp.hpl.jena.ontology.OntClass
All known Subclasses: com.hp.hpl.jena.ontology.impl.OntClassImpl,
| OntClass | | public interface OntClass extends OntResource(Code) | |
Interface that represents an ontology node characterising a class description.
author:
Ian Dickinson, HP Labs
author:
(email)
version:
CVS $Id: OntClass.java,v 1.30 2008/01/02 12:06:41 andy_seaborne Exp $ |
| addDisjointWith | | public void addDisjointWith(Resource cls)(Code) | | Add a class that this class is disjoint with.
Parameters:
cls - A class that has no instances in common with this class.
exception:
OntProfileException - If the Profile.DISJOINT_WITH property is not supported in the current language profile. |
| addEquivalentClass | | public void addEquivalentClass(Resource cls)(Code) | | Add a class that is equivalent to this class.
Parameters:
cls - A class that is equivalent to this class.
exception:
OntProfileException - If the Profile.EQUIVALENT_CLASS property is not supported in the current language profile. |
| addSubClass | | public void addSubClass(Resource cls)(Code) | | Add a sub-class of this class.
Parameters:
cls - A class that is a sub-class of this class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| addSuperClass | | public void addSuperClass(Resource cls)(Code) | | Add a super-class of this class.
Parameters:
cls - A class that is a super-class of this class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| asComplementClass | | public ComplementClass asComplementClass()(Code) | | Answer a view of this class as a complement class
This class, but viewed as a ComplementClass facet
exception:
ConversionException - if the class cannot be converted to a complement classgiven the language profile and the current state of the underlying model. |
| asEnumeratedClass | | public EnumeratedClass asEnumeratedClass()(Code) | | Answer a view of this class as an enumerated class
This class, but viewed as an EnumeratedClass facet
exception:
ConversionException - if the class cannot be converted to an enumerated classgiven the language profile and the current state of the underlying model. |
| asIntersectionClass | | public IntersectionClass asIntersectionClass()(Code) | | Answer a view of this class as an intersection class
This class, but viewed as an IntersectionClass facet
exception:
ConversionException - if the class cannot be converted to an intersection classgiven the language profile and the current state of the underlying model. |
| asRestriction | | public Restriction asRestriction()(Code) | | Answer a view of this class as a restriction class expression
This class, but viewed as a Restriction facet
exception:
ConversionException - if the class cannot be converted to a restrictiongiven the language profile and the current state of the underlying model. |
| asUnionClass | | public UnionClass asUnionClass()(Code) | | Answer a view of this class as a union class
This class, but viewed as a UnionClass facet
exception:
ConversionException - if the class cannot be converted to a union classgiven the language profile and the current state of the underlying model. |
| convertToComplementClass | | public ComplementClass convertToComplementClass(Resource cls)(Code) | | Answer a view of this class as an complement of the given class.
Parameters:
cls - An ontology class that will be operand of the complement This ontology class, converted to an complement of the given class |
| convertToEnumeratedClass | | public EnumeratedClass convertToEnumeratedClass(RDFList individuals)(Code) | | Answer a view of this class as an enumeration of the given individuals.
Parameters:
individuals - A list of the individuals that will comprise the permitted values of thisclass converted to an enumeration This ontology class, converted to an enumeration of the given individuals |
| convertToIntersectionClass | | public IntersectionClass convertToIntersectionClass(RDFList classes)(Code) | | Answer a view of this class as an intersection of the given classes.
Parameters:
classes - A list of the classes that will comprise the operands of the intersection This ontology class, converted to an intersection of the given classes |
| convertToRestriction | | public Restriction convertToRestriction(Property prop)(Code) | | Answer a view of this class as an restriction on the given property.
Parameters:
prop - A property this is the subject of a property restriction class expression This ontology class, converted to a restriction on the given property |
| convertToUnionClass | | public UnionClass convertToUnionClass(RDFList classes)(Code) | | Answer a view of this class as a union of the given classes.
Parameters:
classes - A list of the classes that will comprise the operands of the union This ontology class, converted to an union of the given classes |
| createIndividual | | public Individual createIndividual()(Code) | | Answer a new individual that has this class as its rdf:type
A new anonymous individual that is an instance of this class |
| createIndividual | | public Individual createIndividual(String uri)(Code) | | Answer a new individual that has this class as its rdf:type
Parameters:
uri - The URI of the new individual A new named individual that is an instance of this class |
| dropIndividual | | public void dropIndividual(Resource individual)(Code) | | Remove the given individual from the set of instances that are members of
this class. This is effectively equivalent to the
Individual.removeOntClass method,
but invoked via the class resource rather than via the individual resource.
Parameters:
individual - A resource denoting an individual that is no longer to be a memberof this class |
| getDisjointWith | | public OntClass getDisjointWith()(Code) | | Answer a class with which this class is disjoint. If there is
more than one such class, an arbitrary selection is made.
A class disjoint with this class
exception:
OntProfileException - If the Profile.DISJOINT_WITH property is not supported in the current language profile. |
| getEquivalentClass | | public OntClass getEquivalentClass()(Code) | | Answer a class that is equivalent to this class. If there is
more than one such class, an arbitrary selection is made.
A class equivalent to this class
exception:
OntProfileException - If the Profile.EQUIVALENT_CLASS property is not supported in the current language profile. |
| getSubClass | | public OntClass getSubClass()(Code) | | Answer a class that is the sub-class of this class. If there is
more than one such class, an arbitrary selection is made. If
there is no such class, return null.
A sub-class of this class or null
exception:
OntProfileException - If the Profile.SUB_CLASS_OFproperty is not supported in the current language profile. |
| getSuperClass | | public OntClass getSuperClass()(Code) | | Answer a class that is the super-class of this class. If there is
more than one such class, an arbitrary selection is made. If there
is no such super-class, return null.
A super-class of this class or null
exception:
OntProfileException - If the Profile.SUB_CLASS_OFproperty is not supported in the current language profile. |
| hasDeclaredProperty | | public boolean hasDeclaredProperty(Property p, boolean direct)(Code) | | Answer true if the given property is one of the declared properties
of this class. For details, see
OntClass.listDeclaredProperties(boolean) .
Parameters:
p - A property to test
Parameters:
direct - If true, only direct associations between classes and propertiesare considered True if p is one of the declared properties ofthis class |
| hasEquivalentClass | | public boolean hasEquivalentClass(Resource cls)(Code) | | Answer true if the given class is equivalent to this class.
Parameters:
cls - A class to test for True if the given property is equivalent to this class.
exception:
OntProfileException - If the Profile.EQUIVALENT_CLASS property is not supported in the current language profile. |
| hasSubClass | | public boolean hasSubClass(Resource cls)(Code) | | Answer true if the given class is a sub-class of this class.
Parameters:
cls - A class to test. True if the given class is a sub-class of this class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| hasSubClass | | public boolean hasSubClass()(Code) | | Answer true if this class has any sub-class in the model. Note that
when using a reasoner, all OWL classes have owl:Nothing as a sub-class.
True if this class has any known sub-class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| hasSubClass | | public boolean hasSubClass(Resource cls, boolean direct)(Code) | | Answer true if the given class is a sub-class of this class.
See
OntClass.listSubClasses(boolean) for a full explanation of the direct
parameter.
Parameters:
cls - A class to test.
Parameters:
direct - If true, only search the classes that are directly adjacent to thisclass in the class hierarchy. True if the given class is a sub-class of this class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| hasSuperClass | | public boolean hasSuperClass(Resource cls)(Code) | | Answer true if the given class is a super-class of this class.
Parameters:
cls - A class to test. True if the given class is a super-class of this class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| hasSuperClass | | public boolean hasSuperClass()(Code) | | Answer true if this class has any super-class in the model. Note that
when using a reasoner, all OWL classes have owl:Thing as a super-class.
True if this class has any known super-class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| hasSuperClass | | public boolean hasSuperClass(Resource cls, boolean direct)(Code) | | Answer true if the given class is a super-class of this class.
See
OntClass.listSubClasses(boolean) for a full explanation of the direct
parameter.
Parameters:
cls - A class to test.
Parameters:
direct - If true, only search the classes that are directly adjacent to thisclass in the class hierarchy. True if the given class is a super-class of this class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| isComplementClass | | public boolean isComplementClass()(Code) | | Answer true if this class is a complement class expression
True if this is a complement class expression |
| isDisjointWith | | public boolean isDisjointWith(Resource cls)(Code) | | Answer true if this class is disjoint with the given class.
Parameters:
cls - A class to test True if the this class is disjoint with the the given class.
exception:
OntProfileException - If the Profile.DISJOINT_WITH property is not supported in the current language profile. |
| isEnumeratedClass | | public boolean isEnumeratedClass()(Code) | | Answer true if this class is an enumerated class expression
True if this is an enumerated class expression |
| isHierarchyRoot | | public boolean isHierarchyRoot()(Code) | | Answer true if this class is one of the roots of the local class hierarchy.
This will be true if either (i) this class has owl:Thing
(or daml:Thing) as a direct super-class, or (ii) it has
no declared super-classes (including anonymous class expressions).
True if this class is the root of the class hierarchy in themodel it is attached to |
| isIntersectionClass | | public boolean isIntersectionClass()(Code) | | Answer true if this class is an intersection class expression
True if this is an intersection class expression |
| isRestriction | | public boolean isRestriction()(Code) | | Answer true if this class is a property restriction
True if this is a restriction |
| isUnionClass | | public boolean isUnionClass()(Code) | | Answer true if this class is a union class expression
True if this is a union class expression |
| listDeclaredProperties | | public ExtendedIterator listDeclaredProperties()(Code) | | Answer an iteration of the properties associated with a frame-like
view of this class. Note that many cases of determining whether a
property is associated with a class depends on RDFS or OWL reasoning.
This method may therefore return complete results only in models that
have an attached reasoner.
See the
RDF frames how-to
for full details.
An iteration of the properties that are associated with this classby their domain. |
| listDeclaredProperties | | public ExtendedIterator listDeclaredProperties(boolean direct)(Code) | | Answer an iteration of the properties associated with a frame-like
view of this class. Note that many cases of determining whether a
property is associated with a class depends on RDFS or OWL reasoning.
This method may therefore return complete results only in models that
have an attached reasoner. See the
RDF frames how-to
for full details.
Parameters:
direct - If true, restrict the properties returned to those directlyassociated with this class. An iteration of the properties that are associated with this classby their domain. |
| listDisjointWith | | public ExtendedIterator listDisjointWith()(Code) | | Answer an iterator over all of the classes that this class is declared to be disjoint with.
Each element of the iterator will be an
OntClass .
An iterator over the classes disjoint with this class.
exception:
OntProfileException - If the Profile.DISJOINT_WITH property is not supported in the current language profile. |
| listEquivalentClasses | | public ExtendedIterator listEquivalentClasses()(Code) | | Answer an iterator over all of the classes that are declared to be equivalent classes to
this class. Each element of the iterator will be an
OntClass .
An iterator over the classes equivalent to this class.
exception:
OntProfileException - If the Profile.EQUIVALENT_CLASS property is not supported in the current language profile. |
| listInstances | | public ExtendedIterator listInstances()(Code) | | Answer an iterator over the individuals in the model that have this
class among their types. Equivalent to
OntClass.listInstances(boolean) with an argument false.
An iterator over those instances that have this class as one ofthe classes to which they belong |
| listInstances | | public ExtendedIterator listInstances(boolean direct)(Code) | | Answer an iterator over the individuals in the model that have this
class among their types, optionally excluding sub-classes of this class.
Parameters:
direct - If true, only direct instances are counted (i.e. not instancesof sub-classes of this class) An iterator over those instances that have this class as one ofthe classes to which they belong |
| listSubClasses | | public ExtendedIterator listSubClasses()(Code) | | Answer an iterator over all of the classes that are declared to be sub-classes of
this class. Each element of the iterator will be an
OntClass .
An iterator over the sub-classes of this class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| listSubClasses | | public ExtendedIterator listSubClasses(boolean direct)(Code) | |
Answer an iterator over the classes that are declared to be sub-classes of
this class. Each element of the iterator will be an
OntClass . The
distinguishing extra parameter for this method is the flag direct
that allows some selectivity over the classes that appear in the iterator.
Consider the following scenario:
:B rdfs:subClassOf :A.
:C rdfs:subClassOf :A.
:D rdfs:subClassof :C.
rdfs:subClassOf is known to be transitive, so
the sub-classes iterator will include D. The direct sub-classes
are those members of the closure of the subClassOf relation, restricted to classes that
cannot be reached by a longer route, i.e. the ones that are directly adjacent
to the given root. Thus, the direct sub-classes of A are B and C only, and not D -
even in an inferencing graph. Note that this is not the same as the entailments
from the raw graph. Suppose we add to this example:
:D rdfs:subClassof :A.
Note: This is is a change from the behaviour of Jena 1, which took a
parameter closed to compute the closure over transitivity and equivalence
of sub-classes. The closure capability in Jena2 is determined by the inference engine
that is wrapped with the ontology model. The direct parameter is provided to allow,
for example, a level-by-level traversal of the class hierarchy, starting at some given
root. Observe that in Jena 1, passing true will tend to increase the number of
results returned; in Jena 2 passing true will tend to reduce the number
of results.
Parameters:
direct - If true, only answer the directly adjacent classes in thesub-class relation: i.e. eliminate any class for which there is a longer routeto reach that child under the sub-class relation. an iterator over the resources representing this class's sub-classes
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| listSuperClasses | | public ExtendedIterator listSuperClasses()(Code) | | Answer an iterator over all of the classes that are super-classes of
this class. Each element of the iterator will be an
OntClass .
An iterator over the super-classes of this class.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| listSuperClasses | | public ExtendedIterator listSuperClasses(boolean direct)(Code) | | Answer an iterator over all of the classes that are super-classes of
this class. Each element of the iterator will be an
OntClass .
See
OntClass.listSubClasses(boolean) for a full explanation of the direct
parameter.
Parameters:
direct - If true, only answer the directly adjacent classes in thesuper-class relation: i.e. eliminate any class for which there is a longer routeto reach that child under the super-class relation. an iterator over the resources representing this class's sub-classes.
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| removeDisjointWith | | public void removeDisjointWith(Resource cls)(Code) | | Remove the statement that this class and the given class are
disjoint. If this statement
is not true of the current model, nothing happens.
Parameters:
cls - A class that may be declared to be disjoint with this class, and which is no longer disjoint
exception:
OntProfileException - If the Profile#DISJOINT_WITH()()() property is not supported in the current language profile. |
| removeEquivalentClass | | public void removeEquivalentClass(Resource cls)(Code) | | Remove the statement that this class and the given class are
equivalent. If this statement
is not true of the current model, nothing happens.
Parameters:
cls - A class that may be declared to be equivalent to this class, and which is no longer equivalent
exception:
OntProfileException - If the Profile#EQUIVALENT_CLASS()() property is not supported in the current language profile. |
| removeSubClass | | public void removeSubClass(Resource cls)(Code) | | Remove the given class from the sub-classes of this class. If this statement
is not true of the current model, nothing happens.
Parameters:
cls - A class to be removed from the sub-classes of this class
exception:
OntProfileException - If the Profile.SUB_CLASS_OF class is not supported in the current language profile. |
| removeSuperClass | | public void removeSuperClass(Resource cls)(Code) | | Remove the given class from the super-classes of this class. If this statement
is not true of the current model, nothing happens.
Parameters:
cls - A class to be removed from the super-classes of this class
exception:
OntProfileException - If the Profile.SUB_CLASS_OF class is not supported in the current language profile. |
| setDisjointWith | | public void setDisjointWith(Resource cls)(Code) | | Assert that this class is disjoint with the given class. Any existing
statements for disjointWith will be removed.
Parameters:
cls - The property that this class is disjoint with.
exception:
OntProfileException - If the Profile.DISJOINT_WITH property is not supported in the current language profile. |
| setEquivalentClass | | public void setEquivalentClass(Resource cls)(Code) | | Assert that the given class is equivalent to this class. Any existing
statements for equivalentClass will be removed.
Parameters:
cls - The class that this class is a equivalent to.
exception:
OntProfileException - If the Profile.EQUIVALENT_CLASS property is not supported in the current language profile. |
| setSubClass | | public void setSubClass(Resource cls)(Code) | | Assert that this class is super-class of the given class. Any existing
statements for subClassOf on prop will be removed.
Parameters:
cls - The class that is a sub-class of this class
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
| setSuperClass | | public void setSuperClass(Resource cls)(Code) | | Assert that this class is sub-class of the given class. Any existing
statements for subClassOf will be removed.
Parameters:
cls - The class that this class is a sub-class of
exception:
OntProfileException - If the Profile.SUB_CLASS_OF property is not supported in the current language profile. |
|
|
|