org.semanticweb.owlapi.modularity
Interface OntologySegmenter

All Known Implementing Classes:
SyntacticLocalityModuleExtractor

public interface OntologySegmenter

An interface for any class implementing ontology segmentation or modularisation.

Author:
Thomas Schneider, School of Computer Science, University of Manchester

Method Summary
 java.util.Set<OWLAxiom> extract(java.util.Set<OWLEntity> signature)
          Returns a set of axioms that is a segment of the ontology associated with this segmenter.
 java.util.Set<OWLAxiom> extract(java.util.Set<OWLEntity> signature, int superClassLevel, int subClassLevel, OWLReasoner reasoner)
          Returns a set of axioms that is a segment of the ontology associated with this segmenter.
 OWLOntology extractAsOntology(java.util.Set<OWLEntity> signature, IRI iri)
          Returns an ontology that is a segment of the ontology associated with this segmenter.
 OWLOntology extractAsOntology(java.util.Set<OWLEntity> signature, IRI iri, int superClassLevel, int subClassLevel, OWLReasoner reasoner)
          Returns an ontology that is a segment of the ontology associated with this segmenter.
 

Method Detail

extract

java.util.Set<OWLAxiom> extract(java.util.Set<OWLEntity> signature)
Returns a set of axioms that is a segment of the ontology associated with this segmenter. This segment is determined by the specified seed signature (set of entities).

Parameters:
signature - the seed signature
Returns:
the segment as a set of axioms

extract

java.util.Set<OWLAxiom> extract(java.util.Set<OWLEntity> signature,
                                int superClassLevel,
                                int subClassLevel,
                                OWLReasoner reasoner)
Returns a set of axioms that is a segment of the ontology associated with this segmenter. This segment is determined by a seed signature (set of entities), which is the specified signature plus possibly all superclasses and/or subclasses of the classes therein. Sub-/superclasses are determined using the specified reasoner.

Parameters:
signature - the seed signature
superClassLevel - determines whether superclasses are added to the signature before segment extraction, see below for admissible values
subClassLevel - determines whether subclasses are added to the signature before segment extraction, see below for admissible values
reasoner - the reasoner to determine super-/subclasses
Returns:
the segment as a set of axioms Meaning of the value of superClassLevel, subClassLevel:
Let this value be k. If k > 0, then all classes are included that are (direct or indirect) super-/subclasses of some class in signature, with a distance of at most k to this class in the class hierarchy computed by reasoner. If k = 0, then no super-/subclasses are added. If k < 0, then all direct and indirect super-/subclasses of any class in the signature are added.

extractAsOntology

OWLOntology extractAsOntology(java.util.Set<OWLEntity> signature,
                              IRI iri)
                              throws OWLOntologyCreationException
Returns an ontology that is a segment of the ontology associated with this segmenter.

Parameters:
signature - the seed signature (set of entities) for the module
iri - the URI for the module
Returns:
the module, having the specified URI
Throws:
OWLOntologyChangeException - if adding axioms to the module fails
OWLOntologyCreationException - if the module cannot be created

extractAsOntology

OWLOntology extractAsOntology(java.util.Set<OWLEntity> signature,
                              IRI iri,
                              int superClassLevel,
                              int subClassLevel,
                              OWLReasoner reasoner)
                              throws OWLOntologyCreationException
Returns an ontology that is a segment of the ontology associated with this segmenter. This segment is determined by a seed signature (set of entities), which is the specified signature plus possibly all superclasses and/or subclasses of the classes therein. Sub-/superclasses are determined using the specified reasoner.

Parameters:
signature - the seed signature
iri - the URI for the module
superClassLevel - determines whether superclasses are added to the signature before segment extraction, see below for admissible values
subClassLevel - determines whether subclasses are added to the signature before segment extraction, see below for admissible values
reasoner - the reasoner to determine super-/subclasses
Returns:
the segment as a set of axioms
Throws:
OWLOntologyChangeException - if adding axioms to the module fails
OWLOntologyCreationException - if the module cannot be created Meaning of the value of superClassLevel, subClassLevel:
Let this value be k. If k > 0, then all classes are included that are (direct or indirect) super-/subclasses of some class in signature, with a distance of at most k to this class in the class hierarchy computed by reasoner. If k = 0, then no super-/subclasses are added. If k < 0, then all direct and indirect super-/subclasses of any class in the signature are added.