Interface ITimeMLSignal

All Known Implementing Classes:
TimeMLSignal

public interface ITimeMLSignal
Represents the signal tag.

A signal is a textual element that makes explicit the relation holding between two entities (timex and event, timex and timex, or event and event). Signals are generally:

  • Temporal prepositions: on, in, at, from, to, before, after, during, etc.
  • Temporal conjunctions: before, after, while, when, etc.
  • Prepositions signaling modality: to.
  • Special characters: X-X and X/X, in temporal expressions denoting ranges (September 4-6, Apr. 1999/Jul. 1999, etc.).
Since:
jTLEX 1.0
Author:
arada002
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a deep copy of the Signal.
    boolean
    Checks if this Signal equals an object.
    int
    Returns a unique signal ID number.
    Returns a unique signal ID string.
    Returns the temporal preposition, conjunction or modifier phrase.
    int
    Generates a hash code for the signal.
    Returns the JSON (RFC 8259) representation of the Signal.
    Returns the String representation of the Signal.
  • Method Details

    • getID

      int getID()
      Returns a unique signal ID number.
      Returns:
      a unique signal ID number. May not return less than 1
      Since:
      jTLEX 1.0
    • getIdStr

      String getIdStr()
      Returns a unique signal ID string.
      Returns:
      a unique signal ID string. May not return null.
      Since:
      jTLEX 1.0
    • getSignalString

      String getSignalString()
      Returns the temporal preposition, conjunction or modifier phrase.
      Returns:
      the temporal preposition, conjunction or modifier phrase. May not return null.
      Since:
      jTLEX 1.0
    • toString

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

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

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

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

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