edu.stanford.nlp.time

Class TimeExpressionExtractorImpl

java.lang.Object

edu.stanford.nlp.time.TimeExpressionExtractorImpl

All Implemented Interfaces:

TimeExpressionExtractor

public class TimeExpressionExtractorImpl
extends java.lang.Object
implements TimeExpressionExtractor

Extracts time expressions.

Author:

Angel Chang

Constructor Summary

Constructors

Constructor and Description
TimeExpressionExtractorImpl()
TimeExpressionExtractorImpl(java.lang.String name, java.util.Properties props)

Method Summary

Modifier and Type	Method and Description
java.util.List<CoreMap>	extractTimeExpressionCoreMaps(CoreMap annotation, CoreMap docAnnotation) Extract time expressions from a sentence in a document.
java.util.List<CoreMap>	extractTimeExpressionCoreMaps(CoreMap annotation, java.lang.String docDate) Extract time expressions in a document (provided as a CoreMap Annotation).
java.util.List<CoreMap>	extractTimeExpressionCoreMaps(CoreMap annotation, java.lang.String docDate, SUTime.TimeIndex timeIndex)
java.util.List<TimeExpression>	extractTimeExpressions(CoreMap annotation, java.lang.String refDateStr, SUTime.TimeIndex timeIndex)
java.util.List<TimeExpression>	extractTimeExpressions(CoreMap annotation, SUTime.Time refDate, SUTime.TimeIndex timeIndex)
void	finalize(CoreMap docAnnotation) Indicates that all annotations on the document has been completed Performs cleanup on the document annotation.
void	init(Options options)
void	init(java.lang.String name, java.util.Properties props)

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeExpressionExtractorImpl

public TimeExpressionExtractorImpl()

TimeExpressionExtractorImpl

public TimeExpressionExtractorImpl(java.lang.String name,
                                   java.util.Properties props)

Method Detail

init

public void init(java.lang.String name,
                 java.util.Properties props)

Specified by:

init in interface TimeExpressionExtractor

init

public void init(Options options)

Specified by:

init in interface TimeExpressionExtractor

extractTimeExpressionCoreMaps

public java.util.List<CoreMap> extractTimeExpressionCoreMaps(CoreMap annotation,
                                                             CoreMap docAnnotation)

Description copied from interface: TimeExpressionExtractor

Extract time expressions from a sentence in a document. The document is assumed to contain the document date. The document is also used to hold stateful information (e.g. the index used by SUTime to generate timex ids). Both the sentence and document are provided as a CoreMap Annotation.

Specified by:

extractTimeExpressionCoreMaps in interface TimeExpressionExtractor

Parameters:

annotation - - Annotation holding tokenized text from which the time expressions are to be extracted

docAnnotation - - Annotation for the entire document Uses the following annotations: CoreAnnotations.DocDateAnnotation.class (String representing document date) TimeExpression.TimeIndexAnnotation.class (Holds index used to generate tids)

Returns:

List of CoreMaps

extractTimeExpressionCoreMaps

public java.util.List<CoreMap> extractTimeExpressionCoreMaps(CoreMap annotation,
                                                             java.lang.String docDate)

Description copied from interface: TimeExpressionExtractor

Extract time expressions in a document (provided as a CoreMap Annotation).

Specified by:

extractTimeExpressionCoreMaps in interface TimeExpressionExtractor

Parameters:

annotation - The annotation to run time expression extraction over

docDate - A date for the document to be used as a reference time.

Returns:

A list of CoreMap. Each CoreMap represents a detected temporal expression. Each CoreMap is a pipeline.Annotation, and you can get various attributes of the temporal expression out of it. For example, you can get the list of tokens with:

     
     List<CoreMap> cm = extractTimeExpressionCoreMaps(annotation, docDate);
     List<CoreLabel> tokens = cm.get(CoreAnnotations.TokensAnnotation.class); 
     

extractTimeExpressionCoreMaps

public java.util.List<CoreMap> extractTimeExpressionCoreMaps(CoreMap annotation,
                                                             java.lang.String docDate,
                                                             SUTime.TimeIndex timeIndex)

finalize

public void finalize(CoreMap docAnnotation)

Description copied from interface: TimeExpressionExtractor

Indicates that all annotations on the document has been completed Performs cleanup on the document annotation.

Specified by:

finalize in interface TimeExpressionExtractor

Parameters:

docAnnotation - A document annotation.

extractTimeExpressions

public java.util.List<TimeExpression> extractTimeExpressions(CoreMap annotation,
                                                             java.lang.String refDateStr,
                                                             SUTime.TimeIndex timeIndex)

extractTimeExpressions

public java.util.List<TimeExpression> extractTimeExpressions(CoreMap annotation,
                                                             SUTime.Time refDate,
                                                             SUTime.TimeIndex timeIndex)