com.clarkparsia.modularity

Interface ModuleExtractor

All Known Implementing Classes:

AbstractModuleExtractor, AxiomBasedModuleExtractor, GraphBasedModuleExtractor

public interface ModuleExtractor

Title:

Description:

Copyright: Copyright (c) 2008

Company: Clark & Parsia, LLC.

Author:

Evren Sirin

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.
ModuleExtractor	copy()
void	deleteAxiom(org.semanticweb.owlapi.model.OWLAxiom axiom) Deletes an axiom from the extractor.
Set<org.semanticweb.owlapi.model.OWLAxiom>	extractModule(Set<? extends org.semanticweb.owlapi.model.OWLEntity> signature) Extract the module for a given set of entities.
void	extractModules() Extract modules for all classes from scratch
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.
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	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
void	load(ZipInputStream inputStream) Restores the previously saved state of the ModuleExtractor from a stream.
void	save(ZipOutputStream outputStream) Save the current state of the ModuleExtractor.

Method Detail

copy

ModuleExtractor copy()

addAxiom

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

Adds an axiom to the extractor.

canUpdate

boolean canUpdate()

Returns if the extracted modules can be updated. Returns false if the initial module extraction has not been performed yet.

Returns:

deleteAxiom

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

Deletes an axiom from the extractor.

Parameters:

axiom -

extractModules

void extractModules()

Extract modules for all classes from scratch

getAxioms

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

Returns all the axioms loaded in the extractor.

Returns:

an unmodifiable set of axioms

getAxioms

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

Return the axioms which references this entity

Parameters:

entity -

Returns:

getEntities

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

Returns all the entities referenced in loaded axioms.

Returns:

an unmodifiable set of entities

getModuleEntities

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

getModuleFromSignature

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

Parameters:

signature -

Returns:

Throws:

org.semanticweb.owlapi.model.OWLException

getTimers

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

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

Returns:

isChanged

boolean isChanged()

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

Returns:

true if axioms have been added/removed

isClassificationNeeded

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

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

Returns:

true if classification is needed, false otherwise

applyChanges

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

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

Returns:

The set of entities whose modules are affected by the changes

Throws:

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

extractModule

Set<org.semanticweb.owlapi.model.OWLAxiom> extractModule(Set<? extends org.semanticweb.owlapi.model.OWLEntity> signature)

Extract the module for a given set of entities.

Parameters:

signature - set of entities

Returns:

module for the given signature

save

void save(ZipOutputStream outputStream)
   throws IOException,
          IllegalStateException

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

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

void load(ZipInputStream inputStream)
   throws IOException,
          IllegalArgumentException

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.

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