Class AnnotationVisitor<T>

java.lang.Object
org.incenp.obofoundry.sssom.owl.AnnotationVisitor<T>
All Implemented Interfaces:
ISlotVisitor<T>
public class AnnotationVisitor<T> extends Object implements ISlotVisitor<T>
A mapping slots visitor that converts mapping metadata to OWL annotations.

  • Method Details

    • renderURISlotsAsResources

      public void renderURISlotsAsResources(boolean value)
      Specifies whether URI-typed slots (e.g., sssom:license) should be rendered as IRI-identified resources rather than as xsd:anyURI literals.

      URI-typed slots are rendered as resources in the RDF serialisation, so it seems logical that they should be rendered similarly in the OWL serialisation. But that has not been decided yet, so for now we support both.

      Parameters:
      value - If true, URI-typed slots are rendered as IRIs.

    • renderExtensionSlots

      public void renderExtensionSlots(boolean value)
      Specifies whether extension slots should be rendered as well as standard slots.

      The default behaviour is to render extension slots.

      Parameters:
      value - If false, extension slots will not be rendered.

    • annotate

      public org.semanticweb.owlapi.model.OWLAxiom annotate(org.semanticweb.owlapi.model.OWLAxiom axiom)
      Annotates an axiom with the annotations generated from the visited slots.
      Parameters:
      axiom - The axiom to annotate.
      Returns:
      The annotated axiom.

    • annotate

      public org.semanticweb.owlapi.model.OWLAxiom annotate(org.semanticweb.owlapi.model.OWLAxiom axiom, boolean reset)
      Annotates an axiom with the annotations generated from the visited slots.
      Parameters:
      axiom - The axiom to annotate.
      reset - If true, reset this visitor after annotating the axiom, so that it is ready to visit the slots of another object.
      Returns:
      The annotated axiom.

    • annotate

      public void annotate(org.semanticweb.owlapi.model.OWLOntology ontology)
      Annotates an ontology with the annotations generated from the visited slots.
      Parameters:
      ontology - The ontology to annotate.

    • annotate

      public void annotate(org.semanticweb.owlapi.model.OWLOntology ontology, boolean reset)
      Annotates an ontology with the annotations generated from the visited slots.
      Parameters:
      ontology - The ontology to annotate.
      reset - If true, reset this visitor after annotating the ontology, so that it is ready to visit the slots of another object.

    • reset

      public void reset()
      Resets this visitor. This clears all accumulated annotations from previously visited slots.

    • visit

      public void visit(StringSlot<T> slot, T object, String value)
      Description copied from interface: ISlotVisitor
      Visits a string-typed slot.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(StringSlot<T> slot, T object, List<String> values)
      Description copied from interface: ISlotVisitor
      Visits a multi-valued string-typed slot.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      values - The values of the slot.

    • visit

      public void visit(URISlot<T> slot, T object, String value)
      Description copied from interface: ISlotVisitor
      Visits a URI-typed slot.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(URISlot<T> slot, T object, List<String> values)
      Description copied from interface: ISlotVisitor
      Visits a multi-valued URI-typed slot.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      values - The values of the slot.

    • visit

      public void visit(EntityReferenceSlot<T> slot, T object, String value)
      Description copied from interface: ISlotVisitor
      Visits a slot that holds an entity reference.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(EntityReferenceSlot<T> slot, T object, List<String> values)
      Description copied from interface: ISlotVisitor
      Visits a multi-valued slot that holds entity references.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      values - The values of the slot.

    • visit

      public void visit(DoubleSlot<T> slot, T object, Double value)
      Description copied from interface: ISlotVisitor
      Visits a double-typed slot.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(DateSlot<T> slot, T object, LocalDate value)
      Description copied from interface: ISlotVisitor
      Visits a date-typed slot.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(Slot<T> slot, T mapping, Object value)
      Description copied from interface: ISlotVisitor
      Visits a generic slot.

      This method is normally not used as all slots in a SSSOM object have more precise types. But it can be used to implement behaviours that should be common to several slot types.

      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      mapping - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(ExtensionSlot<T> slot, T object, Map<String, ExtensionValue> values)
      Description copied from interface: ISlotVisitor
      Visits a slot that holds extension values (non-standard metadata).
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      values - The values of the slot.

    • visit

      public void visit(EntityTypeSlot<T> slot, T object, EntityType value)
      Description copied from interface: ISlotVisitor
      Visits a slot that holds an entity type enumeration value.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(MappingCardinalitySlot<T> slot, T object, MappingCardinality value)
      Description copied from interface: ISlotVisitor
      Visits a slot that holds a mapping cardinality enumeration value.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(PredicateModifierSlot<T> slot, T object, PredicateModifier value)
      Description copied from interface: ISlotVisitor
      Visits a slot that holds a predicate modifier enumeration value.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(CurieMapSlot<T> slot, T object, Map<String,String> value)
      Description copied from interface: ISlotVisitor
      Visits a slot that holds a curie map.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      value - The value of the slot.

    • visit

      public void visit(ExtensionDefinitionSlot<T> slot, T object, List<ExtensionDefinition> values)
      Description copied from interface: ISlotVisitor
      Visits a slot that holds a list of extension definitions for non-standard metadata.
      Specified by:
      visit in interface ISlotVisitor<T>
      Parameters:
      slot - The slot that is being visited.
      object - The object to which the slot is attached.
      values - The values of the slot.