edu.illinois.cs.cogcomp.ner

Class NERAnnotator

java.lang.Object

edu.illinois.cs.cogcomp.annotation.Annotator

edu.illinois.cs.cogcomp.ner.NERAnnotator

public class NERAnnotator
extends Annotator

Generate NER annotations using the Annotator API.

Author:

redman

Field Summary

Fields inherited from class edu.illinois.cs.cogcomp.annotation.Annotator

config, isInitialized, requiredViews, viewName

Constructor Summary

Constructors

Constructor and Description
NERAnnotator(ResourceManager nonDefaultRm, String viewName) Default behavior is to use lazy initialization; override with ResourceManager entry per the Configurator property AnnotatorConfigurator.IS_LAZILY_INITIALIZED
NERAnnotator(String viewName) default constructor -- NER_CONLL models will be loaded.
NERAnnotator(String nonDefaultConfigValues, String viewName)

Method Summary

Modifier and Type	Method and Description
void	addView(TextAnnotation ta) Generate the view representing the list of extracted entities and adds it the TextAnnotation.
Set<String>	getTagValues() Return possible tag values that the NERAnnotator can produce.
void	initialize(ResourceManager nerRm) Superclass calls this method either on instantiation or at first call to getView().

Methods inherited from class edu.illinois.cs.cogcomp.annotation.Annotator

doInitialize, getRequiredViews, getView, getViewName, isInitialized, isSentenceLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

NERAnnotator

public NERAnnotator(String nonDefaultConfigValues,
                    String viewName)
             throws IOException

Parameters:

nonDefaultConfigValues - a configuration file specifying non-default parameters for the NER model to use

viewName - indicates the view name, and hence the model, that you wish to use. If you specify ViewNames.NER_CONLL or ViewNames.NER_ONTONOTES, This name will be used when creating Views in TextAnnotation objects.

Throws:

IOException

NERAnnotator

public NERAnnotator(String viewName)
             throws IOException

default constructor -- NER_CONLL models will be loaded. Lazily initialized by default.

Parameters:

viewName - name of view this annotator will add.

Throws:

IOException

NERAnnotator

public NERAnnotator(ResourceManager nonDefaultRm,
                    String viewName)

Default behavior is to use lazy initialization; override with ResourceManager entry per the Configurator property AnnotatorConfigurator.IS_LAZILY_INITIALIZED

Parameters:

nonDefaultRm - specify properties to override defaults, including lazy initialization

viewName - name of the view to add to the TextAnnotation (and for client to request)

Method Detail

initialize

public void initialize(ResourceManager nerRm)

Superclass calls this method either on instantiation or at first call to getView(). Logging has been disabled because non-static logger is not initialized at the time this is called if non-lazy initialization is specified.

Specified by:

initialize in class Annotator

Parameters:

nerRm - configuration parameters passed to constructor

addView

public void addView(TextAnnotation ta)

Generate the view representing the list of extracted entities and adds it the TextAnnotation.

Specified by:

addView in class Annotator

Parameters:

ta - the TextAnnotation to modify.

getTagValues

public Set<String> getTagValues()

Return possible tag values that the NERAnnotator can produce.

Overrides:

getTagValues in class Annotator

Returns:

the set of string representing the tag values