edu.stanford.nlp.time

Class Timex

java.lang.Object

edu.stanford.nlp.time.Timex

All Implemented Interfaces:

Serializable

public class Timex
extends Object
implements Serializable

Stores one TIMEX3 expression. This class is used for both TimeAnnotator and GUTimeAnnotator for storing information for TIMEX3 tags.

Example text with TIMEX3 annotation:
In Washington <TIMEX3 tid="t1" TYPE="DATE" VAL="PRESENT_REF" temporalFunction="true" valueFromFunction="tf1" anchorTimeID="t0">today</TIMEX3>, the Federal Aviation Administration released air traffic control tapes from the night the TWA Flight eight hundred went down.

TIMEX3 specification:

 attributes ::= tid type [functionInDocument] [beginPoint] [endPoint]
                [quant] [freq] [temporalFunction] (value | valueFromFunction)
                [mod] [anchorTimeID] [comment]

 tid ::= ID
   {tid ::= TimeID
    TimeID ::= t}
 type ::= 'DATE' | 'TIME' | 'DURATION' | 'SET'
 beginPoint ::= IDREF
    {beginPoint ::= TimeID}
 endPoint ::= IDREF
    {endPoint ::= TimeID}
 quant ::= CDATA
 freq ::= Duration
 functionInDocument ::= 'CREATION_TIME' | 'EXPIRATION_TIME' | 'MODIFICATION_TIME' |
                        'PUBLICATION_TIME' | 'RELEASE_TIME'| 'RECEPTION_TIME' |
                        'NONE' {default, if absent, is 'NONE'}
 temporalFunction ::= 'true' | 'false' {default, if absent, is 'false'}
    {temporalFunction ::= boolean}
 value ::= Duration | Date | Time | WeekDate | WeekTime | Season | PartOfYear | PaPrFu
 valueFromFunction ::= IDREF
    {valueFromFunction ::= TemporalFunctionID
 TemporalFunctionID ::= tf}
 mod ::= 'BEFORE' | 'AFTER' | 'ON_OR_BEFORE' | 'ON_OR_AFTER' |'LESS_THAN' | 'MORE_THAN' |
         'EQUAL_OR_LESS' | 'EQUAL_OR_MORE' | 'START' | 'MID' | 'END' | 'APPROX'
 anchorTimeID ::= IDREF
   {anchorTimeID ::= TimeID}
 comment ::= CDATA
 

References
Guidelines: http://www.timeml.org/tempeval2/tempeval2-trial/guidelines/timex3guidelines-072009.pdf
Specifications: http://www.timeml.org/site/publications/timeMLdocs/timeml_1.2.1.html#timex3
XSD: http://www.timeml.org/timeMLdocs/TimeML.xsd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Timex()
Timex(Element element)
Timex(String val)
Timex(String type, String val)
Timex(String type, String val, String altVal, String tid, String text, int beginPoint, int endPoint)

Method Summary

Methods

Modifier and Type	Method and Description
String	altVal()
int	beginPoint()
int	endPoint()
boolean	equals(Object o)
static Timex	fromMap(String text, Map<String,String> map)
static Timex	fromXml(String xml)
Calendar	getDate() Gets the Calendar matching the year, month and day of this Timex.
Pair<Calendar,Calendar>	getRange() Gets two Calendars, marking the beginning and ending of this Timex's range.
Pair<Calendar,Calendar>	getRange(Timex documentTime) Gets two Calendars, marking the beginning and ending of this Timex's range.
int	hashCode()
String	text()
String	tid()
String	timexType()
String	toString()
Element	toXmlElement()
String	value()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Timex

public Timex()

Timex

public Timex(Element element)

Timex

public Timex(String val)

Timex

public Timex(String type,
     String val)

Timex

public Timex(String type,
     String val,
     String altVal,
     String tid,
     String text,
     int beginPoint,
     int endPoint)

Method Detail

value

public String value()

altVal

public String altVal()

text

public String text()

timexType

public String timexType()

tid

public String tid()

beginPoint

public int beginPoint()

endPoint

public int endPoint()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXmlElement

public Element toXmlElement()

fromXml

public static Timex fromXml(String xml)

fromMap

public static Timex fromMap(String text,
            Map<String,String> map)

getDate

public Calendar getDate()

Gets the Calendar matching the year, month and day of this Timex.

Returns:

The matching Calendar.

getRange

public Pair<Calendar,Calendar> getRange()

Gets two Calendars, marking the beginning and ending of this Timex's range.

Returns:

The begin point and end point Calendars.

getRange

public Pair<Calendar,Calendar> getRange(Timex documentTime)

Gets two Calendars, marking the beginning and ending of this Timex's range.

Parameters:

documentTime - The time the document containing this Timex was written. (Not necessary for resolving all Timex expressions. This may be null, but then relative time expressions cannot be resolved.)

Returns:

The begin point and end point Calendars.