edu.stanford.nlp.pipeline

Class NERCombinerAnnotator

java.lang.Object

edu.stanford.nlp.pipeline.SentenceAnnotator

edu.stanford.nlp.pipeline.NERCombinerAnnotator

All Implemented Interfaces:

Annotator

public class NERCombinerAnnotator
extends SentenceAnnotator

This class will add NER information to an Annotation using a combination of NER models. It assumes that the Annotation already contains the tokenized words as a List<? extends CoreLabel> or a List<List<? extends CoreLabel>> under Annotation.WORDS_KEY and adds NER information to each CoreLabel, in the CoreLabel.NER_KEY field. It uses the NERClassifierCombiner class in the ie package.

Author:

Jenny Finkel, Mihai Surdeanu (modified it to work with the new NERClassifierCombiner)

Nested Class Summary

Nested classes/interfaces inherited from class edu.stanford.nlp.pipeline.SentenceAnnotator

SentenceAnnotator.AnnotatorProcessor

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

Annotator.Requirement

Field Summary

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

BINARIZED_TREES_REQUIREMENT, CLEAN_XML_REQUIREMENT, COLUMN_DATA_CLASSIFIER, DETERMINISTIC_COREF_REQUIREMENT, GENDER_REQUIREMENT, GUTIME_REQUIREMENT, HEIDELTIME_REQUIREMENT, LEMMA_REQUIREMENT, NATLOG_REQUIREMENT, NER_REQUIREMENT, NUMBER_REQUIREMENT, PARSE_AND_TAG, PARSE_REQUIREMENT, PARSE_TAG_BINARIZED_TREES, POS_REQUIREMENT, QUANTIFIABLE_ENTITY_NORMALIZATION_REQUIREMENT, QUOTE_REQUIREMENT, RELATION_EXTRACTOR_REQUIREMENT, SSPLIT_REQUIREMENT, STANFORD_CLEAN_XML, STANFORD_COLUMN_DATA_CLASSIFIER, STANFORD_DEPENDENCIES, STANFORD_DETERMINISTIC_COREF, STANFORD_ENTITY_MENTIONS, STANFORD_GENDER, STANFORD_LEMMA, STANFORD_NATLOG, STANFORD_NER, STANFORD_PARSE, STANFORD_POS, STANFORD_QUOTE, STANFORD_REGEXNER, STANFORD_RELATION, STANFORD_SENTIMENT, 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

Constructors

Constructor and Description
NERCombinerAnnotator()
NERCombinerAnnotator(boolean verbose)
NERCombinerAnnotator(boolean verbose, String... classifiers)
NERCombinerAnnotator(NERClassifierCombiner ner, boolean verbose)
NERCombinerAnnotator(NERClassifierCombiner ner, boolean verbose, int nThreads, long maxTime)
NERCombinerAnnotator(String name, Properties properties)

Method Summary

Modifier and Type	Method and Description
void	annotate(Annotation annotation) Given an Annotation, perform a task on this Annotation.
void	doOneFailedSentence(Annotation annotation, CoreMap sentence) Fills in empty annotations for trees, tags, etc if the annotator failed or timed out.
void	doOneSentence(Annotation annotation, CoreMap sentence) annotation is included in case there is global information we care about
protected long	maxTime()
protected int	nThreads()
Set<Annotator.Requirement>	requirementsSatisfied() Returns a set of requirements for which tasks this annotator can provide.
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

NERCombinerAnnotator

public NERCombinerAnnotator()
                     throws IOException,
                            ClassNotFoundException

Throws:

IOException

ClassNotFoundException

NERCombinerAnnotator

public NERCombinerAnnotator(boolean verbose)
                     throws IOException,
                            ClassNotFoundException

Throws:

IOException

ClassNotFoundException

NERCombinerAnnotator

public NERCombinerAnnotator(boolean verbose,
                            String... classifiers)
                     throws IOException,
                            ClassNotFoundException

Throws:

IOException

ClassNotFoundException

NERCombinerAnnotator

public NERCombinerAnnotator(NERClassifierCombiner ner,
                            boolean verbose)

NERCombinerAnnotator

public NERCombinerAnnotator(NERClassifierCombiner ner,
                            boolean verbose,
                            int nThreads,
                            long maxTime)

NERCombinerAnnotator

public NERCombinerAnnotator(String name,
                            Properties properties)

Method Detail

nThreads

protected int nThreads()

Specified by:

nThreads in class SentenceAnnotator

maxTime

protected long maxTime()

Specified by:

maxTime in class SentenceAnnotator

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

Overrides:

annotate in class SentenceAnnotator

doOneSentence

public void doOneSentence(Annotation annotation,
                          CoreMap sentence)

Description copied from class: SentenceAnnotator

annotation is included in case there is global information we care about

Specified by:

doOneSentence in class SentenceAnnotator

doOneFailedSentence

public void doOneFailedSentence(Annotation annotation,
                                CoreMap sentence)

Description copied from class: SentenceAnnotator

Fills in empty annotations for trees, tags, etc if the annotator failed or timed out. Not supposed to do major processing.

Specified by:

doOneFailedSentence in class SentenceAnnotator

requires

public 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".

requirementsSatisfied

public 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".