edu.stanford.nlp.pipeline
Class TokensRegexAnnotator

java.lang.Object
  edu.stanford.nlp.pipeline.TokensRegexAnnotator

All Implemented Interfaces:

Annotator

public class TokensRegexAnnotator
extends java.lang.Object
implements Annotator

Uses TokensRegex patterns to annotate tokens.

Configuration:

• rules - Name of file containing extraction rules (see CoreMapExpressionExtractor and SequenceMatchRules

Other options (can be set in rules file using options.xxx = ...)

• setTokenOffsets - whether to explicit set the token offsets of individual tokens (needed to token sequence matches to work)
• extractWithTokens - whether to return unmatched tokens as well
• flatten - whether to flatten matched expressions into individual tokens
• matchedExpressionsAnnotationKey - Annotation key where matched expressions are stored as a list

Multiple TokensRegexAnnotator can be configured using the same properties file by specifying difference prefix for the TokensRegexAnnotator

Author:

Angel Chang

Nested Class Summary

static class

TokensRegexAnnotator.Options

Nested classes/interfaces inherited from interface edu.stanford.nlp.pipeline.Annotator

Annotator.Requirement

Field Summary

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

CLEAN_XML_REQUIREMENT, DETERMINISTIC_COREF_REQUIREMENT, GENDER_REQUIREMENT, GUTIME_REQUIREMENT, HEIDELTIME_REQUIREMENT, LEMMA_REQUIREMENT, NER_REQUIREMENT, NFL_REQUIREMENT, NFL_TOKENIZE_REQUIREMENT, NUMBER_REQUIREMENT, PARSE_AND_TAG, PARSE_REQUIREMENT, POS_REQUIREMENT, QUANTIFIABLE_ENTITY_NORMALIZATION_REQUIREMENT, SSPLIT_REQUIREMENT, STANFORD_CLEAN_XML, STANFORD_DETERMINISTIC_COREF, STANFORD_GENDER, STANFORD_LEMMA, STANFORD_NER, STANFORD_NFL, STANFORD_NFL_TOKENIZE, STANFORD_PARSE, STANFORD_POS, STANFORD_REGEXNER, STANFORD_SSPLIT, STANFORD_TOKENIZE, STANFORD_TRUECASE, STEM_REQUIREMENT, SUTIME_REQUIREMENT, TIME_WORDS_REQUIREMENT, TOKENIZE_AND_SSPLIT, TOKENIZE_REQUIREMENT, TOKENIZE_SSPLIT_NER, TOKENIZE_SSPLIT_PARSE, TOKENIZE_SSPLIT_PARSE_NER, TOKENIZE_SSPLIT_POS, TOKENIZE_SSPLIT_POS_LEMMA, TRUECASE_REQUIREMENT

Constructor Summary

TokensRegexAnnotator(java.util.Properties props)

TokensRegexAnnotator(java.lang.String... files)

TokensRegexAnnotator(java.lang.String name, java.util.Properties props)

Method Summary

void	addTokenOffsets(CoreMap annotation)
void	annotate(Annotation annotation) Given an Annotation, perform a task on this Annotation.
java.util.Set<Annotator.Requirement>	requirementsSatisfied() Returns a set of requirements for which tasks this annotator can provide.
java.util.Set<Annotator.Requirement>	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

Constructor Detail

TokensRegexAnnotator

public TokensRegexAnnotator(java.lang.String... files)

TokensRegexAnnotator

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

TokensRegexAnnotator

public TokensRegexAnnotator(java.util.Properties props)

Method Detail

addTokenOffsets

public void addTokenOffsets(CoreMap annotation)

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

requires

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