Package edu.fiu.jtlex.data

Interface IInstance

All Superinterfaces:
INode
All Known Implementing Classes:
Instance
public interface IInstance
extends INode
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

Author:
arada002

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static class  IInstance.Aspect
    An enum that represents the different aspects of an event instance phrase.
    static class  IInstance.Polarity
    An enum that indicates whether the event instance phrase is negated.
    static class  IInstance.Pos
    An enum that represents the different part of speech categories.
    static class  IInstance.Tense
    An enum that represents the different tenses of event instance phrases.

  • Method Summary

    Modifier and Type Method Description
    void addInLink​(ILink link)
    Adds a link to the inLinks, set of links that have this node as a target.
    void addOutLink​(ILink link)
    Adds a link to the outLinks, set of links that have this node as an origin.
    IInstance.Aspect getAspect()
    Returns the aspect of the verbal phrase.
    java.lang.String getCardinality()
    Returns the cardinality of the event instance.
    IEvent getEvent()
    Returns the ID of the event to which the instance is related.
    int getId()
    Returns the unique ID number eventInstanceID.
    java.lang.String getIdStr()
    Grabs the eventInstanceID, adds eiid to the front for the String format and returns.
    java.util.Set<ILink> getInLinks()
    Returns the inLinks, set of links that have this node as a target.
    java.lang.String getModality()
    The modality attribute is only present if there is a modal word present that modifies the instance.
    java.util.Set<ILink> getOutLinks()
    Returns the outLinks, set of links that have this node as an origin.
    IInstance.Polarity getPolarity()
    Returns the polarity of the eventInstance.
    IInstance.Pos getPos()
    Returns the syntactic category of the phrase (part of speech).
    ISignal getSignal()
    Returns the signal object, present if multiple event instances are created null if not defined, may not be less than 0
    IInstance.Tense getTense()
    Returns the tense of the verbal phrase.
    IEvent.EventClass getType()
    Calls the event to which the instance is related, then returns the event class of the event instance.
    void removeInLink​(ILink link)
    Removes a link from the outLinks, set of links that have this node as a target.
    void removeOutLink​(ILink link)
    Removes a link from the outLinks, set of links that have this node as an origin.

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

    clone, equals, toJSON

  • Method Details

    • getId

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

    • getEvent

      IEvent 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. May not return less than 1.

    • getTense

      IInstance.Tense getTense()
      Returns the tense of the verbal phrase.
      Returns:
      the tense of the verbal phrase. May not return null.

    • getAspect

      IInstance.Aspect getAspect()
      Returns the aspect of the verbal phrase.
      Returns:
      the aspect of the verbal phrase. May not return null.

    • getPos

      IInstance.Pos 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.

    • getPolarity

      IInstance.Polarity 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.

    • getModality

      java.lang.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.
      See Also:
      Modality (natural language)

    • getSignal

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

    • getCardinality

      java.lang.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.
      See Also:
      IInstance

    • getType

      IEvent.EventClass getType()
      Calls the event to which the instance is related, then returns the event class of the event instance.
      Specified by:
      getType in interface INode
      Returns:
      the event class of the event instance.

    • getIdStr

      java.lang.String getIdStr()
      Grabs the eventInstanceID, adds eiid to the front for the String format and returns.
      Specified by:
      getIdStr in interface INode
      Returns:
      the eventInstanceID in string format.

    • addOutLink

      void addOutLink​(ILink link)
      Adds a link to the outLinks, set of links that have this node as an origin.
      Specified by:
      addOutLink in interface INode
      Parameters:
      link - .

    • addInLink

      void addInLink​(ILink link)
      Adds a link to the inLinks, set of links that have this node as a target.
      Specified by:
      addInLink in interface INode
      Parameters:
      link - .

    • getOutLinks

      java.util.Set<ILink> getOutLinks()
      Returns the outLinks, set of links that have this node as an origin.
      Specified by:
      getOutLinks in interface INode
      Returns:
      the outLinks, set of links that have this node as an origin.

    • getInLinks

      java.util.Set<ILink> getInLinks()
      Returns the inLinks, set of links that have this node as a target.
      Specified by:
      getInLinks in interface INode
      Returns:
      the inLinks, set of links that have this node as a target.

    • removeOutLink

      void removeOutLink​(ILink link)
      Removes a link from the outLinks, set of links that have this node as an origin.
      Specified by:
      removeOutLink in interface INode
      Parameters:
      link - .

    • removeInLink

      void removeInLink​(ILink link)
      Removes a link from the outLinks, set of links that have this node as a target.
      Specified by:
      removeInLink in interface INode
      Parameters:
      link - .