edu.illinois.cs.cogcomp.chunker.main

Class ChunkerAnnotator

java.lang.Object

edu.illinois.cs.cogcomp.annotation.Annotator

edu.illinois.cs.cogcomp.chunker.main.ChunkerAnnotator

public class ChunkerAnnotator
extends Annotator

Wraps the Illinois Chunker (Shallow Parser) in an illinois-core-utilities Annotator

Author:

James Clarke, Mark Sammons, Nitish Gupta

Field Summary

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

config, isInitialized, requiredViews, viewName

Constructor Summary

Constructors

Constructor and Description
ChunkerAnnotator() default: don't use lazy initialization
ChunkerAnnotator(boolean lazilyInitialize) Constructor parameter allows user to specify whether or not to lazily initialize.
ChunkerAnnotator(boolean lazilyInitialize, ResourceManager rm)

Method Summary

Modifier and Type	Method and Description
void	addView(TextAnnotation record) create and add the view named by getViewName() to the TextAnnotation argument.
String[]	getRequiredViews() Can be used internally by AnnotatorService to check for pre-requisites before calling any single (external) Annotator.
Set<String>	getTagValues() Return possible tag values that the ChunkerAnnotator can produce.
String	getViewName() return the name of the View created by this Annotator
void	initialize(ResourceManager rm) Derived classes use this to load memory- or time-consuming resources.

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

doInitialize, getView, isInitialized, isSentenceLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

ChunkerAnnotator

public ChunkerAnnotator()

default: don't use lazy initialization

ChunkerAnnotator

public ChunkerAnnotator(boolean lazilyInitialize)

Constructor parameter allows user to specify whether or not to lazily initialize.

Parameters:

lazilyInitialize - If set to 'true', models will not be loaded until first call requiring Chunker annotation.

ChunkerAnnotator

public ChunkerAnnotator(boolean lazilyInitialize,
                        ResourceManager rm)

Method Detail

initialize

public void initialize(ResourceManager rm)

Description copied from class: Annotator

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().

Specified by:

initialize in class Annotator

Parameters:

rm - configuration parameters

addView

public void addView(TextAnnotation record)
             throws AnnotatorException

Description copied from class: Annotator

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

Specified by:

addView in class Annotator

Parameters:

record - the TextAnnotation to modify.

Throws:

AnnotatorException

getViewName

public String getViewName()

Description copied from class: Annotator

return the name of the View created by this Annotator

Overrides:

getViewName in class Annotator

Returns:

the name generated by this view.

getRequiredViews

public String[] getRequiredViews()

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

Overrides:

getRequiredViews in class Annotator

Returns:

The list of ViewNames required by this ViewGenerator

getTagValues

public Set<String> getTagValues()

Return possible tag values that the ChunkerAnnotator can produce.

Overrides:

getTagValues in class Annotator

Returns:

the set of string representing the tag values