Interface ITimeMLLink

All Known Implementing Classes:
TimeMLLink

public interface ITimeMLLink
Interface of Link attributes shared by 3 Links (TLink,SLink,ALink).
Since:
jTLEX 1.0
Author:
Pablo Maldonado
  • Method Details

    • getLinkID

      int getLinkID()
      Returns the ID of the link.
      Link ID gives each TimeML link an identification number OPTIONAL
      Returns:
      the ID of the link.
      Since:
      jTLEX 1.0
    • getLinkTag

      Class<ITimeMLLink> getLinkTag()
      Returns the type of Link.
      Returns:
      ITimeMLLink.TLink / ITimeMLLink.ALink / ITimeMLLink.SLink
      Since:
      jTLEX 1.0
    • getSyntax

      String getSyntax()
      Returns the syntax of the link.
      Syntax holds any syntactic pattern that was used in generating the link (e.g. from an automatic annotation tool).
      OPTIONAL
      Returns:
      the syntax of the link.
      Since:
      jTLEX 1.0
    • getEventInstance

      String getEventInstance()
      Returns the ID of the event instance involved in the link. OBLIGATORY
      Returns:
      the ID of the event instance involved in the link.
      Since:
      jTLEX 1.0
    • getSignal

      ITimeMLSignal getSignal()
      Returns the ID of the relation signal.
      If the temporal relation holding between the entities is explicitly signaled in the text, then the ID of that signal needs to be supplied here.
      OPTIONAL
      Returns:
      the optional ID of the relation signal.
      Since:
      jTLEX 1.0
    • getOrigin

      Returns whether a TLINK was generated MANUALLY or by CLOSURE.
      THIS IS ONLY FOR TLINK
      Returns:
      Whether link was generated MANUALLY or by CLOSURE
      Since:
      jTLEX 1.0
    • getRelatedToNode

      String getRelatedToNode()
      Returns the ID of the entity that is being related to the event instance with ID=eventInstanceID or time expression with ID=timeID.
      relatedToEventInstance or relatedToTime needs to be present.
      Returns:
      the ID of the entity that is being related to the event instance with ID=eventInstanceID or time expression with ID=timeID.
      Since:
      jTLEX 1.0
    • getRelType

      This is the temporal relation holding between the entities.
      These are represented by 3 different enums:
      • ALinkRelType
      • SLinkRelType
      • TLinkRelType

      The returned type depends on the linkTag.
      Returns:
      ALinkRelType / SLinkRelType / TLinkRelType
      Since:
      jTLEX 1.0
      See Also:
    • toString

      String toString()
      Returns the String representation of the Link.
      Overrides:
      toString in class Object
      Returns:
      the String representation of the Link.
      Since:
      jTLEX 1.0
    • toJson

      String toJson()
      Returns the JSON (RFC 8259) representation of the Link.
      Returns:
      the JSON (RFC 8259) representation of the Link.
      Since:
      jTLEX 1.0
    • clone

      ITimeMLLink clone()
      Returns a deep copy of the Link.
      Returns:
      a deep copy of the Link.
      Since:
      jTLEX 1.0
    • hashCode

      int hashCode()
      Generates a hash code for the link.
      Overrides:
      hashCode in class Object
      Returns:
      The hash code.
      Since:
      jTLEX 1.0
    • equals

      boolean equals(Object o)
      Checks if this link equals an object.
      Overrides:
      equals in class Object
      Parameters:
      o - The object to compare against.
      Returns:
      True if both links are equal, i.e. same ID and tag, or else false.
      Throws:
      NullPointerException - If the object to compare against is false.
      Since:
      jTLEX 1.0