org.semanticweb.owlapi.util

Class OWLOntologyChangeFilter

java.lang.Object

org.semanticweb.owlapi.util.OWLAxiomVisitorAdapter

org.semanticweb.owlapi.util.OWLOntologyChangeFilter

All Implemented Interfaces:

OWLAnnotationAxiomVisitor, OWLAxiomVisitor

Direct Known Subclasses:

FilteringOWLOntologyChangeListener

public class OWLOntologyChangeFilter
extends OWLAxiomVisitorAdapter
implements OWLAxiomVisitor

Provides a convenient method to filter add/remove axiom changes based on the type of axiom that is being added or removed from an ontology.
The general pattern of use is to simply create an instance of the OWLOntologyChangeFilter and override the appropriate visit methods corresponding to the types of axioms that are of interest. Each visit corresponds to a single change and the isAdd or isRemove methods can be used to determine if the axiom corresponding to the change is being added or removed from an ontology - the ontology can be obtained via the getOntology method.
Example: Suppose we are interested in changes that alter the domain of an object property. We receive a list of changes, ontChanges, from an ontology change listener. We can use the OWLOntologyChangeFilter to filter out the changes that alter the domain of an object property in the following way:

 OWLOntologyChangeFilter filter = new OWLOntologyChangeFilter() {
 

      // Override the object property domain visit method
      public void visit(OWLObjectPropertyDomainAxiom axiom) {
          // Determine if the axiom is being added or removed
          if(isAdd()) {
              // Get hold of the ontology that the change applied to
              OWLOntology ont = getOntology();
              // Do something here
          }
      }
 }
 // Process the list of changes
 filter.processChanges(ontChanges);
 

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 17-Dec-2006

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	add
protected OWLOntologyChangeVisitor	changeVisitor
protected OWLOntology	ontology

Constructor Summary

Constructors

Constructor and Description
OWLOntologyChangeFilter() default constructor

Method Summary

Modifier and Type	Method and Description
protected OWLOntology	getOntology() Gets the ontology which the current change being visited was applied to.
protected boolean	isAdd()
protected boolean	isRemove()
protected void	processChange(OWLAxiomChange change)
void	processChanges(List<? extends OWLOntologyChange> changes)

Methods inherited from class org.semanticweb.owlapi.util.OWLAxiomVisitorAdapter

handleDefault, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.semanticweb.owlapi.model.OWLAxiomVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from interface org.semanticweb.owlapi.model.OWLAnnotationAxiomVisitor

visit, visit, visit, visit

Field Detail

add

protected boolean add

ontology

protected OWLOntology ontology

changeVisitor

protected final OWLOntologyChangeVisitor changeVisitor

Constructor Detail

OWLOntologyChangeFilter

public OWLOntologyChangeFilter()

default constructor

Method Detail

processChanges

public void processChanges(List<? extends OWLOntologyChange> changes)

Parameters:

changes - changes to process

processChange

protected void processChange(OWLAxiomChange change)

isAdd

protected boolean isAdd()

Returns:

Determines if the current change caused an axiom to be added to an ontology.

isRemove

protected boolean isRemove()

Returns:

Determines if the current change caused an axiom to be removed from an ontology.

getOntology

protected OWLOntology getOntology()

Gets the ontology which the current change being visited was applied to.

Returns:

The ontology or null if the filter is not in a change visit cycle. When called from within a visit method, the return value is guarenteed not to be null.