edu.stanford.nlp.pipeline

Class DocDateAnnotator

java.lang.Object

edu.stanford.nlp.pipeline.DocDateAnnotator

All Implemented Interfaces:

Annotator

public class DocDateAnnotator
extends java.lang.Object
implements Annotator

Find and record a document (authoring) date for a document. This document date can be used, for instance, in resolving time expressions like "next Thursday". The document date can be today, passed in via a property, given by a filename to date mapping file, or it may be extracted from a filename by regex. The document date is stored as a YYYY-MM-DD String under the CoreAnnotations.DocDateAnnotation key.

Author:

Sebastian Schuster

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	DATE_NO_HYPHENS_PATTERN
static java.util.regex.Pattern	DATE_PROPER_FORMAT
static java.lang.String	DOC_DATE_FIXED_PROPERTY
static java.lang.String	DOC_DATE_MAPPING_FILE_PROPERTY
static java.lang.String	DOC_DATE_PRESENT_PROPERTY
static java.lang.String	DOC_DATE_REGEX_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 and Description
DocDateAnnotator(java.lang.String name, java.util.Properties props)

Method Summary

Modifier and Type	Method and Description
void	annotate(Annotation annotation) Given an Annotation, perform a task on this Annotation.
java.lang.String	currentDate() helper for return current date
java.util.Set<java.lang.Class<? extends CoreAnnotation>>	requirementsSatisfied() Returns a set of requirements for which tasks this annotator can provide.
java.util.Set<java.lang.Class<? extends CoreAnnotation>>	requires() Returns the set of tasks which this annotator requires in order to perform.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

exactRequirements, unmount

Field Detail

DOC_DATE_FIXED_PROPERTY

public static final java.lang.String DOC_DATE_FIXED_PROPERTY

See Also:

Constant Field Values

DOC_DATE_MAPPING_FILE_PROPERTY

public static final java.lang.String DOC_DATE_MAPPING_FILE_PROPERTY

See Also:

Constant Field Values

DOC_DATE_PRESENT_PROPERTY

public static final java.lang.String DOC_DATE_PRESENT_PROPERTY

See Also:

Constant Field Values

DOC_DATE_REGEX_PROPERTY

public static final java.lang.String DOC_DATE_REGEX_PROPERTY

See Also:

Constant Field Values

DATE_PROPER_FORMAT

public static final java.util.regex.Pattern DATE_PROPER_FORMAT

DATE_NO_HYPHENS_PATTERN

public static final java.util.regex.Pattern DATE_NO_HYPHENS_PATTERN

Constructor Detail

DocDateAnnotator

public DocDateAnnotator(java.lang.String name,
                        java.util.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

currentDate

public java.lang.String currentDate()

helper for return current date

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

requires

public java.util.Set<java.lang.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 java.util.Set<java.lang.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