Package edu.fiu.jtlex.data

Class Graph

java.lang.Object

edu.fiu.jtlex.data.Graph

All Implemented Interfaces:

IGraph, java.lang.Cloneable

public class Graph
extends java.lang.Object
implements IGraph

Default implementation of IGraph.

Represents a TimeML Graph.

A TimeML temporal graph is a graph T = (V,E) where: V is a set of temporal events and time expressions. E is a set of TimeML links: a tuple (u,v,w) where u, v belong to V and w is a link type. There are 25 link types, refer to TLinkType, ALinkType, and SLinkType.

A graph is represented with two Hash Tables, one for Nodes and one for Links.

Author:

Luis Robaina

Nested Class Summary

Nested classes/interfaces inherited from interface edu.fiu.jtlex.data.IGraph

IGraph.GraphType

Constructor Summary

Constructors

Constructor	Description
Graph()	Generates a blank graph object for manual computation.
Graph(java.io.File timeMLFile)	Generates a graph based on a TimeML annotated text file.
Graph(java.io.InputStream timeMLData)	Generates a graph based on a TimeML annotated text file.
Graph(java.lang.String timeMLString)	Generates a graph based on a TimeML annotated text file.

Method Summary

Modifier and Type	Method	Description
boolean	addLink(int NodeOneID, int NodeTwoID, ILink.LinkTag linktag, ILinkType linkType, java.lang.String syntax, ISignal signal, ILink.Origintype orig)	Adds a Link into the graph, given Node identification numbers.
boolean	addLink(ILink link)	Adds a Link into the graph.
boolean	addLink(INode NodeOne, INode NodeTwo, ILink.LinkTag linktag, ILinkType linkType, java.lang.String syntax, ISignal signal, ILink.Origintype orig)	Adds a Link into the graph, given Node objects.
boolean	addNode(INode node)	Adds a node to the graph.
Graph	clone()	Returns a deep-copy of the current Graph object.
boolean	containsLink(ILink link)	Return true if the given link exists in the graph.
boolean	equalLinks(Graph obj)	Returns true if the clone graph contains all the links in graph, returns false otherwise
boolean	equalNodes(Graph obj)	Returns true if the clone graph contains all the node IDs in graph, returns false otherwise
boolean	equals(java.lang.Object o)
boolean	getConsistency()	Returns true if the graph is consistent.
java.util.ArrayList<IGraph>	getConsistentPartitions()	Returns the set of consistent subordinate subgraphs.
IGraph.GraphType	getGraphType()	Returns the type of graph.
java.util.ArrayList<IGraph>	getInconsistentPartitions()	Returns the set of inconsistent subordinate subgraphs.
java.util.Set<IGraph>	getInconsistentSubgraphs()	Returns the set of inconsistent subgraphs.
java.lang.Double	getIndeterminacyScore()	Returns a percent value representing the indeterminacy score.
int	getIndeterminantSections()
java.util.ArrayList<java.lang.String>	getIndeterminantTimePairs()	Returns a list of Indeterminant Time Pairs.
java.util.List<java.lang.String>	getIndeterminantTimePoints()
java.util.Set<ILink>	getLinks()	Returns a set with all the Links in the TimeML graph, (null) if the TimeML graph is empty.
int	getLinksCount()	Returns the number of links.
java.util.HashMap<java.lang.String,java.lang.Integer>	getLinkTypesCount()	Returns the count of each type of links, formatted as a string.
INode	getNodeByID(int NodeID)	Returns a INode reference if a node with ID NodeID exists in the graph returns null otherwise.
java.util.Set<INode>	getNodes()	Returns a set with all the Nodes in the TimeML graph, (null) if the TimeML graph is empty.
int	getNodesCount()	Returns the number of nodes.
java.util.Set<ILink>	getPartitionlinks()	Returns the set of subordination links.
java.util.ArrayList<IGraph>	getPartitions()	Returns the set of subordinate subgraphs.
java.util.ArrayList<java.util.List<java.lang.String>>	getSolutionList()	Return the string representations of timeline solututions via GraphTCSP.stringTimeLine().
java.util.ArrayList<ILink>	getSuggestedLinks()	Returns a list of suggested links to increase graph connectivity.
java.lang.String	getText()	Returns the article text without TimeML tags.
Timeline	getTimeline()	Returns the computed timeline.
int	getTimelineLength()	Returns the length of the main timeline.
java.lang.Boolean	hasSelfLoops()	Returns whether the graph has self loops or not.
java.lang.String	inconsistentSubGraphsToJSON()	Formats and returns the JSON representation of the inconsistent subgraphs.
boolean	isConsistent()	Returns true if the graph is consistent.
ILink	removeLink(ILink link)	Removes the given link from the graph.
INode	removeNode(INode node)	Removes a node object from the graph.
INode	removeNodeByID(int ID)	Removes a node from the graph, by node identification number.
void	setConsistency(boolean consistency)	Sets the consistency of the graph.
void	setGraphType(IGraph.GraphType graphType)	Sets the type of graph to IGraph.GraphType.MainGraph or IGraph.GraphType.SubbordinationGraph
void	setIndeterminancyScore(double indeterminacyScore)	Sets the percent value representing the indeterminacy score.
void	setIndeterminantTimePairs(java.util.ArrayList<java.lang.String> iTimePairs)	Sets the Indeterminant Time Pairs for the current Graph.
void	setSuggestedLinks(ILink x)
void	setTimeline(Timeline newTimeline)	Sets the Timeline of the current Graph.
java.lang.String	suggestedLinksToString()	Returns the string representation of the suggested links.
void	suggestLinks()
java.lang.String	toJSON()	Returns the JSON (RFC 8259) representation of the Graph.
java.lang.String	toString()
int	totalSelfLoops()	Returns the number of self loops in the graph.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Graph

public Graph()

Generates a blank graph object for manual computation. Nodes and links must be added via the addNode(INode) and addLink(INode, INode, LinkTag, ILinkType, String, ISignal, Origintype) functions, respectively.

See Also:

IGraph

Graph

public Graph(java.io.File timeMLFile) throws java.io.FileNotFoundException

Generates a graph based on a TimeML annotated text file. This constructor:

1. converts the File object into a FileStream
2. parses the text file via TimeMLParser.parse(InputStream)
3. adds the parsed Timex nodes, Instance nodes, and Links
4. finds the subordinate partitions via Partitioner.partitionGraph(IGraph)
5. finds inconsistent subgraphs via InconsistencyDetector.isConsistent(IGraph)
6. finds indeterminacies via IndeterminacyDetector.detect() ()}
7. builds the Timeline object via GraphTCSP.stringTimeLine()

Parameters:

timeMLFile - The TimeML file to be analyzed.

Throws:

java.io.FileNotFoundException - if there is a problem reading the given file.

See Also:

TimeMLParser, Partitioner, InconsistencyDetector, IndeterminacyDetector, GraphTCSP, Timeline

Graph

public Graph(java.lang.String timeMLString)

Generates a graph based on a TimeML annotated text file. This constructor:

1. converts the String object into an InputStream
2. parses the text file via TimeMLParser.parse(InputStream)
3. adds the parsed Timex nodes, Instance nodes, and Links
4. finds the subordinate partitions via Partitioner.partitionGraph(IGraph)
5. finds inconsistent subgraphs via InconsistencyDetector.isConsistent(IGraph)
6. finds indeterminacies via IndeterminacyDetector.detect() ()}
7. builds the Timeline object via GraphTCSP.stringTimeLine()

Parameters:

timeMLString - The TimeML string to be analyzed.

See Also:

TimeMLParser, Partitioner, InconsistencyDetector, IndeterminacyDetector, GraphTCSP, Timeline

Graph

public Graph(java.io.InputStream timeMLData)

Generates a graph based on a TimeML annotated text file. This constructor:

1. parses the text file via TimeMLParser.parse(InputStream)
2. adds the parsed Timex nodes, Instance nodes, and Links
3. finds the subordinate partitions via Partitioner.partitionGraph(IGraph)
4. finds inconsistent subgraphs via InconsistencyDetector.isConsistent(IGraph)
5. finds indeterminacies via IndeterminacyDetector.detect() ()}
6. builds the Timeline object via GraphTCSP.stringTimeLine()

Parameters:

timeMLData - The TimeML InputStream to be analyzed.

See Also:

TimeMLParser, Partitioner, InconsistencyDetector, IndeterminacyDetector, GraphTCSP, Timeline

Method Details

getLinksCount

public int getLinksCount()

Returns the number of links.

Specified by:

getLinksCount in interface IGraph

Returns:

the number of links.

getNodesCount

public int getNodesCount()

Returns the number of nodes.

Specified by:

getNodesCount in interface IGraph

Returns:

the number of nodes.

getNodeByID

public INode getNodeByID(int NodeID)

Returns a INode reference if a node with ID NodeID exists in the graph returns null otherwise.

Specified by:

getNodeByID in interface IGraph

Parameters:

NodeID - : An Integer ID for a given node.

Returns:

A INode reference if a node with ID NodeID exists in the graph returns null otherwise.

addLink

public boolean addLink(ILink link)

Adds a Link into the graph.

Specified by:

addLink in interface IGraph

Parameters:

link - the Link to add.

Returns:

True on successful addition, False if node already exists.

addLink

public boolean addLink(INode NodeOne, INode NodeTwo, ILink.LinkTag linktag, ILinkType linkType, java.lang.String syntax, ISignal signal, ILink.Origintype orig)

Adds a Link into the graph, given Node objects.

Specified by:

addLink in interface IGraph

Parameters:

NodeOne - The first Node. This is referred to as the Event Instance.

NodeTwo - The second Node. This is referred to as the Related to Event.

linktag - The type of link (TLink, ALink, SLink)

linkType - The type of link (TLink, ALink, SLink)

syntax - the syntactic pattern that was used in generating the link

signal - ID of the signal, if the temporal relation is explicitly signaled in the text.

orig - whether a TLink was generated manually or by closure.

Returns:

True on successful insertion, False if link already exists.

addLink

public boolean addLink(int NodeOneID, int NodeTwoID, ILink.LinkTag linktag, ILinkType linkType, java.lang.String syntax, ISignal signal, ILink.Origintype orig)

Adds a Link into the graph, given Node identification numbers.

Specified by:

addLink in interface IGraph

Parameters:

NodeOneID - The first Node ID. This is referred to as the Event Instance.

NodeTwoID - The second Node ID. This is referred to as the Related to Event.

linktag - The type of link (TLink, ALink, SLink)

linkType - The type of link (TLink, ALink, SLink)

syntax - the syntactic pattern that was used in generating the link

signal - ID of the signal, if the temporal relation is explicitly signaled in the text.

orig - whether a TLink was generated manually or by closure.

Returns:

True on successful insertion, False if link already exists.

containsLink

public boolean containsLink(ILink link)

Return true if the given link exists in the graph.

Specified by:

containsLink in interface IGraph

Parameters:

link - the link to find.

Returns:

true if the given link exists in the graph.

removeLink

public ILink removeLink(ILink link)

Removes the given link from the graph.

Specified by:

removeLink in interface IGraph

Parameters:

link - the link to remove.

Returns:

the link that was removed, Null if link was not found.

addNode

public boolean addNode(INode node)

Adds a node to the graph.

Specified by:

addNode in interface IGraph

Parameters:

node - the node to add.

Returns:

True on successful addition, False if node already exists.

removeNode

public INode removeNode(INode node)

Removes a node object from the graph.

Specified by:

removeNode in interface IGraph

Parameters:

node - the node object to remove.

Returns:

the node that was removed, Null if node was not found.

removeNodeByID

public INode removeNodeByID(int ID)

Removes a node from the graph, by node identification number.

Specified by:

removeNodeByID in interface IGraph

Parameters:

ID - the identification number of the node to be removed.

Returns:

the node that was removed, Null if node was not found.

setConsistency

public void setConsistency(boolean consistency)

Sets the consistency of the graph.

Specified by:

setConsistency in interface IGraph

Parameters:

consistency - the consistency of the graph.

getConsistency

public boolean getConsistency()

Returns true if the graph is consistent.

Specified by:

getConsistency in interface IGraph

Returns:

true if the graph is consistent.

getLinks

public java.util.Set<ILink> getLinks()

Returns a set with all the Links in the TimeML graph, (null) if the TimeML graph is empty.

Specified by:

getLinks in interface IGraph

Returns:

a set with all the Links in the TimeML graph, (null) if the TimeML graph is empty.

getNodes

public java.util.Set<INode> getNodes()

Returns a set with all the Nodes in the TimeML graph, (null) if the TimeML graph is empty.

Specified by:

getNodes in interface IGraph

Returns:

a set with all the Nodes in the TimeML graph, (null) if the TimeML graph is empty.

getLinkTypesCount

public java.util.HashMap<java.lang.String,java.lang.Integer> getLinkTypesCount()

Returns the count of each type of links, formatted as a string.

Specified by:

getLinkTypesCount in interface IGraph

Returns:

the count of each type of links ILink.ALinkType, ILink.SLinkType, ILink.TLinkType formatted as a string.

getGraphType

public IGraph.GraphType getGraphType()

Returns the type of graph.

Specified by:

getGraphType in interface IGraph

Returns:

the type of graph.

See Also:

IGraph.GraphType

setGraphType

public void setGraphType(IGraph.GraphType graphType)

Description copied from interface: IGraph

Sets the type of graph to IGraph.GraphType.MainGraph or IGraph.GraphType.SubbordinationGraph

Specified by:

setGraphType in interface IGraph

Parameters:

graphType - the type of graph.

See Also:

IGraph.GraphType

getPartitions

public java.util.ArrayList<IGraph> getPartitions()

Returns the set of subordinate subgraphs.

Specified by:

getPartitions in interface IGraph

Returns:

the set of subordinate subgraphs.

See Also:

Partitioner.partitionGraph(IGraph)

getConsistentPartitions

public java.util.ArrayList<IGraph> getConsistentPartitions()

Returns the set of consistent subordinate subgraphs.

Specified by:

getConsistentPartitions in interface IGraph

Returns:

the set of consistent subordinate subgraphs.

See Also:

InconsistencyDetector

getInconsistentPartitions

public java.util.ArrayList<IGraph> getInconsistentPartitions()

Returns the set of inconsistent subordinate subgraphs.

Specified by:

getInconsistentPartitions in interface IGraph

Returns:

the set of inconsistent subordinate subgraphs.

See Also:

InconsistencyDetector

getSolutionList

public java.util.ArrayList<java.util.List<java.lang.String>> getSolutionList()

Return the string representations of timeline solututions via GraphTCSP.stringTimeLine().

Specified by:

getSolutionList in interface IGraph

Returns:

the string representations of timeline solututions via GraphTCSP.stringTimeLine().

getPartitionlinks

public java.util.Set<ILink> getPartitionlinks()

Returns the set of subordination links.

Specified by:

getPartitionlinks in interface IGraph

Returns:

the set of subordination links.

setTimeline

public void setTimeline(Timeline newTimeline)

Sets the Timeline of the current Graph.

Specified by:

setTimeline in interface IGraph

Parameters:

newTimeline - the new Timeline.

getTimeline

public Timeline getTimeline()

Returns the computed timeline.

Specified by:

getTimeline in interface IGraph

Returns:

the computed timeline.

See Also:

GraphTCSP

getTimelineLength

public int getTimelineLength()

Returns the length of the main timeline.

Specified by:

getTimelineLength in interface IGraph

Returns:

the length of the main timeline, -1 if graph is inconsistent.

getIndeterminantTimePairs

public java.util.ArrayList<java.lang.String> getIndeterminantTimePairs()

Returns a list of Indeterminant Time Pairs.

Specified by:

getIndeterminantTimePairs in interface IGraph

Returns:

a list of Indeterminant Time Pairs.

getIndeterminantTimePoints

public java.util.List<java.lang.String> getIndeterminantTimePoints()

getIndeterminacyScore

public java.lang.Double getIndeterminacyScore()

Returns a percent value representing the indeterminacy score.

Specified by:

getIndeterminacyScore in interface IGraph

Returns:

a percent value representing the indeterminacy score.

getIndeterminantSections

public int getIndeterminantSections()

setIndeterminancyScore

public void setIndeterminancyScore(double indeterminacyScore)

Sets the percent value representing the indeterminacy score.

Specified by:

setIndeterminancyScore in interface IGraph

Parameters:

indeterminacyScore - the percent value representing the indeterminacy score.

setIndeterminantTimePairs

public void setIndeterminantTimePairs(java.util.ArrayList<java.lang.String> iTimePairs)

Sets the Indeterminant Time Pairs for the current Graph.

Specified by:

setIndeterminantTimePairs in interface IGraph

Parameters:

iTimePairs - List of Indeterminant Time Pairs.

See Also:

IndeterminacyDetector.detect(), IndeterminacyDetector.indeterminantTimePairs()

isConsistent

public boolean isConsistent()

Description copied from interface: IGraph

Returns true if the graph is consistent.

Specified by:

isConsistent in interface IGraph

Returns:

true if the graph is consistent.

getInconsistentSubgraphs

public java.util.Set<IGraph> getInconsistentSubgraphs()

Returns the set of inconsistent subgraphs.

Specified by:

getInconsistentSubgraphs in interface IGraph

Returns:

the set of inconsistent subgraphs.

clone

public Graph clone()

Returns a deep-copy of the current Graph object. Only contains the nodes and links.

Specified by:

clone in interface IGraph

Returns:

a deep-copy of the current Graph object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface IGraph

Overrides:

equals in class java.lang.Object

equalNodes

public boolean equalNodes(Graph obj)

Returns true if the clone graph contains all the node IDs in graph, returns false otherwise

Parameters:

obj - , graph clone

Returns:

true if the clone graph contains all the node IDs in graph, returns false otherwise

equalLinks

public boolean equalLinks(Graph obj)

Returns true if the clone graph contains all the links in graph, returns false otherwise

Parameters:

obj - , graph clone

Returns:

true if the clone graph contains all the links in graph, returns false otherwise

getText

public java.lang.String getText()

Returns the article text without TimeML tags.

Specified by:

getText in interface IGraph

Returns:

the article text without TimeML tags.

toJSON

public java.lang.String toJSON()

Returns the JSON (RFC 8259) representation of the Graph.

Specified by:

toJSON in interface IGraph

Returns:

the JSON (RFC 8259) representation of the Graph.

inconsistentSubGraphsToJSON

public java.lang.String inconsistentSubGraphsToJSON()

Formats and returns the JSON representation of the inconsistent subgraphs.

Returns:

the JSON formatted representation of the inconsistent subgraphs.

suggestLinks

public void suggestLinks()

suggestedLinksToString

public java.lang.String suggestedLinksToString()

Returns the string representation of the suggested links.

Returns:

the string representation of the suggested links.

getSuggestedLinks

public java.util.ArrayList<ILink> getSuggestedLinks()

Returns a list of suggested links to increase graph connectivity.

Returns:

a list of suggested links.

setSuggestedLinks

public void setSuggestedLinks(ILink x)

hasSelfLoops

public java.lang.Boolean hasSelfLoops()

Description copied from interface: IGraph

Returns whether the graph has self loops or not.

Specified by:

hasSelfLoops in interface IGraph

Returns:

true if graph contains self loops.

totalSelfLoops

public int totalSelfLoops()

Description copied from interface: IGraph

Returns the number of self loops in the graph.

Specified by:

totalSelfLoops in interface IGraph

Returns:

the number of self loops in the graph.