Package edu.fiu.jtlex.data
Interface ITimex
- All Superinterfaces:
INode
- All Known Implementing Classes:
Timex
Represents the TIME tag.
This assumes usage of TimeML TIMEX3 standards;
"Since the details of the tag set that TimeML uses to annotate temporal
expressions differ in detail both from the TIMEX tag in STAG (Sheffield
Temporal Annotation Guidelines) and the TIMEX2 tag in TIDES,
we here use the tag name TIMEX3 for temporal expressions."
-TimeML Annotation
Guidelines Version 1.2.1
- Since:
- Revision 35
- Author:
- ceber003
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumAn enum that represents the seven different functions an object may belong to.
Function may belong to: CREATION_TIMEMODIFICATION_TIME PUBLICATION_TIMERELEASE_TIMERECEPTION_TIME EXPIRATION_TIMENONEstatic enumAn enum that represents the twelve different Mod states an object may belong to.static enumAn enum that represents the four different types an object may belong to.
Timex may belong to: DATETIME DURATIONSET type -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a link to the set of IN links from this node.voidaddOutLink(ILink link) Add a link to the set of OUT links from this node.clone()Creates and returns a copy of the Timex.intReturns the integer part of the anchortimeId.Returns the string part of the anchortimeId.intReturns the integer part of the beginpointId.Returns the string part of the beginpointId.intReturns the integer part of the endpointId.Returns the string part of the endpointId.getFreq()Returns frequency String portion.Returns the function to which the object belongs.intgetId()Returns the integer part of the tID.getIdStr()Returns the tID.Returns the set of TimeML links which come to this node.getMod()Returns the mod to which the object belongs.Returns the set of TimeML links which come from this node.Returns the phrase from the text annotated as timex.getQuant()Returns the quantity to which the object belongs.booleanReturns the inary attribute which expresses that the value of the temporal expression needs to be determined via evaluation of a temporal function.getType()Returns the type of the timex.getValue()Returns the string representation of the value.voidremoveInLink(ILink link) Removes a TimeML link from the set of links that end in this node.voidremoveOutLink(ILink link) Removes a TimeML link from the set of links that start in this node.toJSON()Returns the JSON (RFC 8259) representation of the Timex.toString()Returns the info of the Timex in String format.
-
Method Details
-
getId
int getId()Returns the integer part of the tID. Will never be null as it is required for the constructor. -
getIdStr
String getIdStr()Returns the tID. Will never be null since the tID was required in the constructor. -
getType
ITimex.TimexType getType()Returns the type of the timex. -
getValue
String getValue()Returns the string representation of the value. The value of the the timex tag determines what the actual amount of time for the date, time, duration, and set types.- Returns:
- the string representation of the value. May not be null.
- Since:
- Revision 35
-
getMod
ITimex.TimexMod getMod()Returns the mod to which the object belongs. This value is optional.- Returns:
- the mod to which the object belongs.
May be
null. - Since:
- Revision 35
- See Also:
-
getTemporalFunction
boolean getTemporalFunction()Returns the inary attribute which expresses that the value of the temporal expression needs to be determined via evaluation of a temporal function.- Returns:
- the inary attribute which expresses that the value of the temporal expression needs to be determined via evaluation of a temporal function.
- Since:
- Revision 90
-
getAnchorTimeId
int getAnchorTimeId()Returns the integer part of the anchortimeId. Each anchortime has to be identified by a unique ID number. This value is optional.- Returns:
- the integer part of the anchortimeId. May not be negative
- Since:
- Revision 35
-
getAnchorTimeIdStr
String getAnchorTimeIdStr()Returns the string part of the anchortimeId. Each anchortime has to be identified by a unique ID number. This value is optional.- Returns:
- the string part of the anchortimeId. May not be null.
- Since:
- Revision 35
-
getFunction
ITimex.FunctionInDocument getFunction()Returns the function to which the object belongs. Function in document can be one of seven values. If it is not specified then it will be set as 'NONE' by default.- Returns:
- the function to which the object belongs.
May be
null. - Since:
- Revision 35
-
getBeginPoint
int getBeginPoint()Returns the integer part of the beginpointId. Beginpoint is only used if the expression is anchored to another timex expression. Each beginpoint has to be identified by a unique ID number. If only endpoint is provided may create an empty timex to fill in.- Returns:
- the integer part of the beginpointId. May not be negative
- Since:
- Revision 35
-
getBeginPointStr
String getBeginPointStr()Returns the string part of the beginpointId. Beginpoint is only used if the expression is anchored to another timex expression. Each beginpoint has to be identified by a unique ID number. If only endpoint is provided may create an empty timex to fill in.- Returns:
- the string part of the beginpointId.
May not be
null. - Since:
- Revision 35
-
getEndPoint
int getEndPoint()Returns the integer part of the endpointId. Endpoint is only used if the expression is anchored to another timex expression. Each endpoint has to be identified by a unique ID number. If only beginpoint is provided may create an empty timex to fill in.- Returns:
- the integer part of the endpointId. May not be negative.
- Since:
- Revision 35
-
getEndPointStr
String getEndPointStr()Returns the string part of the endpointId. Endpoint is only used if the expression is anchored to another timex expression. Each endpoint has to be identified by a unique ID number. If only beginpoint is provided may create an empty timex to fill in.- Returns:
- the string part of the endpointId.
May not be
null. - Since:
- Revision 35
-
getQuant
String getQuant()Returns the quantity to which the object belongs. The quant value is only used if the timex type is 'SET'.- Returns:
- the quantity to which the object belongs.
May be
null. - Since:
- Revision 35
-
getFreq
String getFreq()Returns frequency String portion. The frequency value is only used if the timex type is 'SET'. The integer value determines the number of time the frequency takes. i.e: 2 Weeks, 3 Months, 1 Day, etc.- Returns:
- frequency String portion.
May be
null. - Since:
- Revision 35
-
getPhrase
String getPhrase()Returns the phrase from the text annotated as timex.- Returns:
- the phrase from the text annotated as timex.
- Since:
- Revision 90
May be
null.
-
addOutLink
Add a link to the set of OUT links from this node.- Specified by:
addOutLinkin interfaceINode- Parameters:
link- : A new OUT link from this node.- Since:
- Revision 769
-
addInLink
Add a link to the set of IN links from this node. -
getOutLinks
Returns the set of TimeML links which come from this node.- Specified by:
getOutLinksin interfaceINode- Returns:
- the set of TimeML links which come from this node.
- Since:
- Revision 769
-
getInLinks
Returns the set of TimeML links which come to this node.- Specified by:
getInLinksin interfaceINode- Returns:
- the set of TimeML links which come to this node.
- Since:
- Revision 769
-
removeOutLink
Removes a TimeML link from the set of links that start in this node.- Specified by:
removeOutLinkin interfaceINode- Parameters:
link- a new OUT link to remove from the set of outgoing links.- Since:
- Revision 769
-
removeInLink
Removes a TimeML link from the set of links that end in this node.- Specified by:
removeInLinkin interfaceINode- Parameters:
link- a new In link to remove from the set of incoming links.- Since:
- Revision 769
-
toString
String toString()Returns the info of the Timex in String format. -
toJSON
String toJSON()Returns the JSON (RFC 8259) representation of the Timex. Will never return null. -
clone
Timex clone()Creates and returns a copy of the Timex. Will never return null.
-