Interface ITimeMLInstance

All Superinterfaces:
ITimeMLNode
All Known Implementing Classes:
TimeMLInstance

public interface ITimeMLInstance extends ITimeMLNode
Represents the MAKEINSTANCE tag.

"We distinguish between event tokens and event instances or realisations � MAKEINSTANCE creates the actual realisation of an event. The motivation is examples like John taught on Monday and Tuesday, where one verb represents two events. In order to be able to annotate such cases, it is necessary to create two instances of taught, representing the two different events. The tense, aspect, part of speech, polarity, and modality of a particular event instance are also represented in this tag. As such, a sentence such as John taught today but he might not tomorrow can be adequately represented. MAKEINSTANCEs are created in addition to the event annotation (which marks up the event token).

In most cases, only one MAKEINSTANCE is needed, and will be automatically created by the annotation tool, so the annotator only has to insert an additional MAKEINSTANCE for the second (and further, if necessary) instance or realisation of an event."

-TimeML Annotation Guidelines Version 1.2.1

Since:
jTLEX 1.0
Author:
arada002
  • Method Details

    • getId

      int getId()
      Returns the unique ID number eventInstanceID.
      Specified by:
      getId in interface ITimeMLNode
      Returns:
      the unique ID number eventInstanceID.
    • getEvent

      String getEvent()
      Returns the ID of the event to which the instance is related.
      Returns:
      the ID of the event to which the instance is related.
      Since:
      jTLEX 1.0
    • getTense

      Returns the tense of the verbal phrase.
      Returns:
      the tense of the verbal phrase. May not return null.
      Since:
      jTLEX 1.0
    • getAspect

      Returns the aspect of the verbal phrase.
      Returns:
      the aspect of the verbal phrase. May not return null.
      Since:
      jTLEX 1.0
    • getPos

      Returns the syntactic category of the phrase (part of speech).
      Returns:
      the syntactic category of the phrase (part of speech). May not return null.
      Since:
      jTLEX 1.0
    • getPolarity

      Returns the polarity of the eventInstance. The polarity of an event instance is a required attribute represented by the boolean attribute, polarity.
      If it is set to �NEG�, the event instance is negated.
      If it is set to �POS� or not present in the annotation, the event instance is not negated.
      Returns:
      polarity: NEG if the phrase is negated, POS if the phrase is not negated. May not return null.
      Since:
      jTLEX 1.0
    • getModality

      String getModality()
      The modality attribute is only present if there is a modal word present that modifies the instance.
      Returns:
      the modal word that modifies the instance. May return null.
      Since:
      jTLEX 1.0
      See Also:
    • getSignal

      ITimeMLSignal getSignal()
      Returns the signal object, present if multiple event instances are created null if not defined, may not be less than 0
      Returns:
      the signal object, present if multiple event instances are created.
      Since:
      jTLEX 1.0
    • getCardinality

      String getCardinality()
      Returns the cardinality of the event instance.
      Cardinality is only present if there is a signal that provides its value.
      There are also cases, where the annotator can either create as many MAKEINSTANCEs as motivated by the text or one MAKEINSTANCE which carries a cardinality value. Examples are the following:
      1. John taught twice on Monday.
      2. John taught 150 times last year.
      In the first example, the annotator can either create two MAKEINSTANCEs or one MAKEINSTANCE with cardinality two. In the second example, the only practical solution is to create one MAKEINSTANCE with cardinality 150.
      Returns:
      Cardinality 0 if not defined. May not return less than 0.
      Since:
      jTLEX 1.0
      See Also:
    • getType

      Calls the event to which the instance is related, then returns the event class of the event instance.
      Specified by:
      getType in interface ITimeMLNode
      Returns:
      the event class of the event instance.
      Since:
      jTLEX 1.0
    • getIdStr

      String getIdStr()
      Grabs the eventInstanceID, adds eiid to the front for the String format and returns.
      Specified by:
      getIdStr in interface ITimeMLNode
      Returns:
      the eventInstanceID in string format.
      Since:
      jTLEX 1.0
    • equals

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