Class EntityDeprecator

java.lang.Object
org.incenp.obofoundry.kgcl.owl.EntityDeprecator
public class EntityDeprecator extends Object
Deprecates entities within an ontology.

This class provides a configurable way of deprecating entities. The configuration is based on Protégé’s concept of ”deprecation profile”.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EntityDeprecator(org.semanticweb.owlapi.model.OWLOntology ontology)
    Creates a new instance with the default deprecation profile.
    EntityDeprecator(org.semanticweb.owlapi.model.OWLOntology ontology, org.incenp.obofoundry.kgcl.model.DeprecationProfile profile)
    Creates a new instance with the given deprecation profile.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    deprecate(org.semanticweb.owlapi.model.IRI target, org.semanticweb.owlapi.model.IRI replacement, Set<org.semanticweb.owlapi.model.IRI> alternatives, Set<org.semanticweb.owlapi.model.OWLAxiom> removed, Set<org.semanticweb.owlapi.model.OWLAxiom> added)
    Deprecates an entity.

    Methods inherited from class Object

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

  • Constructor Details

    • EntityDeprecator

      public EntityDeprecator(org.semanticweb.owlapi.model.OWLOntology ontology)
      Creates a new instance with the default deprecation profile.

      The default deprecation profile corresponds to the original behaviour of KGCL-Java.

      Parameters:
      ontology - The ontology in which entities are to be deprecated.

    • EntityDeprecator

      public EntityDeprecator(org.semanticweb.owlapi.model.OWLOntology ontology, org.incenp.obofoundry.kgcl.model.DeprecationProfile profile)
      Creates a new instance with the given deprecation profile.
      Parameters:
      ontology - The ontology in which entities are to be deprecated.
      profile - The deprecation profile to use.

  • Method Details

    • deprecate

      public void deprecate(org.semanticweb.owlapi.model.IRI target, org.semanticweb.owlapi.model.IRI replacement, Set<org.semanticweb.owlapi.model.IRI> alternatives, Set<org.semanticweb.owlapi.model.OWLAxiom> removed, Set<org.semanticweb.owlapi.model.OWLAxiom> added)
      Deprecates an entity.
      Parameters:
      target - The IRI of the entity to deprecate.
      replacement - The IRI of the entity that directly replaces the entity to deprecate. May be null.
      alternatives - The IRIs of the entities that are potential (non-direct) replacements for the entity to deprecate. May be null.
      removed - This will receive the axioms that are to be removed from the ontology.
      added - This will receive the axioms that are to be added to the ontology.