Package edu.fiu.jtlex.timeml.timeline
Interface ITimeMLTimeline
- All Known Implementing Classes:
TimeMLTimeline
public interface ITimeMLTimeline
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.
- Since:
- jTLEX 1.0
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Checks if this Timeline equals an object.Returns a List containing the breaking points from the Partitioning.java class.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.
-
Method Details
-
iterator
Returns an iterator object that is used in for-each loops.- Returns:
- an iterator object that is used in for-each loops.
- Since:
- jTLEX 1.0
-
hasNext
boolean hasNext()Checks if there are Timeline elements remaining in the list.- Returns:
- true if there are Timeline elements remaining in the list.
- Since:
- jTLEX 1.0
-
next
String next()Returns next String representation of an event on the timeline.- Returns:
- next String representation of an event on the timeline.
- Since:
- jTLEX 1.0
-
getMainTimeline
Returns theList<String>
representation of the main Timeline in the graph.- 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.- Returns:
- an ArrayList containing the Timelines belonging to the subordinating subgraphs.
- Since:
- jTLEX 1.0
-
getTotalTimePoints
int getTotalTimePoints()Returns number of timepoints.- Returns:
- the number of timepoints.
- Since:
- jTLEX 1.0
-
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.
- Since:
- jTLEX 1.0
-
getFirstPoint
String getFirstPoint()Returns the first timepoint in the Timeline.- Returns:
- the first timepoint in the Timeline.
- Since:
- jTLEX 1.0
-
getLastPoint
String getLastPoint()Returns the last timepoint in the Timeline.- Returns:
- the last timepoint in the Timeline.
- Since:
- jTLEX 1.0
-
getTimelineLength
int getTimelineLength()Returns the number of events in the timeline.- Returns:
- the number of events in the timeline.
- Since:
- jTLEX 1.0
-
getTotalSubordinationBranches
int getTotalSubordinationBranches()Returns the total number of subordination branches in the graph.- Returns:
- the total number of subordination branches in the graph.
- Since:
- jTLEX 1.0
-
toJson
String toJson()Returns the JSON (RFC 8259) representation of the Timeline.- Returns:
- the JSON (RFC 8259) representation of the Timeline.
- Since:
- jTLEX 1.0
-
hashCode
int hashCode()Generates a hash code for the timeline. -
equals
Checks if this Timeline equals an object.- 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
-