Interface ITimex

All Superinterfaces:
INode
All Known Implementing Classes:
Timex

public interface ITimex extends INode
Represents the TIME tag.

This assumes usage of TimeML TIMEX3 standards;
"Since the details of the tag set that TimeML uses to annotate temporal expressions differ in detail both from the TIMEX tag in STAG (Sheffield Temporal Annotation Guidelines) and the TIMEX2 tag in TIDES, we here use the tag name TIMEX3 for temporal expressions."
-TimeML Annotation Guidelines Version 1.2.1

Since:
Revision 35
Author:
ceber003
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    An enum that represents the seven different functions an object may belong to.
    Function may belong to: CREATION_TIMEMODIFICATION_TIME PUBLICATION_TIMERELEASE_TIMERECEPTION_TIME EXPIRATION_TIMENONE
    static enum 
    An enum that represents the twelve different Mod states an object may belong to.
    static enum 
    An enum that represents the four different types an object may belong to.
    Timex may belong to: DATETIME DURATIONSET type
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Add a link to the set of IN links from this node.
    void
    Add a link to the set of OUT links from this node.
    Creates and returns a copy of the Timex.
    int
    Returns the integer part of the anchortimeId.
    Returns the string part of the anchortimeId.
    int
    Returns the integer part of the beginpointId.
    Returns the string part of the beginpointId.
    int
    Returns the integer part of the endpointId.
    Returns the string part of the endpointId.
    Returns frequency String portion.
    Returns the function to which the object belongs.
    int
    Returns the integer part of the tID.
    Returns the tID.
    Returns the set of TimeML links which come to this node.
    Returns the mod to which the object belongs.
    Returns the set of TimeML links which come from this node.
    Returns the phrase from the text annotated as timex.
    Returns the quantity to which the object belongs.
    boolean
    Returns the inary attribute which expresses that the value of the temporal expression needs to be determined via evaluation of a temporal function.
    Returns the type of the timex.
    Returns the string representation of the value.
    void
    Removes a TimeML link from the set of links that end in this node.
    void
    Removes a TimeML link from the set of links that start in this node.
    Returns the JSON (RFC 8259) representation of the Timex.
    Returns the info of the Timex in String format.

    Methods inherited from interface edu.fiu.jtlex.data.INode

    equals
  • Method Details

    • getId

      int getId()
      Returns the integer part of the tID. Will never be null as it is required for the constructor.
      Specified by:
      getId in interface INode
      Returns:
      the tID of the timex.
      Since:
      Revision 35
    • getIdStr

      String getIdStr()
      Returns the tID. Will never be null since the tID was required in the constructor.
      Specified by:
      getIdStr in interface INode
      Returns:
      the String representation of the ID.
      Since:
      Revision 35
    • getType

      ITimex.TimexType getType()
      Returns the type of the timex.
      Specified by:
      getType in interface INode
      Returns:
      the type of the timex.
      Since:
      Revision 35
    • getValue

      String getValue()
      Returns the string representation of the value. The value of the the timex tag determines what the actual amount of time for the date, time, duration, and set types.
      Returns:
      the string representation of the value. May not be null.
      Since:
      Revision 35
    • getMod

      ITimex.TimexMod getMod()
      Returns the mod to which the object belongs. This value is optional.
      Returns:
      the mod to which the object belongs. May be null.
      Since:
      Revision 35
      See Also:
    • getTemporalFunction

      boolean getTemporalFunction()
      Returns the inary attribute which expresses that the value of the temporal expression needs to be determined via evaluation of a temporal function.
      Returns:
      the inary attribute which expresses that the value of the temporal expression needs to be determined via evaluation of a temporal function.
      Since:
      Revision 90
    • getAnchorTimeId

      int getAnchorTimeId()
      Returns the integer part of the anchortimeId. Each anchortime has to be identified by a unique ID number. This value is optional.
      Returns:
      the integer part of the anchortimeId. May not be negative
      Since:
      Revision 35
    • getAnchorTimeIdStr

      String getAnchorTimeIdStr()
      Returns the string part of the anchortimeId. Each anchortime has to be identified by a unique ID number. This value is optional.
      Returns:
      the string part of the anchortimeId. May not be null.
      Since:
      Revision 35
    • getFunction

      Returns the function to which the object belongs. Function in document can be one of seven values. If it is not specified then it will be set as 'NONE' by default.
      Returns:
      the function to which the object belongs. May be null.
      Since:
      Revision 35
    • getBeginPoint

      int getBeginPoint()
      Returns the integer part of the beginpointId. Beginpoint is only used if the expression is anchored to another timex expression. Each beginpoint has to be identified by a unique ID number. If only endpoint is provided may create an empty timex to fill in.
      Returns:
      the integer part of the beginpointId. May not be negative
      Since:
      Revision 35
    • getBeginPointStr

      String getBeginPointStr()
      Returns the string part of the beginpointId. Beginpoint is only used if the expression is anchored to another timex expression. Each beginpoint has to be identified by a unique ID number. If only endpoint is provided may create an empty timex to fill in.
      Returns:
      the string part of the beginpointId. May not be null.
      Since:
      Revision 35
    • getEndPoint

      int getEndPoint()
      Returns the integer part of the endpointId. Endpoint is only used if the expression is anchored to another timex expression. Each endpoint has to be identified by a unique ID number. If only beginpoint is provided may create an empty timex to fill in.
      Returns:
      the integer part of the endpointId. May not be negative.
      Since:
      Revision 35
    • getEndPointStr

      String getEndPointStr()
      Returns the string part of the endpointId. Endpoint is only used if the expression is anchored to another timex expression. Each endpoint has to be identified by a unique ID number. If only beginpoint is provided may create an empty timex to fill in.
      Returns:
      the string part of the endpointId. May not be null.
      Since:
      Revision 35
    • getQuant

      String getQuant()
      Returns the quantity to which the object belongs. The quant value is only used if the timex type is 'SET'.
      Returns:
      the quantity to which the object belongs. May be null.
      Since:
      Revision 35
    • getFreq

      String getFreq()
      Returns frequency String portion. The frequency value is only used if the timex type is 'SET'. The integer value determines the number of time the frequency takes. i.e: 2 Weeks, 3 Months, 1 Day, etc.
      Returns:
      frequency String portion. May be null.
      Since:
      Revision 35
    • getPhrase

      String getPhrase()
      Returns the phrase from the text annotated as timex.
      Returns:
      the phrase from the text annotated as timex.
      Since:
      Revision 90 May be null.
    • addOutLink

      void addOutLink(ILink link)
      Add a link to the set of OUT links from this node.
      Specified by:
      addOutLink in interface INode
      Parameters:
      link - : A new OUT link from this node.
      Since:
      Revision 769
    • addInLink

      void addInLink(ILink link)
      Add a link to the set of IN links from this node.
      Specified by:
      addInLink in interface INode
      Parameters:
      link - : A new IN link incoming to this node.
      Since:
      Revision 769
    • getOutLinks

      Set<ILink> getOutLinks()
      Returns the set of TimeML links which come from this node.
      Specified by:
      getOutLinks in interface INode
      Returns:
      the set of TimeML links which come from this node.
      Since:
      Revision 769
    • getInLinks

      Set<ILink> getInLinks()
      Returns the set of TimeML links which come to this node.
      Specified by:
      getInLinks in interface INode
      Returns:
      the set of TimeML links which come to this node.
      Since:
      Revision 769
    • removeOutLink

      void removeOutLink(ILink link)
      Removes a TimeML link from the set of links that start in this node.
      Specified by:
      removeOutLink in interface INode
      Parameters:
      link - a new OUT link to remove from the set of outgoing links.
      Since:
      Revision 769
    • removeInLink

      void removeInLink(ILink link)
      Removes a TimeML link from the set of links that end in this node.
      Specified by:
      removeInLink in interface INode
      Parameters:
      link - a new In link to remove from the set of incoming links.
      Since:
      Revision 769
    • toString

      String toString()
      Returns the info of the Timex in String format.
      Overrides:
      toString in class Object
      Returns:
      the info of the Timex in String format.
      Since:
      Revision 386
    • toJSON

      String toJSON()
      Returns the JSON (RFC 8259) representation of the Timex. Will never return null.
      Specified by:
      toJSON in interface INode
      Returns:
      the JSON format of the Timex.
      Since:
      Revision 391
    • clone

      Timex clone()
      Creates and returns a copy of the Timex. Will never return null.
      Specified by:
      clone in interface INode
      Returns:
      a copy of the Timex.
      Since:
      Revision 394