Interface ITimeMLEvent

All Known Implementing Classes:
TimeMLEvent

public interface ITimeMLEvent
Represents the EVENT tag.

We consider "events" a cover term for situations that happen or occur. Events can be punctual (1-2) or last for a period of time (3-4). We also consider as events those predicates describing states or circumstances in which something obtains or holds true (5). Not all stative predicates will be marked up, however.

  1. Ferdinand Magellan, a Portuguese explorer, first reached the islands in search of spices.
  2. A fresh flow of lava, gas and debris erupted there Saturday.
  3. 11,024 people, including local Aeta aborigines, were evacuated to 18 disaster relief centers.
  4. We are expecting a major eruption, he said in a telephone interview early today.
  5. Israel has been scrambling to buy more masks abroad, after a shortage of several hundred thousand gas masks.
Since:
jTLEX 1.0
Author:
arada002
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    An enum that represents the seven different event classes an object may belong to.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a field-by-field copy of the event.
    boolean
    Checks if this event equals an object.
    Returns the event class to which the object belongs.
    int
    Returns the integer part of the eventId.
    Returns the full string representation of the eventID.
    Returns the IDs of the instances related to the Event.
    Returns the stem of the event.
    int
    Generates a hash code for the event.
    void
    Sets the related Instance for the event.
    Returns the JSON (RFC 8259) representation of the event.
    Returns the String Representation of the Event.
  • Method Details

    • getId

      int getId()
      Returns the integer part of the eventId. Each event has to be identified by a unique ID number and String.
      Returns:
      Integer part of the eventID. May not be 0 or negative.
      Since:
      jTLEX 1.0
    • getIdStr

      String getIdStr()
      Returns the full string representation of the eventID. Each event has to be identified by a unique ID number and String.
      Returns:
      Full string representation of the eventID. May not return null.
      Since:
      jTLEX 1.0
    • getStem

      String getStem()
      Returns the stem of the event.
      Returns:
      the stem of the event. May return null if stem is not included in annotation
      Since:
      jTLEX 1.0
    • getEventClass

      ITimeMLEvent.EventClass getEventClass()
      Returns the event class to which the object belongs.
      Returns:
      the event class to which the object belongs. May not return null.
      Since:
      jTLEX 1.0
    • toString

      String toString()
      Returns the String Representation of the Event.
      Overrides:
      toString in class Object
      Returns:
      the info of an Event in String Format.
      Since:
      jTLEX 1.0
    • setInstance

      void setInstance(ITimeMLInstance instance)
      Sets the related Instance for the event. May be null.
      Parameters:
      instance - the ITimeMLInstance to connect to the event.
      Since:
      jTLEX 1.0
    • getInstances

      Set<Integer> getInstances()
      Returns the IDs of the instances related to the Event. May be null
      Returns:
      the int ID of the Instances related to the event.
      Since:
      jTLEX 1.0
    • toJson

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

      ITimeMLEvent clone()
      Returns a field-by-field copy of the event.
      Returns:
      a field-by-field copy of the event.
      Since:
      jTLEX 1.0
    • hashCode

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

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