Package edu.fiu.jtlex.data

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

Author:
ceber003

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static class  ITimex.FunctionInDocument
    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 class  ITimex.TimexMod
    An enum that represents the twelve different Mod states an object may belong to.
    static class  ITimex.TimexType
    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 addInLink​(ILink link)
    Add a link to the set of IN links from this node.
    void addOutLink​(ILink link)
    Add a link to the set of OUT links from this node.
    int getAnchorTimeId()
    Returns the integer part of the anchortimeId.
    java.lang.String getAnchorTimeIdStr()
    Returns the string part of the anchortimeId.
    int getBeginPoint()
    Returns the integer part of the beginpointId.
    java.lang.String getBeginPointStr()
    Returns the string part of the beginpointId.
    int getEndPoint()
    Returns the integer part of the endpointId.
    java.lang.String getEndPointStr()
    Returns the string part of the endpointId.
    java.lang.String getFreq()
    Returns frequency String portion.
    ITimex.FunctionInDocument getFunction()
    Returns the function to which the object belongs.
    java.util.Set<ILink> getInLinks()
    Returns the set of TimeML links which come to this node.
    ITimex.TimexMod getMod()
    Returns the mod to which the object belongs.
    java.util.Set<ILink> getOutLinks()
    Returns the set of TimeML links which come from this node.
    java.lang.String getPhrase()
    Returns the phrase from the text annotated as timex.
    java.lang.String getQuant()
    Returns the quantity to which the object belongs.
    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.
    java.lang.String getValue()
    Returns the string representation of the value.
    void removeInLink​(ILink link)
    Removes a TimeML link from the set of links that end in this node.
    void removeOutLink​(ILink link)
    Removes a TimeML link from the set of links that start in this node.

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

    clone, equals, getId, getIdStr, getType, toJSON

  • Method Details

    • getValue

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

    • 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.
      See Also:
      ITimex.TimexMod

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

    • 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

    • getAnchorTimeIdStr

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

    • getFunction

      ITimex.FunctionInDocument 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.

    • 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

    • getBeginPointStr

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

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

    • getEndPointStr

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

    • getQuant

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

    • getFreq

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

    • getPhrase

      java.lang.String getPhrase()
      Returns the phrase from the text annotated as timex.
      Returns:
      the phrase from the text annotated as timex. 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.

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

    • getOutLinks

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

    • getInLinks

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

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

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