edu.stanford.nlp.time
Class SUTime.Temporal

java.lang.Object
  edu.stanford.nlp.time.SUTime.Temporal

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

SUTime.Duration, SUTime.Range, SUTime.TemporalSet, SUTime.Time

Enclosing class:

SUTime

public abstract static class SUTime.Temporal
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Basic temporal object

There are 4 main types of temporal objects

1. Time - Conceptually a point in time
   NOTE: Due to limitation in precision, it is difficult to get an exact point in time
2. Duration - Amount of time in a time interval
   • DurationWithMillis - Duration specified in milliseconds (wrapper around JodaTime Duration)
   • DurationWithFields - Duration specified with fields like day, year, etc (wrapper around JodaTime Period)
   • DurationRange - A duration that falls in a particular range (with min to max)
3. Range - Time Interval with a start time, end time, and duration
4. TemporalSet - A set of temporal objects
   • ExplicitTemporalSet - Explicit set of temporals (not used)
     Ex: Tuesday 1-2pm, Wednesday night
   • PeriodicTemporalSet - Reoccuring times
     Ex: Every Tuesday

See Also:

Serialized Form

Field Summary

boolean	approx
java.lang.String	mod
java.lang.String	timeLabel

Constructor Summary

SUTime.Temporal()

SUTime.Temporal(SUTime.Temporal t)

Method Summary

SUTime.Temporal	addMod(java.lang.String mod)
SUTime.Temporal	addModApprox(java.lang.String mod, boolean approx)
abstract SUTime.Duration	getDuration()
SUTime.Duration	getGranularity()
java.lang.String	getMod()
SUTime.Duration	getPeriod()
SUTime.Range	getRange()
SUTime.Range	getRange(int flags)
abstract SUTime.Range	getRange(int flags, SUTime.Duration granularity)
SUTime.StandardTemporalType	getStandardTemporalType()
int	getTfid(SUTime.TimeIndex timeIndex)
java.lang.String	getTfidString(SUTime.TimeIndex timeIndex)
int	getTid(SUTime.TimeIndex timeIndex)
java.lang.String	getTidString(SUTime.TimeIndex timeIndex)
abstract SUTime.Time	getTime()
java.lang.String	getTimeLabel()
java.util.Map<java.lang.String,java.lang.String>	getTimexAttributes(SUTime.TimeIndex timeIndex)
SUTime.TimexType	getTimexType()
java.lang.String	getTimexValue()
boolean	includeTimexAltValue()
SUTime.Temporal	intersect(SUTime.Temporal t)
boolean	isApprox()
abstract boolean	isGrounded()
boolean	isRef()
SUTime.Temporal	next()
SUTime.Temporal	prev()
SUTime.Temporal	resolve(SUTime.Time refTime)
abstract SUTime.Temporal	resolve(SUTime.Time refTime, int flags)
SUTime.Temporal	setTimeZone(org.joda.time.DateTimeZone tz)
static SUTime.Temporal	setTimeZone(SUTime.Temporal t, org.joda.time.DateTimeZone tz)
java.lang.String	toFormattedString(int flags)
java.lang.String	toISOString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mod

public java.lang.String mod

approx

public boolean approx

timeLabel

public java.lang.String timeLabel

Constructor Detail

SUTime.Temporal

public SUTime.Temporal()

SUTime.Temporal

public SUTime.Temporal(SUTime.Temporal t)

Method Detail

isGrounded

public abstract boolean isGrounded()

getTime

public abstract SUTime.Time getTime()

getDuration

public abstract SUTime.Duration getDuration()

getRange

public SUTime.Range getRange()

getRange

public SUTime.Range getRange(int flags)

getRange

public abstract SUTime.Range getRange(int flags,
                                      SUTime.Duration granularity)

getPeriod

public SUTime.Duration getPeriod()

getGranularity

public SUTime.Duration getGranularity()

resolve

public SUTime.Temporal resolve(SUTime.Time refTime)

resolve

public abstract SUTime.Temporal resolve(SUTime.Time refTime,
                                        int flags)

getStandardTemporalType

public SUTime.StandardTemporalType getStandardTemporalType()

isRef

public boolean isRef()

isApprox

public boolean isApprox()

getTid

public int getTid(SUTime.TimeIndex timeIndex)

getTidString

public java.lang.String getTidString(SUTime.TimeIndex timeIndex)

getTfid

public int getTfid(SUTime.TimeIndex timeIndex)

getTfidString

public java.lang.String getTfidString(SUTime.TimeIndex timeIndex)

includeTimexAltValue

public boolean includeTimexAltValue()

getTimexAttributes

public java.util.Map<java.lang.String,java.lang.String> getTimexAttributes(SUTime.TimeIndex timeIndex)

getTimexType

public SUTime.TimexType getTimexType()

getTimexValue

public java.lang.String getTimexValue()

toISOString

public java.lang.String toISOString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTimeLabel

public java.lang.String getTimeLabel()

toFormattedString

public java.lang.String toFormattedString(int flags)

setTimeZone

public static SUTime.Temporal setTimeZone(SUTime.Temporal t,
                                          org.joda.time.DateTimeZone tz)

setTimeZone

public SUTime.Temporal setTimeZone(org.joda.time.DateTimeZone tz)

next

public SUTime.Temporal next()

prev

public SUTime.Temporal prev()

intersect

public SUTime.Temporal intersect(SUTime.Temporal t)

getMod

public java.lang.String getMod()

addMod

public SUTime.Temporal addMod(java.lang.String mod)

addModApprox

public SUTime.Temporal addModApprox(java.lang.String mod,
                                    boolean approx)