edu.illinois.cs.cogcomp.pipeline.main

Class SentencePipeline

java.lang.Object

edu.illinois.cs.cogcomp.annotation.BasicAnnotatorService

edu.illinois.cs.cogcomp.pipeline.main.SentencePipeline

All Implemented Interfaces:

AnnotatorService

public class SentencePipeline
extends BasicAnnotatorService

Where possible, run Annotator members over one sentence at a time and splice their outputs together. Ignore failure of Annotators on individual sentences. Current implementation repeats the split/join process for each layer of annotation; a more efficient route would process each sentence with all annotations, but requires some care as not all annotators will support this mode (e.g. co-reference; and Wikification and NER benefit from more context. For components like NER, expect a performance drop if you use this mode due to the reduced context for decisions.

Author:

mssammon

Field Summary

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

annotationCache, disableCache, forceUpdate, textAnnotationBuilder, throwExceptionIfNotCached, viewProviders

Constructor Summary

Constructors

Constructor and Description
SentencePipeline(TextAnnotationBuilder textAnnotationBuilder, Map<String,Annotator> viewProviders, ResourceManager rm) constructor with ResourceManager properties for caching behavior

Method Summary

Modifier and Type	Method and Description
boolean	addView(TextAnnotation textAnnotation, String viewName) DOES NOT CACHE THE ADDED VIEW!!!
void	processBySentence(Annotator annotator, TextAnnotation textAnnotation) Process each sentence individually.

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

addAnnotator, addViewsAndCache, annotateTextAnnotation, createAnnotatedTextAnnotation, createAnnotatedTextAnnotation, createAnnotatedTextAnnotation, createAnnotatedTextAnnotation, createBasicTextAnnotation, createBasicTextAnnotation, getAvailableViews, throwNotCachedException

Methods inherited from class java.lang.Object

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

Constructor Detail

SentencePipeline

public SentencePipeline(TextAnnotationBuilder textAnnotationBuilder,
                        Map<String,Annotator> viewProviders,
                        ResourceManager rm)
                 throws AnnotatorException

constructor with ResourceManager properties for caching behavior

Parameters:

textAnnotationBuilder - tokenizes and sentence splits input text.

viewProviders - Annotators that populate a View with the same name as the corresponding Annotator key.

rm - A ResourceManager containing cache configuration options.

Throws:

AnnotatorException

Method Detail

addView

public boolean addView(TextAnnotation textAnnotation,
                       String viewName)
                throws AnnotatorException

DOES NOT CACHE THE ADDED VIEW!!!

Specified by:

addView in interface AnnotatorService

Overrides:

addView in class BasicAnnotatorService

Parameters:

textAnnotation - textAnnotation to be modified

viewName - name of view to be added

Returns:

'true' if textAnnotation was modified

Throws:

AnnotatorException

processBySentence

public void processBySentence(Annotator annotator,
                              TextAnnotation textAnnotation)

Process each sentence individually. This potentially allows for failure at an individual sentence level, without failing for the whole text. THIS REQUIRES THAT ALL RELATIONS ARE INTRA-SENTENCE. Any that are *not* will be omitted for the sentence-level processing.

Parameters:

annotator - Annotator to apply

textAnnotation - TextAnnotation to augment