edu.illinois.cs.cogcomp.annotation

Interface AnnotatorService

All Known Implementing Classes:

BasicAnnotatorService, CuratorAnnotatorService, SentencePipeline

public interface AnnotatorService

Specifies the operations to be supported by an AnnotatorService, which creates a TextAnnotation from raw text and populates it with views generated by NLP components.

Author:

Mark Sammons, Narender Gupta

Method Summary

Modifier and Type	Method and Description
void	addAnnotator(Annotator annotator) Add a new Annotator to the service.
boolean	addView(TextAnnotation ta, String viewName) The standard way of adding a specific View to a TextAnnotation.
TextAnnotation	annotateTextAnnotation(TextAnnotation ta, boolean replaceExistingViews) Add the specified views to the TextAnnotation argument.
TextAnnotation	createAnnotatedTextAnnotation(String corpusId, String textId, String text) A convenience method for creating a TextAnnotation and adding all the Views supported by this AnnotatorService.
TextAnnotation	createAnnotatedTextAnnotation(String corpusId, String textId, String text, Set<String> viewNames) An overloaded version of createAnnotatedTextAnnotation(String, String, String) that adds only the Views requested.
TextAnnotation	createAnnotatedTextAnnotation(String corpusId, String textId, String text, Tokenizer.Tokenization tokenization) A convenience method for creating a TextAnnotation and adding all the Views supported by this AnnotatorService.
TextAnnotation	createAnnotatedTextAnnotation(String corpusId, String textId, String text, Tokenizer.Tokenization tokenization, Set<String> viewNames) An overloaded version of createAnnotatedTextAnnotation(String, String, String, Tokenizer.Tokenization) that adds only the Views requested.
TextAnnotation	createBasicTextAnnotation(String corpusId, String docId, String text) A convenience method for creating a TextAnnotation.
TextAnnotation	createBasicTextAnnotation(String corpusId, String docId, String text, Tokenizer.Tokenization tokenization) A convenience method for creating a TextAnnotation while respecting the pre-tokenization of text passed in the form of Tokenizer.Tokenization.
Set<String>	getAvailableViews() Return a set containing the names of all Views that this service can provide.

Method Detail

createBasicTextAnnotation

TextAnnotation createBasicTextAnnotation(String corpusId,
                                         String docId,
                                         String text)
                                  throws AnnotatorException

A convenience method for creating a TextAnnotation. Typically, this will be accomplished using a TextAnnotationBuilder.

Parameters:

text - The raw text used to build the TextAnnotation where all the Views should be added.

Throws:

AnnotatorException - If this service cannot provide this viewName

createBasicTextAnnotation

TextAnnotation createBasicTextAnnotation(String corpusId,
                                         String docId,
                                         String text,
                                         Tokenizer.Tokenization tokenization)
                                  throws AnnotatorException

A convenience method for creating a TextAnnotation while respecting the pre-tokenization of text passed in the form of Tokenizer.Tokenization.

Parameters:

text - The raw text

tokenization - An instance of Tokenizer.Tokenization which contains tokens, character offsets, and sentence boundaries to be used while constructing the TextAnnotation.

Throws:

AnnotatorException - If the service cannot create requested object

createAnnotatedTextAnnotation

TextAnnotation createAnnotatedTextAnnotation(String corpusId,
                                             String textId,
                                             String text)
                                      throws AnnotatorException

A convenience method for creating a TextAnnotation and adding all the Views supported by this AnnotatorService. This amounts to calling createBasicTextAnnotation(String, String, String) and successive calls of addView(TextAnnotation, String)

Parameters:

text - The raw text used to build the TextAnnotation where all the Views should be added.

Throws:

AnnotatorException - If none of the viewProviders supports this viewName

createAnnotatedTextAnnotation

TextAnnotation createAnnotatedTextAnnotation(String corpusId,
                                             String textId,
                                             String text,
                                             Tokenizer.Tokenization tokenization)
                                      throws AnnotatorException

A convenience method for creating a TextAnnotation and adding all the Views supported by this AnnotatorService. This amounts to calling createBasicTextAnnotation(String, String, String, Tokenizer.Tokenization) and successive calls of addView(TextAnnotation, String)

Parameters:

text - The raw text

tokenization - An instance of Tokenizer.Tokenization which contains tokens, character offsets, and sentence boundaries to be used while constructing the TextAnnotation.

Throws:

AnnotatorException - If none of the viewProviders supports this viewName

createAnnotatedTextAnnotation

TextAnnotation createAnnotatedTextAnnotation(String corpusId,
                                             String textId,
                                             String text,
                                             Set<String> viewNames)
                                      throws AnnotatorException

An overloaded version of createAnnotatedTextAnnotation(String, String, String) that adds only the Views requested.

Parameters:

text - The raw text used to build the TextAnnotation where all the Views should be added.

viewNames - Views to add

Throws:

AnnotatorException - If none of the viewProviders supports this viewName

createAnnotatedTextAnnotation

TextAnnotation createAnnotatedTextAnnotation(String corpusId,
                                             String textId,
                                             String text,
                                             Tokenizer.Tokenization tokenization,
                                             Set<String> viewNames)
                                      throws AnnotatorException

An overloaded version of createAnnotatedTextAnnotation(String, String, String, Tokenizer.Tokenization) that adds only the Views requested.

Parameters:

text - The raw text

tokenization - An instance of Tokenizer.Tokenization which contains tokens, character offsets, and sentence boundaries to be used while constructing the TextAnnotation.

viewNames - Views to add

Returns:

Throws:

AnnotatorException - If none of the viewProviders supports this viewName

addView

boolean addView(TextAnnotation ta,
                String viewName)
         throws AnnotatorException

The standard way of adding a specific View to a TextAnnotation.

Parameters:

ta - The TextAnnotation where the View should be added.

viewName - The name of the View to be added. By convention this has to be a constant in ViewNames.

Returns:

'true' if the TextAnnotation was modified by this call.

Throws:

AnnotatorException - If this AnnotatorService cannot provide this viewName,

addAnnotator

void addAnnotator(Annotator annotator)
           throws AnnotatorException

Add a new Annotator to the service. All prerequisite views must already be provided by other annotators known to this AnnotatorService.

Parameters:

annotator - the Annotator to be added.

Throws:

{@link - AnnotatorException} if the annotator requires views that cannot be satisfied.

AnnotatorException

getAvailableViews

Set<String> getAvailableViews()

Return a set containing the names of all Views that this service can provide.

Returns:

a set of view names corresponding to annotators known to this AnnotatorService

annotateTextAnnotation

TextAnnotation annotateTextAnnotation(TextAnnotation ta,
                                      boolean replaceExistingViews)
                               throws AnnotatorException

Add the specified views to the TextAnnotation argument. This is useful when TextAnnotation objects are built independently of the service, perhaps by a different system component (e.g. a corpus reader). If so specified, overwrite existing views.

Parameters:

ta - The TextAnnotation to annotate

replaceExistingViews - if 'true', annotate a View even if it is already present in the ta argument, replacing the original corresponding View.

Returns:

a reference to the updated TextAnnotation

Throws:

AnnotatorException