Package edu.stanford.nlp.time

Class HeidelTimeAnnotator

java.lang.Object

edu.stanford.nlp.time.HeidelTimeAnnotator

All Implemented Interfaces:

Annotator

public class HeidelTimeAnnotator
extends Object
implements Annotator

Annotates text using HeidelTime. GUTIME/TimeML specifications can be found at: http://www.timeml.org/site/tarsqi/modules/gutime/index.html.

Author:

Gabor Angeli

Field Summary

Fields

Modifier and Type	Field	Description
static String	HEIDELTIME_LANGUAGE_PROPERTY
static String	HEIDELTIME_OUTPUT_RESULTS
static String	HEIDELTIME_PATH_PROPERTY

Fields inherited from interface edu.stanford.nlp.pipeline.Annotator

DEFAULT_REQUIREMENTS, STANFORD_CDC_TOKENIZE, STANFORD_CLEAN_XML, STANFORD_COLUMN_DATA_CLASSIFIER, STANFORD_COREF, STANFORD_COREF_MENTION, STANFORD_DEPENDENCIES, STANFORD_DETERMINISTIC_COREF, STANFORD_DOCDATE, STANFORD_ENTITY_MENTIONS, STANFORD_GENDER, STANFORD_KBP, STANFORD_LEMMA, STANFORD_LINK, STANFORD_MWT, STANFORD_NATLOG, STANFORD_NER, STANFORD_OPENIE, STANFORD_PARSE, STANFORD_POS, STANFORD_QUOTE, STANFORD_QUOTE_ATTRIBUTION, STANFORD_REGEXNER, STANFORD_RELATION, STANFORD_SENTIMENT, STANFORD_SSPLIT, STANFORD_TOKENIZE, STANFORD_TOKENSREGEX, STANFORD_TRUECASE, STANFORD_UD_FEATURES

Constructor Summary

Constructors

Constructor	Description
HeidelTimeAnnotator()
HeidelTimeAnnotator(File heideltimePath)
HeidelTimeAnnotator(File heideltimePath, String language, boolean outputResults)
HeidelTimeAnnotator(String name, Properties props)

Method Summary

Modifier and Type	Method	Description
void	annotate(Annotation annotation)	Given an Annotation, perform a task on this Annotation.
void	annotate(CoreMap document)
Set<Class<? extends CoreAnnotation>>	requirementsSatisfied()	Returns a set of requirements for which tasks this annotator can provide.
Set<Class<? extends CoreAnnotation>>	requires()	Returns the set of tasks which this annotator requires in order to perform.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.stanford.nlp.pipeline.Annotator

exactRequirements, unmount

Field Detail

HEIDELTIME_PATH_PROPERTY

public static final String HEIDELTIME_PATH_PROPERTY

See Also:

Constant Field Values

HEIDELTIME_LANGUAGE_PROPERTY

public static final String HEIDELTIME_LANGUAGE_PROPERTY

See Also:

Constant Field Values

HEIDELTIME_OUTPUT_RESULTS

public static final String HEIDELTIME_OUTPUT_RESULTS

See Also:

Constant Field Values

Constructor Detail

HeidelTimeAnnotator

public HeidelTimeAnnotator()

HeidelTimeAnnotator

public HeidelTimeAnnotator(File heideltimePath)

HeidelTimeAnnotator

public HeidelTimeAnnotator(File heideltimePath,
                           String language,
                           boolean outputResults)

HeidelTimeAnnotator

public HeidelTimeAnnotator(String name,
                           Properties props)

Method Detail

annotate

public void annotate(Annotation annotation)

Description copied from interface: Annotator

Given an Annotation, perform a task on this Annotation.

Specified by:

annotate in interface Annotator

annotate

public void annotate(CoreMap document)
              throws IOException

Throws:

IOException

requires

public Set<Class<? extends CoreAnnotation>> requires()

Description copied from interface: Annotator

Returns the set of tasks which this annotator requires in order to perform. For example, the POS annotator will return "tokenize", "ssplit".

Specified by:

requires in interface Annotator

requirementsSatisfied

public Set<Class<? extends CoreAnnotation>> requirementsSatisfied()

Description copied from interface: Annotator

Returns a set of requirements for which tasks this annotator can provide. For example, the POS annotator will return "pos".

Specified by:

requirementsSatisfied in interface Annotator