uk.ac.manchester.cs.owlapi.modularity

Class SyntacticLocalityModuleExtractor

java.lang.Object

uk.ac.manchester.cs.owlapi.modularity.SyntacticLocalityModuleExtractor

All Implemented Interfaces:

OntologySegmenter

public class SyntacticLocalityModuleExtractor
extends Object
implements OntologySegmenter

Implementation of module extraction based on syntactic locality.

Author:

Thomas Schneider, School of Computer Science, University of Manchester

Constructor Summary

Constructors

Constructor and Description
SyntacticLocalityModuleExtractor(OWLOntologyManager man, IRI ontIRI, Set<OWLAxiom> axs, ModuleType moduleType) Creates a new module extractor for a subset of a given ontology, its manager, and a specified type of locality.
SyntacticLocalityModuleExtractor(OWLOntologyManager man, IRI ontIRI, Set<OWLAxiom> axs, ModuleType moduleType, boolean excludeAssertions)
SyntacticLocalityModuleExtractor(OWLOntologyManager man, OWLOntologyLoaderConfiguration config, IRI ontIRI, Set<OWLAxiom> axs, ModuleType moduleType, boolean excludeAssertions)
SyntacticLocalityModuleExtractor(OWLOntologyManager man, OWLOntology ont, ModuleType moduleType) Creates a new module extractor for a given ontology, its manager, and a specified type of locality.
SyntacticLocalityModuleExtractor(OWLOntologyManager man, OWLOntology ont, Set<OWLAxiom> axs, ModuleType moduleType) Deprecated. use the constructor that takes an IRI rather than an ontology as second argument. The second argument is used only in logging assertions and can be null.

Method Summary

Modifier and Type	Method and Description
Set<OWLAxiom>	extract(Set<OWLEntity> signature) Returns a set of axioms that is a segment of the ontology associated with this segmenter.
Set<OWLAxiom>	extract(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.
Set<OWLAxiom>	extract(Set<OWLEntity> sig, int superClassLevel, int subClassLevel, OWLReasoner reasoner, boolean verbose) Extracts a module from the associated ontology for a given signature and the associated module type, and returns the module as a set of axioms.
OWLOntology	extractAsOntology(Set<OWLEntity> signature, IRI iri) Returns an ontology that is a segment of the ontology associated with this segmenter.
OWLOntology	extractAsOntology(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.
ModuleType	getModuleType() Returns the module type for this extractor.
void	setModuleType(ModuleType moduleType) Changes the module type for this extractor without deleting the stored referenced entities.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SyntacticLocalityModuleExtractor

@Deprecated
public SyntacticLocalityModuleExtractor(@Nonnull
                                                    OWLOntologyManager man,
                                                    OWLOntology ont,
                                                    @Nonnull
                                                    Set<OWLAxiom> axs,
                                                    @Nonnull
                                                    ModuleType moduleType)

Deprecated. use the constructor that takes an IRI rather than an ontology as second argument. The second argument is used only in logging assertions and can be null.

Creates a new module extractor for a subset of a given ontology, its manager, and a specified type of locality.

Parameters:

man - the manager for the associated ontology

ont - the associated ontology

axs - the subset of the ontology as a set of axioms

moduleType - the type of module this extractor will construct

SyntacticLocalityModuleExtractor

public SyntacticLocalityModuleExtractor(@Nonnull
                                        OWLOntologyManager man,
                                        IRI ontIRI,
                                        @Nonnull
                                        Set<OWLAxiom> axs,
                                        @Nonnull
                                        ModuleType moduleType)

Creates a new module extractor for a subset of a given ontology, its manager, and a specified type of locality.

Parameters:

man - the manager for the associated ontology

ontIRI - the associated ontology IRI. Only for debugging purposes.

axs - the subset of the ontology as a set of axioms

moduleType - the type of module this extractor will construct

SyntacticLocalityModuleExtractor

public SyntacticLocalityModuleExtractor(@Nonnull
                                        OWLOntologyManager man,
                                        IRI ontIRI,
                                        @Nonnull
                                        Set<OWLAxiom> axs,
                                        @Nonnull
                                        ModuleType moduleType,
                                        boolean excludeAssertions)

Parameters:

man - manager

ontIRI - ontology IRI

axs - axioms

moduleType - module type

excludeAssertions - exclude assertions

SyntacticLocalityModuleExtractor

public SyntacticLocalityModuleExtractor(@Nonnull
                                        OWLOntologyManager man,
                                        OWLOntologyLoaderConfiguration config,
                                        IRI ontIRI,
                                        @Nonnull
                                        Set<OWLAxiom> axs,
                                        @Nonnull
                                        ModuleType moduleType,
                                        boolean excludeAssertions)

Parameters:

man - manager

config - config object to access configuration

ontIRI - ontology IRI

axs - axioms

moduleType - module type

excludeAssertions - exclude assertions

SyntacticLocalityModuleExtractor

public SyntacticLocalityModuleExtractor(@Nonnull
                                        OWLOntologyManager man,
                                        @Nonnull
                                        OWLOntology ont,
                                        @Nonnull
                                        ModuleType moduleType)

Creates a new module extractor for a given ontology, its manager, and a specified type of locality.

Parameters:

man - the manager for the associated ontology

ont - the associated ontology

moduleType - the type of module this extractor will construct

Method Detail

setModuleType

public void setModuleType(@Nonnull
                          ModuleType moduleType)

Changes the module type for this extractor without deleting the stored referenced entities.

Parameters:

moduleType - the new type of module

getModuleType

@Nonnull
public ModuleType getModuleType()

Returns the module type for this extractor.

Returns:

module type for this extractor

extract

public Set<OWLAxiom> extract(Set<OWLEntity> signature)

Description copied from interface: OntologySegmenter

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).

Specified by:

extract in interface OntologySegmenter

Parameters:

signature - the seed signature

Returns:

the segment as a set of axioms

extract

public Set<OWLAxiom> extract(Set<OWLEntity> signature,
                             int superClassLevel,
                             int subClassLevel,
                             OWLReasoner reasoner)

Description copied from interface: OntologySegmenter

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.

Specified by:

extract in interface OntologySegmenter

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 greater than 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 lesser than 0, then all direct and indirect super-/subclasses of any class in the signature are added.

extract

@Nonnull
public Set<OWLAxiom> extract(@Nonnull
                                      Set<OWLEntity> sig,
                                      int superClassLevel,
                                      int subClassLevel,
                                      OWLReasoner reasoner,
                                      boolean verbose)

Extracts a module from the associated ontology for a given signature and the associated module type, and returns the module as a set of axioms. The seed signature (set of entities) which determines the module is the specified signature plus possibly all superclasses and/or subclasses of the classes therein. Sub-/superclasses are determined using the specified reasoner. The module will include annotation and declaration axioms for all entities and axioms in it.

Parameters:

sig - the seed signature (set of entities) 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
Admissible values for superClassLevel (analogously for subClassLevel):

• If superClassLevel greater than 0, then all classes C are included for which the class hierarchy computed by the reasoner contains a path of length at most superClassLevel downwards from C to some class from the signature.
• If superClassLevel = 0, then no super-/subclasses are added.
• If superClassLevel lesser than 0, then all direct and indirect super-/subclasses of any class in the signature are added.

reasoner - the reasoner to determine super-/subclasses. This can be an arbitrary reasoner, including a ToldClassHierarchyReasoner. It must have loaded the ontology. Can be null if superClassLevel and subClassLevel are 0.

verbose - true if verbose output is required

Returns:

the module

extractAsOntology

public OWLOntology extractAsOntology(Set<OWLEntity> signature,
                                     IRI iri)
                              throws OWLOntologyCreationException

Description copied from interface: OntologySegmenter

Returns an ontology that is a segment of the ontology associated with this segmenter.

Specified by:

extractAsOntology in interface OntologySegmenter

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:

OWLOntologyCreationException - if the module cannot be created

extractAsOntology

public OWLOntology extractAsOntology(Set<OWLEntity> signature,
                                     IRI iri,
                                     int superClassLevel,
                                     int subClassLevel,
                                     OWLReasoner reasoner)
                              throws OWLOntologyCreationException

Description copied from interface: OntologySegmenter

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.

Specified by:

extractAsOntology in interface OntologySegmenter

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:

OWLOntologyCreationException - if the module cannot be created Meaning of the value of superClassLevel, subClassLevel:
Let this value be k. If k greater than 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 lesser than 0, then all direct and indirect super-/subclasses of any class in the signature are added.