Package de.uni_mannheim.informatik.dws.melt.yet_another_alignment_api

Enum CorrespondenceRelation

java.lang.Object
java.lang.Enum<CorrespondenceRelation>
de.uni_mannheim.informatik.dws.melt.yet_another_alignment_api.CorrespondenceRelation
All Implemented Interfaces:
Serializable, Comparable<CorrespondenceRelation>, java.lang.constant.Constable
public enum CorrespondenceRelation extends Enum<CorrespondenceRelation>
Enumeration for the relations used in a Correspondence such as "equivalence"/"=".
Author:
Sven Hertling, Jan Portisch

  • Enum Constant Details

    • EQUIVALENCE

      public static final CorrespondenceRelation EQUIVALENCE
      Equivalence relation, when two concepts are exactly the same (has the same intension/semantic). Represents an OWL equivalence relation. Use the following symbol for textual representation: =.

    • SUBSUME

      public static final CorrespondenceRelation SUBSUME
      Represents a subsume / superclass of relation. Entity one (source/left) is "greater" than entity two (target/right). The source/left element is the super-class. The target/right element is the sub-class. Example: Person -subsume-> Student. This is the inverse relation of SUBSUMED. Use the following symbol for textual representation: >

    • SUBSUMED

      public static final CorrespondenceRelation SUBSUMED
      Represents a subsumed/rdfs:subClassOf relation. Entity one (source/left) is "smaller" than entity two (target/right). The source/left element is the sub-class. The target/right element is the super-class. Example: Student -subsumed-> Person. This is the inverse relation of SUBSUME. Use the following symbol for textual representation: <

    • NON_TRANSITIVE_IMPLICATION

      public static final CorrespondenceRelation NON_TRANSITIVE_IMPLICATION
      Non transitive implication relation (see work of C-OWL and others). Use the following symbol for textual representation: ~>

    • INSTANCE_OF

      public static final CorrespondenceRelation INSTANCE_OF
      The relation between an instance and class. Entity one (source/left) is the instance and entity two (target/right) is the class. This is the inverse relation of INSTANCE_OF. Use the following symbol for textual representation: InstanceOf

    • HAS_INSTANCE

      public static final CorrespondenceRelation HAS_INSTANCE
      Has instance relation which connects a class (source/left) to its instance (target/right). This is the inverse relation of INSTANCE_OF. Use the following symbol for textual representation: HasInstance

    • PART_OF

      public static final CorrespondenceRelation PART_OF
      Part of relation which connects two classes. The source/left class is a part of the target/right class. The source class is the part class whereas target is the whole class. Example: tire -partof-> car This is the inverse relation of HAS_A. Use the following symbol for textual representation: PartOf

    • HAS_A

      public static final CorrespondenceRelation HAS_A
      Has a relation which connects two classes. The target/right class is a part of the source/left class. The source class is the whole class whereas target is the part class. Example: car -has a-> tire This is the inverse relation of PART_OF. Use the following symbol for textual representation: HasA

    • CLOSE

      public static final CorrespondenceRelation CLOSE
      Close match relation meaning that two concepts are close to each other and can be used in some cases interchangeably. Use the following symbol for textual representation: Close

    • INCOMPAT

      public static final CorrespondenceRelation INCOMPAT
      Incompatiple relation meaning that two concepts should not be matched. Use the following symbol for textual representation: %

    • UNKNOWN

      public static final CorrespondenceRelation UNKNOWN
      Unkown relation which is used when something goes wrong or a reverse relation is not available. Use the following symbol for textual representation: ?

  • Field Details

    • prettyLabel

      private String prettyLabel

    • className

      private String className

    • rdfRepresentations

      private List<String> rdfRepresentations

    • mapping

      private static Map<String,CorrespondenceRelation> mapping
      Maps a string representatin to a CorrespondenceRelation.

  • Constructor Details

    • CorrespondenceRelation

      private CorrespondenceRelation(String prettyLabel, String className, String... rdfRepresentations)
      Constructor
      Parameters:
      prettyLabel - Human-readable, pretty label.
      className - Name of implementing class.

  • Method Details

    • values

      public static CorrespondenceRelation[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static CorrespondenceRelation valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • reverse

      public CorrespondenceRelation reverse()
      Reverses the current relation. If the relation is symmetric, the same relation will be returned.
      Returns:
      Reversed correspondence relation.

    • generateMapping

      private static Map<String,CorrespondenceRelation> generateMapping()
      Generates the mapping.
      Returns:
      mapping

    • parse

      public static CorrespondenceRelation parse(String label)
      Get a CorrespondenceRelation using a String representation (a.k.a. pretty label).
      Parameters:
      label - String representation fo the relation.
      Returns:
      CorrespondenceRelation if found - otherwise return UNKNOWN.

    • getPrettyLabel

      public String getPrettyLabel()

    • getClassName

      public String getClassName()

    • getRdfRepresentations

      public List<String> getRdfRepresentations()

    • getRdfRepresentation

      public String getRdfRepresentation()
      Return the most representative RDF relation or null if no relation is available. Favors skos relations which are mainly used in SSSOM format.
      Returns:
      most representative RDF relation or null if no relation is available.

    • toString

      public String toString()
      Returns the pretty printed label. This is used when serializing the mapping.
      Overrides:
      toString in class Enum<CorrespondenceRelation>
      Returns:
      the pretty printed label