Package edu.fiu.jtlex.data

Interface ILink

All Known Implementing Classes:
Link
public interface ILink
Interface of Link attributes shared by 3 Links (TLink,SLink,ALink).
Author:
Pablo Maldonado

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static class  ILink.ALinkType
    Enum that represents the temporal relation holding between the entities for ALink.
    static class  ILink.LinkTag
    Enum that represents the type of link.
    static class  ILink.Origintype
    Enum that represents whether the TLink was generated manually or by closure.
    static class  ILink.SLinkType
    Enum that represents the temporal relation holding between the entities for SLink.
    static class  ILink.TLinkType
    Enum that represents temporal relation holding between the entities for a TLink.

  • Method Summary

    Modifier and Type Method Description
    ILink clone()
    Returns a deep copy of the Link.
    INode getEventInstance()
    Returns the ID of the event instance involved in the link.
    int getLinkID()
    Returns the ID of the link.
    ILink.LinkTag getLinkTag()
    Returns the type of Link.
    ILink.Origintype getOrigin()
    Returns whether a TLINK was generated MANUALLY or by CLOSURE.
    INode getRelatedToNode()
    Returns the ID of the entity that is being related to the event instance with ID=eventInstanceID or time expression with ID=timeID.
    ILinkType getRelType()
    This is the temporal relation holding between the entities.
    ISignal getSignal()
    Returns the ID of the relation signal.
    java.lang.String getSyntax()
    Returns the syntax of the link.
    int hashCode()
    java.lang.String toJSON()
    Returns the JSON (RFC 8259) representation of the Link.

  • 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.

    • getLinkTag

      ILink.LinkTag getLinkTag()
      Returns the type of Link.
      Returns:
      ILink.LinkTag.TLINK / ILink.LinkTag.ALINK / ILink.LinkTag.SLINK

    • getSyntax

      java.lang.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.

    • getEventInstance

      INode getEventInstance()
      Returns the ID of the event instance involved in the link. OBLIGATORY
      Returns:
      the ID of the event instance involved in the link.

    • getSignal

      ISignal 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.

    • getOrigin

      ILink.Origintype 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

    • getRelatedToNode

      INode 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.

    • getRelType

      ILinkType 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
      See Also:
      ILink.ALinkType, ILink.SLinkType, ILink.TLinkType

    • hashCode

      int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toJSON

      java.lang.String toJSON()
      Returns the JSON (RFC 8259) representation of the Link.
      Returns:
      the JSON (RFC 8259) representation of the Link.

    • clone

      ILink clone()
      Returns a deep copy of the Link.
      Returns:
      a deep copy of the Link.