Package edu.fiu.jtlex.timeml.timeline
Class TimeMLTimeline
java.lang.Object
edu.fiu.jtlex.timeml.timeline.TimeMLTimeline
- All Implemented Interfaces:
ITimeMLTimeline
,Iterable<String>
,Iterator<String>
public class TimeMLTimeline
extends Object
implements ITimeMLTimeline, Iterator<String>, Iterable<String>
Default implementation of
ITimeline
.- Since:
- jTLEX 1.0
- Author:
- Emmanuel Garcia
-
Constructor Summary
ConstructorsConstructorDescriptionTimeMLTimeline
(List<List<String>> Timeline, Set<ITimeMLLink> singleSlinks) Represents a Timeline of a TimeML graph, which is an ordered list of the events extracted from a TimeML Graph. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks if this Timeline equals an object.Returns a List containing the breaking points.Returns the first timepoint in the Timeline.Returns the last timepoint in the Timeline.Returns theList<String>
representation of the main Timeline in the graph.Returns an ArrayList containing the Timelines belonging to the subordinating subgraphs.int
Returns the number of events in the timeline.int
Returns the total number of subordination branches in the graph.int
Returns number of timepoints.int
hashCode()
Generates a hash code for the timeline.boolean
hasNext()
Checks if there are Timeline elements remaining in the list.iterator()
Returns an iterator object that is used in for-each loops.next()
Returns next String representation of an event on the timeline.toJson()
Returns the JSON (RFC 8259) representation of the Timeline.toString()
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface java.util.Iterator
forEachRemaining, remove
-
Constructor Details
-
TimeMLTimeline
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.- Parameters:
Timeline
- produced by the Solve() method in the GraphTCSP.java class.singleSlinks
-Set<ILink>
produced by the partitionLinks() method in the Partitioner.java class.- Throws:
NullPointerException
- if Timeline argument isnull
-
-
Method Details
-
iterator
Returns an iterator object that is used in for-each loops.- Specified by:
iterator
in interfaceIterable<String>
- Specified by:
iterator
in interfaceITimeMLTimeline
- Returns:
- an iterator object that is used in for-each loops.
- Since:
- jTLEX 1.0
-
hasNext
public boolean hasNext()Checks if there are Timeline elements remaining in the list.- Specified by:
hasNext
in interfaceIterator<String>
- Specified by:
hasNext
in interfaceITimeMLTimeline
- Returns:
- true if there are Timeline elements remaining in the list.
- Since:
- jTLEX 1.0
-
next
Returns next String representation of an event on the timeline.- Specified by:
next
in interfaceIterator<String>
- Specified by:
next
in interfaceITimeMLTimeline
- Returns:
- next String representation of an event on the timeline.
- Throws:
IndexOutOfBoundsException
- Since:
- jTLEX 1.0
-
getMainTimeline
Returns theList<String>
representation of the main Timeline in the graph.- Specified by:
getMainTimeline
in interfaceITimeMLTimeline
- Returns:
- the
List<String>
representation of the main Timeline in the graph. - Since:
- jTLEX 1.0
-
getSubordinationTimelines
Returns an ArrayList containing the Timelines belonging to the subordinating subgraphs.- Specified by:
getSubordinationTimelines
in interfaceITimeMLTimeline
- Returns:
- an ArrayList containing the Timelines belonging to the subordinating subgraphs.
- Since:
- jTLEX 1.0
-
getTotalTimePoints
public int getTotalTimePoints()Returns number of timepoints.- Specified by:
getTotalTimePoints
in interfaceITimeMLTimeline
- Returns:
- the number of timepoints.
- Since:
- jTLEX 1.0
-
getAttachmentPoints
Returns a List containing the breaking points.- Specified by:
getAttachmentPoints
in interfaceITimeMLTimeline
- Returns:
- a List containing the breaking points.
- Since:
- jTLEX 1.0
-
getFirstPoint
Returns the first timepoint in the Timeline.- Specified by:
getFirstPoint
in interfaceITimeMLTimeline
- Returns:
- the first timepoint in the Timeline.
- Since:
- jTLEX 1.0
-
getLastPoint
Returns the last timepoint in the Timeline.- Specified by:
getLastPoint
in interfaceITimeMLTimeline
- Returns:
- the last timepoint in the Timeline.
- Since:
- jTLEX 1.0
-
getTimelineLength
public int getTimelineLength()Returns the number of events in the timeline.- Specified by:
getTimelineLength
in interfaceITimeMLTimeline
- Returns:
- the number of events in the timeline.
- Since:
- jTLEX 1.0
-
getTotalSubordinationBranches
public int getTotalSubordinationBranches()Returns the total number of subordination branches in the graph.- Specified by:
getTotalSubordinationBranches
in interfaceITimeMLTimeline
- Returns:
- the total number of subordination branches in the graph.
- Since:
- jTLEX 1.0
-
toString
-
toJson
Returns the JSON (RFC 8259) representation of the Timeline.- Specified by:
toJson
in interfaceITimeMLTimeline
- Returns:
- the JSON (RFC 8259) representation of the Timeline.
- Since:
- jTLEX 1.0
-
hashCode
public int hashCode()Generates a hash code for the timeline.- Specified by:
hashCode
in interfaceITimeMLTimeline
- Overrides:
hashCode
in classObject
- Returns:
- The hash code.
- Since:
- jTLEX 1.0
-
equals
Checks if this Timeline equals an object.- Specified by:
equals
in interfaceITimeMLTimeline
- Overrides:
equals
in classObject
- Parameters:
o
- The object to compare against.- Returns:
- True if timelines are equal, i.e. same mainTimeline and timelines, or else false.
- Throws:
NullPointerException
- If the object to compare against is false.- Since:
- jTLEX 1.0
-