com.clarkparsia.modularity

Class AbstractModuleExtractor

java.lang.Object

com.clarkparsia.modularity.AbstractModuleExtractor

All Implemented Interfaces:

ModuleExtractor

Direct Known Subclasses:

AxiomBasedModuleExtractor, GraphBasedModuleExtractor

public abstract class AbstractModuleExtractor
extends Object
implements ModuleExtractor

Title:

Description:

Copyright: Copyright (c) 2007

Company: Clark & Parsia, LLC.

Author:

Evren Sirin

Field Summary

Fields

Modifier and Type	Field and Description
protected EnumSet<org.mindswap.pellet.KnowledgeBase.ChangeType>	changes The types of changes that are pending in additions and deletions
protected Map<org.semanticweb.owlapi.model.OWLEntity,Set<org.semanticweb.owlapi.model.OWLAxiom>>	entityAxioms Map to find axioms that references an axiom
static Logger	log
protected Map<org.semanticweb.owlapi.model.OWLEntity,Set<org.semanticweb.owlapi.model.OWLEntity>>	modules

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractModuleExtractor()
protected	AbstractModuleExtractor(AbstractModuleExtractor extractor)
	AbstractModuleExtractor(com.clarkparsia.owlapi.modularity.locality.LocalityClass localityClass)

Method Summary

Modifier and Type	Method and Description
void	addAxiom(org.semanticweb.owlapi.model.OWLAxiom axiom) Adds an axiom to the extractor.
Set<org.semanticweb.owlapi.model.OWLEntity>	applyChanges(org.mindswap.pellet.taxonomy.Taxonomy<org.semanticweb.owlapi.model.OWLClass> taxonomy) Update the modules with the changes that have been put into the queue so far.
boolean	canUpdate() Returns if the extracted modules can be updated.
void	deleteAxiom(org.semanticweb.owlapi.model.OWLAxiom axiom) Deletes an axiom from the extractor.
void	extractModules() Extract modules from scratch
protected abstract void	extractModuleSignatures(Set<? extends org.semanticweb.owlapi.model.OWLEntity> entities, org.mindswap.pellet.utils.progress.ProgressMonitor monitor)
Set<org.semanticweb.owlapi.model.OWLAxiom>	getAxioms() Returns all the axioms loaded in the extractor.
Set<org.semanticweb.owlapi.model.OWLAxiom>	getAxioms(org.semanticweb.owlapi.model.OWLEntity entity) Return the axioms which references this entity
Set<org.semanticweb.owlapi.model.OWLEntity>	getEntities() Returns all the entities referenced in loaded axioms.
protected Set<org.semanticweb.owlapi.model.OWLAxiom>	getModuleAxioms(Set<org.semanticweb.owlapi.model.OWLEntity> signature)
Set<org.semanticweb.owlapi.model.OWLEntity>	getModuleEntities(org.semanticweb.owlapi.model.OWLEntity entity)
org.semanticweb.owlapi.model.OWLOntology	getModuleFromSignature(Set<org.semanticweb.owlapi.model.OWLEntity> signature) Returns a new ontology that contains the axioms that are in the module for given set of entities
org.mindswap.pellet.utils.Timers	getTimers() Returns the timers used by this extractor to collect statistics about performance.
boolean	isABoxChanged() Checks whether there are unapplied changes to the ABox
boolean	isChanged() Checks if axioms have been added/removed and modules need to be updated
boolean	isClassificationNeeded(com.clarkparsia.pellet.expressivity.Expressivity expressivity) Checks if the changes that has not yet been updated require re-classification
protected boolean	isLocal(org.semanticweb.owlapi.model.OWLAxiom axiom, Set<org.semanticweb.owlapi.model.OWLEntity> signature)
boolean	isRBoxChanged() Checks whether there are unapplied changes to the RBox
boolean	isTBoxChanged() Checks whether there are unapplied changes to the TBox
void	load(ZipInputStream inputStream) Restores the previously saved state of the ModuleExtractor from a stream.
void	resetModules()
void	save(ZipOutputStream outputStream) Save the current state of the ModuleExtractor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.clarkparsia.modularity.ModuleExtractor

copy, extractModule

Field Detail

log

public static final Logger log

changes

protected final EnumSet<org.mindswap.pellet.KnowledgeBase.ChangeType> changes

The types of changes that are pending in additions and deletions

entityAxioms

protected final Map<org.semanticweb.owlapi.model.OWLEntity,Set<org.semanticweb.owlapi.model.OWLAxiom>> entityAxioms

Map to find axioms that references an axiom

modules

protected Map<org.semanticweb.owlapi.model.OWLEntity,Set<org.semanticweb.owlapi.model.OWLEntity>> modules

Constructor Detail

AbstractModuleExtractor

public AbstractModuleExtractor()

AbstractModuleExtractor

public AbstractModuleExtractor(com.clarkparsia.owlapi.modularity.locality.LocalityClass localityClass)

AbstractModuleExtractor

protected AbstractModuleExtractor(AbstractModuleExtractor extractor)

Method Detail

addAxiom

public void addAxiom(org.semanticweb.owlapi.model.OWLAxiom axiom)

Description copied from interface: ModuleExtractor

Adds an axiom to the extractor.

Specified by:

addAxiom in interface ModuleExtractor

canUpdate

public boolean canUpdate()

Returns if the extracted modules can be updated. We can update the modules if we have computed modules and no non-local axiom has been added or deleted.

Specified by:

canUpdate in interface ModuleExtractor

Returns:

deleteAxiom

public void deleteAxiom(org.semanticweb.owlapi.model.OWLAxiom axiom)

Description copied from interface: ModuleExtractor

Deletes an axiom from the extractor.

Specified by:

deleteAxiom in interface ModuleExtractor

extractModules

public void extractModules()

Extract modules from scratch

Specified by:

extractModules in interface ModuleExtractor

extractModuleSignatures

protected abstract void extractModuleSignatures(Set<? extends org.semanticweb.owlapi.model.OWLEntity> entities,
                                                org.mindswap.pellet.utils.progress.ProgressMonitor monitor)

getAxioms

public Set<org.semanticweb.owlapi.model.OWLAxiom> getAxioms(org.semanticweb.owlapi.model.OWLEntity entity)

Return the axioms which references this entity

Specified by:

getAxioms in interface ModuleExtractor

Parameters:

entity -

Returns:

getModuleEntities

public Set<org.semanticweb.owlapi.model.OWLEntity> getModuleEntities(org.semanticweb.owlapi.model.OWLEntity entity)

Specified by:

getModuleEntities in interface ModuleExtractor

getModuleAxioms

protected Set<org.semanticweb.owlapi.model.OWLAxiom> getModuleAxioms(Set<org.semanticweb.owlapi.model.OWLEntity> signature)

getModuleFromSignature

public org.semanticweb.owlapi.model.OWLOntology getModuleFromSignature(Set<org.semanticweb.owlapi.model.OWLEntity> signature)

Returns a new ontology that contains the axioms that are in the module for given set of entities

Specified by:

getModuleFromSignature in interface ModuleExtractor

Parameters:

signature -

Returns:

Throws:

org.semanticweb.owlapi.model.OWLException

isChanged

public boolean isChanged()

Checks if axioms have been added/removed and modules need to be updated

Specified by:

isChanged in interface ModuleExtractor

Returns:

true if axioms have been added/removed

isLocal

protected boolean isLocal(org.semanticweb.owlapi.model.OWLAxiom axiom,
                          Set<org.semanticweb.owlapi.model.OWLEntity> signature)

applyChanges

public Set<org.semanticweb.owlapi.model.OWLEntity> applyChanges(org.mindswap.pellet.taxonomy.Taxonomy<org.semanticweb.owlapi.model.OWLClass> taxonomy)
                                                         throws UnsupportedOperationException

Description copied from interface: ModuleExtractor

Update the modules with the changes that have been put into the queue so far.

Specified by:

applyChanges in interface ModuleExtractor

Returns:

The set of entities whose modules are affected by the changes

Throws:

UnsupportedOperationException - if modules cannot be updated as reported by ModuleExtractor.canUpdate() function

getTimers

public org.mindswap.pellet.utils.Timers getTimers()

Description copied from interface: ModuleExtractor

Returns the timers used by this extractor to collect statistics about performance.

Specified by:

getTimers in interface ModuleExtractor

Returns:

getAxioms

public Set<org.semanticweb.owlapi.model.OWLAxiom> getAxioms()

Description copied from interface: ModuleExtractor

Returns all the axioms loaded in the extractor.

Specified by:

getAxioms in interface ModuleExtractor

Returns:

an unmodifiable set of axioms

getEntities

public Set<org.semanticweb.owlapi.model.OWLEntity> getEntities()

Description copied from interface: ModuleExtractor

Returns all the entities referenced in loaded axioms.

Specified by:

getEntities in interface ModuleExtractor

Returns:

an unmodifiable set of entities

resetModules

public void resetModules()

isClassificationNeeded

public boolean isClassificationNeeded(com.clarkparsia.pellet.expressivity.Expressivity expressivity)

Description copied from interface: ModuleExtractor

Checks if the changes that has not yet been updated require re-classification

Specified by:

isClassificationNeeded in interface ModuleExtractor

Returns:

true if classification is needed, false otherwise

isTBoxChanged

public boolean isTBoxChanged()

Checks whether there are unapplied changes to the TBox

Returns:

true if there are unapplied changes to TBox

isRBoxChanged

public boolean isRBoxChanged()

Checks whether there are unapplied changes to the RBox

Returns:

true if there are unapplied changes to RBox

isABoxChanged

public boolean isABoxChanged()

Checks whether there are unapplied changes to the ABox

Returns:

true if there are unapplied changes to ABox

save

public void save(ZipOutputStream outputStream)
          throws IOException,
                 IllegalStateException

Description copied from interface: ModuleExtractor

Save the current state of the ModuleExtractor. The output is saved to a ZipOutputStream to allow storage in multiple files in one stream.

Specified by:

save in interface ModuleExtractor

Parameters:

outputStream - the zip output stream where the data should be stored

Throws:

IOException - if an I/O error occurs during the saving

IllegalStateException - if there are outstanding changes that have not yet been applied to the modules (e.g., via updateModules())

load

public void load(ZipInputStream inputStream)
          throws IOException,
                 IllegalArgumentException

Description copied from interface: ModuleExtractor

Restores the previously saved state of the ModuleExtractor from a stream. The input is read from a ZipInputStream because the data may potentially span multiple files. The method assumes that the zip file entries saved by the save() method are the immediately next ones in the stream.

Specified by:

load in interface ModuleExtractor

Parameters:

inputStream - the zip input stream from which the data should be read

Throws:

IOException - if an I/O error occurs during the read

IllegalArgumentException - if the next zip file entry in the stream was not saved by a compatible ModuleExtractor