Package edu.fiu.jtlex.data

Interface ITimeline

All Known Implementing Classes:
Timeline
public interface ITimeline
Represents a Timeline of a TimeML graph, which is an ordered list of the events extracted from a TimeML Graph. TimeML annotations are converted into a collection of main and subordinated timelines arranged into a trunk-and-branch style structure. This class takes an ordered timeline, a set of attachment links, arranging them into a Timeline.

  • Method Summary

    Modifier and Type Method Description
    java.util.List<java.lang.String> getAttachmentPoints()
    Returns a List containing the breaking points from the Partitioning.java class.
    java.lang.String getFirstPoint()
    Returns the first timepoint in the Timeline.
    java.lang.String getLastPoint()
    Returns the last timepoint in the Timeline.
    java.util.List<java.lang.String> getMainTimeline()
    Returns the List<String> representation of the main Timeline in the graph.
    java.util.ArrayList<java.util.List<java.lang.String>> getSubordinationTimelines()
    Returns an ArrayList containing the Timelines belonging to the subordinating subgraphs.
    int getTimelineLength()
    Returns the number of events in the timeline.
    int getTotalSubordinationBranches()
    Returns the total number of subordination branches in the graph.
    int getTotalTimePoints()
    Returns number of timepoints.
    boolean hasNext()
    Checks if there are Timeline elements remaining in the list.
    java.util.Iterator<java.lang.String> iterator()
    Returns an iterator object that is used in for-each loops.
    java.lang.String next()
    Returns next String representation of an event on the timeline.
    java.lang.String toJSON()
    Returns the JSON (RFC 8259) representation of the Timeline.

  • Method Details

    • iterator

      java.util.Iterator<java.lang.String> iterator()
      Returns an iterator object that is used in for-each loops.
      Returns:
      an iterator object that is used in for-each loops.

    • hasNext

      boolean hasNext()
      Checks if there are Timeline elements remaining in the list.
      Returns:
      true if there are Timeline elements remaining in the list.

    • next

      java.lang.String next()
      Returns next String representation of an event on the timeline.
      Returns:
      next String representation of an event on the timeline.

    • getMainTimeline

      java.util.List<java.lang.String> getMainTimeline()
      Returns the List<String> representation of the main Timeline in the graph.
      Returns:
      the List<String> representation of the main Timeline in the graph.

    • getSubordinationTimelines

      java.util.ArrayList<java.util.List<java.lang.String>> getSubordinationTimelines()
      Returns an ArrayList containing the Timelines belonging to the subordinating subgraphs.
      Returns:
      an ArrayList containing the Timelines belonging to the subordinating subgraphs.

    • getTotalTimePoints

      int getTotalTimePoints()
      Returns number of timepoints.
      Returns:
      the number of timepoints.

    • getAttachmentPoints

      java.util.List<java.lang.String> getAttachmentPoints()
      Returns a List containing the breaking points from the Partitioning.java class.
      Returns:
      a List containing the breaking points from the Partitioning.java class.

    • getFirstPoint

      java.lang.String getFirstPoint()
      Returns the first timepoint in the Timeline.
      Returns:
      the first timepoint in the Timeline.

    • getLastPoint

      java.lang.String getLastPoint()
      Returns the last timepoint in the Timeline.
      Returns:
      the last timepoint in the Timeline.

    • getTimelineLength

      int getTimelineLength()
      Returns the number of events in the timeline.
      Returns:
      the number of events in the timeline.

    • getTotalSubordinationBranches

      int getTotalSubordinationBranches()
      Returns the total number of subordination branches in the graph.
      Returns:
      the total number of subordination branches in the graph.

    • toJSON

      java.lang.String toJSON()
      Returns the JSON (RFC 8259) representation of the Timeline.
      Returns:
      the JSON (RFC 8259) representation of the Timeline.