Package edu.fiu.jtlex.data
Interface ILink
- All Known Implementing Classes:
Link
public interface ILink
Interface of Link attributes shared by 3 Links (TLink,SLink,ALink).
- Since:
- Revision 33
- Author:
- Pablo Maldonado
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumEnum that represents the temporal relation holding between the entities for ALink.static enumEnum that represents the type of link.static enumEnum that represents whether the TLink was generated manually or by closure.static enumEnum that represents the temporal relation holding between the entities for SLink.static enumEnum that represents temporal relation holding between the entities for a TLink. -
Method Summary
Modifier and TypeMethodDescriptionclone()Returns a deep copy of the Link.Returns the ID of the event instance involved in the link.intReturns the ID of the link.Returns the type of Link.Returns whether a TLINK was generatedMANUALLYor byCLOSURE.Returns the ID of the entity that is being related to the event instance with ID=eventInstanceID or time expression with ID=timeID.This is the temporal relation holding between the entities.Returns the ID of the relation signal.Returns the syntax of the link.inthashCode()toJSON()Returns the JSON (RFC 8259) representation of the Link.toString()Returns the String representation of the Link.
-
Method Details
-
getLinkID
int getLinkID()Returns the ID of the link.
Link ID gives each TimeML link an identification number OPTIONAL- Returns:
- the ID of the link.
- Since:
- Revision 33
-
getLinkTag
ILink.LinkTag getLinkTag()Returns the type of Link.- Returns:
ILink.LinkTag.TLINK/ILink.LinkTag.ALINK/ILink.LinkTag.SLINK- Since:
- Revision 33
-
getSyntax
String getSyntax()Returns the syntax of the link.
Syntax holds any syntactic pattern that was used in generating the link (e.g. from an automatic annotation tool).
OPTIONAL- Returns:
- the syntax of the link.
- Since:
- Revision 33
-
getEventInstance
INode getEventInstance()Returns the ID of the event instance involved in the link. OBLIGATORY- Returns:
- the ID of the event instance involved in the link.
- Since:
- Revision 54
-
getSignal
ISignal getSignal()Returns the ID of the relation signal.
If the temporal relation holding between the entities is explicitly signaled in the text, then the ID of that signal needs to be supplied here.
OPTIONAL- Returns:
- the optional ID of the relation signal.
- Since:
- Revision 33
-
getOrigin
ILink.Origintype getOrigin()Returns whether a TLINK was generatedMANUALLYor byCLOSURE.
THIS IS ONLY FOR TLINK- Returns:
- Whether link was generated
MANUALLYor byCLOSURE - Since:
- Revision 42
-
getRelatedToNode
INode getRelatedToNode()Returns the ID of the entity that is being related to the event instance with ID=eventInstanceID or time expression with ID=timeID.
relatedToEventInstance or relatedToTime needs to be present.- Returns:
- the ID of the entity that is being related to the event instance with ID=eventInstanceID or time expression with ID=timeID.
- Since:
- Revision 394
-
getRelType
ILinkType getRelType()This is the temporal relation holding between the entities.
These are represented by 3 different enums:- ALinkRelType
- SLinkRelType
- TLinkRelType
The returned type depends on the linkTag.- Returns:
ALinkRelType/SLinkRelType/TLinkRelType- Since:
- Revision 42
- See Also:
-
hashCode
int hashCode() -
toString
String toString()Returns the String representation of the Link. -
toJSON
String toJSON()Returns the JSON (RFC 8259) representation of the Link.- Returns:
- the JSON (RFC 8259) representation of the Link.
- Since:
- Revision 391
-
clone
ILink clone()Returns a deep copy of the Link.- Returns:
- a deep copy of the Link.
- Since:
- Revision 394
-