edu.illinois.cs.cogcomp.annotation

Class Annotator

java.lang.Object

edu.illinois.cs.cogcomp.annotation.Annotator

Direct Known Subclasses:

BrownClusterViewGenerator, ChunkerAnnotator, ClauseViewGenerator, ClausIEAnnotator, CommaLabeler, CuratorAnnotator, DepAnnotator, GazetteerViewGenerator, HeadFinderDependencyViewGenerator, IllinoisLemmatizer, MentionAnnotator, NERAnnotator, PathLSTMHandler, PorterStemmer, POSAnnotator, POSFromParse, POSFromParse, PrepSRLAnnotator, PseudoParse, Quantifier, ServerClientAnnotator, SimpleGazetteerAnnotator, StanfordCorefHandler, StanfordDepHandler, StanfordOpenIEHandler, StanfordParseHandler, StanfordRelationsHandler, StanfordTrueCaseHandler, TemporalChunkerAnnotator, VerbSenseAnnotator, WordNetLemmaViewGenerator, WordNetPlusLemmaViewGenerator

public abstract class Annotator
extends Object

An interface for creating views of a specified name from a TextAnnotation. Supports lazy initialization. IMPORTANT FOR DERIVED CLASSES: if you initialize fields at declaration rather than in the constructor, those assignments take place AFTER the super.constructor has run -- so e.g. you cannot use a Logger you declare in this way to log messages in the initialize() method that is called by the Annotator class constructor.

Author:

Vivek Srikumar, Mark Sammons, Christos Christodoulopoulos

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceManager	config stores configuration for lazy initialization.
protected boolean	isInitialized
protected String[]	requiredViews
protected String	viewName

Constructor Summary

Constructors

Constructor and Description
Annotator(String viewName, String[] requiredViews) set the name of the View this Annotator creates, and the list of prerequisite Views that this Annotator requires as input
Annotator(String viewName, String[] requiredViews, boolean isLazilyInitialized) explicitly declare whether lazy initialization should be used
Annotator(String viewName, String[] requiredViews, boolean isLazilyInitialized, ResourceManager config) some annotators have complex initialization, so will have to pass a ResourceManager to be on hand for their initialization if non-lazy initialization is desired.
Annotator(String viewName, String[] requiredViews, ResourceManager rm) If lazy initialization is desired, set the property AnnotatorConfigurator.IS_LAZILY_INITIALIZED in the ResourceManager argument

Method Summary

Modifier and Type	Method and Description
protected abstract void	addView(TextAnnotation ta) create and add the view named by getViewName() to the TextAnnotation argument.
void	doInitialize() If you want lazy initialization, this method must load the component models/resources, Default implementation just sets the relevant field to 'true'.
String[]	getRequiredViews() Can be used internally by BasicAnnotatorService to check for pre-requisites before calling any single (external) Annotator.
Set<String>	getTagValues() Return possible tag values that the annotator can produce.
View	getView(TextAnnotation ta) Add the view named by getViewName() to the TextAnnotation argument, and return the View
String	getViewName() return the name of the View created by this Annotator
abstract void	initialize(ResourceManager rm) Derived classes use this to load memory- or time-consuming resources.
boolean	isInitialized() Indicates whether or not all models/resources have been loaded.
boolean	isSentenceLevel()

Methods inherited from class java.lang.Object

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

Field Detail

viewName

protected String viewName

requiredViews

protected String[] requiredViews

isInitialized

protected boolean isInitialized

config

protected ResourceManager config

stores configuration for lazy initialization.

Constructor Detail

Annotator

public Annotator(String viewName,
                 String[] requiredViews)

set the name of the View this Annotator creates, and the list of prerequisite Views that this Annotator requires as input

Parameters:

viewName - The name of the View this annotator will populate. This will be used to access the created view from the TextAnnotation holding it.

requiredViews - The views that must be populated for this new view to be created.

Annotator

public Annotator(String viewName,
                 String[] requiredViews,
                 boolean isLazilyInitialized)

explicitly declare whether lazy initialization should be used

Parameters:

viewName - The name of the View this annotator will populate. This will be used to access the created view from the TextAnnotation holding it.

requiredViews - The views that must be populated for this new view to be created.

isLazilyInitialized - if 'true', defers the initialization of the derived class until getView() is called.

Annotator

public Annotator(String viewName,
                 String[] requiredViews,
                 ResourceManager rm)

If lazy initialization is desired, set the property AnnotatorConfigurator.IS_LAZILY_INITIALIZED in the ResourceManager argument

Parameters:

viewName - The name of the View this annotator will populate. This will be used to access the created view from the TextAnnotation holding it.

requiredViews - The views that must be populated for this new view to be created.

rm - configuration parameters. lazy initialization is set to 'false' by default.

Annotator

public Annotator(String viewName,
                 String[] requiredViews,
                 boolean isLazilyInitialized,
                 ResourceManager config)

some annotators have complex initialization, so will have to pass a ResourceManager to be on hand for their initialization if non-lazy initialization is desired.

Parameters:

viewName - The name of the View this annotator will populate. This will be used to access the created view from the TextAnnotation holding it.

requiredViews - The views that must be populated for this new view to be created.

isLazilyInitialized - if 'true', defers the initialization of the derived class until getView() is called.

config - these properties are stored for use by derived class, esp. in initialize()

Method Detail

initialize

public abstract void initialize(ResourceManager rm)

Derived classes use this to load memory- or time-consuming resources. Don't try to log from this method unless your Logger is static. Generated code puts non-static Logger initialization in the constructor, so if lazyInitialize is 'false' you'll get a null pointer exception trying to write to Logger in initialize().

Parameters:

rm - configuration parameters

doInitialize

public final void doInitialize()

If you want lazy initialization, this method must load the component models/resources, Default implementation just sets the relevant field to 'true'.

isInitialized

public boolean isInitialized()

Indicates whether or not all models/resources have been loaded. Purpose is to support lazy initialization.

Returns:

'true' if model is initialized, 'false' otherwise.

addView

protected abstract void addView(TextAnnotation ta)
                         throws AnnotatorException

create and add the view named by getViewName() to the TextAnnotation argument.

Parameters:

ta - the TextAnnotation to modify.

Throws:

AnnotatorException

getViewName

public String getViewName()

return the name of the View created by this Annotator

Returns:

the name generated by this view.

getView

public final View getView(TextAnnotation ta)
                   throws AnnotatorException

Add the view named by getViewName() to the TextAnnotation argument, and return the View

Parameters:

ta -

Returns:

the newly created View.

Throws:

AnnotatorException

getRequiredViews

public String[] getRequiredViews()

Can be used internally by BasicAnnotatorService to check for pre-requisites before calling any single (external) Annotator.

Returns:

The list of ViewNames required by this ViewGenerator

getTagValues

public Set<String> getTagValues()

Return possible tag values that the annotator can produce.

Returns:

the set of string representing the tag values

isSentenceLevel

public boolean isSentenceLevel()