Package edu.fiu.jtlex.data

Interface ITimeMLParser

All Known Implementing Classes:
TimeMLParser
public interface ITimeMLParser
The interface for the master parser to allow for different parts of a timeML document (Event, Timex, and Link) to be parsed for the required variables within their strings.
Author:
ceber003

  • Method Summary

    Modifier and Type Method Description
    IText parse​(java.io.InputStream timeML)
    The parse method which will take the input stream and break it up into the different variables held within.
    IEvent parseEvent​(java.lang.String eventString)
    A parser method which takes the string input representing an Event and parses it to get the different variables from the string.
    IInstance parseInstance​(java.lang.String instanceString)
    A parser method which takes the string input representing an Instance and parses it to get the Instance object.
    ILink parseLink​(java.lang.String tag, java.lang.String linkString)
    A parser method which takes the string input representing a Link and parses it to get the different variables from the string.
    ISignal parseSignal​(java.lang.String signalString)
    A parser method which takes the string input representing a Signal and parses it to get the Signal object.
    ITimex parseTimex​(java.lang.String timexString)
    A parser method which takes the string input representing a Timex and parses it to get the different variables from the string.

  • Method Details

    • parse

      IText parse​(java.io.InputStream timeML) throws java.io.UnsupportedEncodingException
      The parse method which will take the input stream and break it up into the different variables held within.
      Parameters:
      timeML - the TimeML annotated text file to be parsed.
      Returns:
      a new Text object which contains all of the separated data.
      Throws:
      java.io.UnsupportedEncodingException - the text must be encoded using UFT-8.

    • parseEvent

      IEvent parseEvent​(java.lang.String eventString)
      A parser method which takes the string input representing an Event and parses it to get the different variables from the string.
      Parameters:
      eventString - a string input representing an Event.
      Returns:
      a new Event object.

    • parseTimex

      ITimex parseTimex​(java.lang.String timexString)
      A parser method which takes the string input representing a Timex and parses it to get the different variables from the string.
      Parameters:
      timexString - a string input representing a time expression.
      Returns:
      a new Timex object.

    • parseLink

      ILink parseLink​(java.lang.String tag, java.lang.String linkString)
      A parser method which takes the string input representing a Link and parses it to get the different variables from the string.
      Parameters:
      tag - an XML tag relating to the link.
      linkString - a string input representing a link.
      Returns:
      a new Link object.

    • parseInstance

      IInstance parseInstance​(java.lang.String instanceString)
      A parser method which takes the string input representing an Instance and parses it to get the Instance object.
      Parameters:
      instanceString - a string input representing an instance.
      Returns:
      a new Instance object.

    • parseSignal

      ISignal parseSignal​(java.lang.String signalString)
      A parser method which takes the string input representing a Signal and parses it to get the Signal object.
      Parameters:
      signalString - a string representation of a signal.
      Returns:
      a new Signal object.