edu.illinois.cs.cogcomp.curator

Class CuratorAnnotatorService

java.lang.Object

edu.illinois.cs.cogcomp.curator.CuratorAnnotatorService

All Implemented Interfaces:

AnnotatorService

public class CuratorAnnotatorService
extends Object
implements AnnotatorService

The AnnotatorService object with most of the annotators available in CCG Curator.

Do not call this class directly; instead, use CuratorFactory

TODO Until a caching mechanism is available in illinois-core-utilities, this AnnotatorService will not support caching

Author:

Christos Christodouloupoulos, Narender Gupta

Field Summary

Fields

Modifier and Type	Field and Description
protected TextAnnotationCache	annotationCache

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CuratorAnnotatorService() Overloaded constructor with default configuration.
protected	CuratorAnnotatorService(ResourceManager rm) Builds an AnnotatorService object that contains all Curator components under ViewNames.

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 AnnotatorService.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 AnnotatorService.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.

Methods inherited from class java.lang.Object

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

Field Detail

annotationCache

protected TextAnnotationCache annotationCache

Constructor Detail

CuratorAnnotatorService

protected CuratorAnnotatorService()
                           throws Exception

Overloaded constructor with default configuration.

Throws:

Exception

See Also:

CuratorAnnotatorService(ResourceManager)

CuratorAnnotatorService

protected CuratorAnnotatorService(ResourceManager rm)

Builds an AnnotatorService object that contains all Curator components under ViewNames. (to access the rest of the Curator annotators, you will need to requrest it manually, by altering CuratorClient.addRecordViewFromCurator(java.lang.String, java.util.List<java.lang.String>, java.lang.String)).

Each Curator internal component is wrapped in a CuratorAnnotator that automates the retrieval of requiredViews and viewName. The current set of components is built using the dependencies and view names found in /shared/trollope/curator/dist/configs/annotators-trollope.xml, Mar 12 09:12.

Parameters:

rm - ResourceManager with properties for the CuratorClient and caching behavior

Method Detail

createBasicTextAnnotation

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

Description copied from interface: AnnotatorService

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

Specified by:

createBasicTextAnnotation in interface AnnotatorService

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

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

Description copied from interface: AnnotatorService

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

Specified by:

createBasicTextAnnotation in interface AnnotatorService

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

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

Description copied from interface: AnnotatorService

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

Specified by:

createAnnotatedTextAnnotation in interface AnnotatorService

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

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

Description copied from interface: AnnotatorService

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

Specified by:

createAnnotatedTextAnnotation in interface AnnotatorService

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

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

Description copied from interface: AnnotatorService

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

Specified by:

createAnnotatedTextAnnotation in interface AnnotatorService

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

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

Description copied from interface: AnnotatorService

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

Specified by:

createAnnotatedTextAnnotation in interface AnnotatorService

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

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

Description copied from interface: AnnotatorService

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

Specified by:

addView in interface AnnotatorService

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

public 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.

Specified by:

addAnnotator in interface AnnotatorService

Parameters:

annotator - the Annotator to be added.

Throws:

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

AnnotatorException

getAvailableViews

public Set<String> getAvailableViews()

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

Specified by:

getAvailableViews in interface AnnotatorService

Returns:

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

annotateTextAnnotation

public 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.

Specified by:

annotateTextAnnotation in interface AnnotatorService

Parameters:

ta - The TextAnnotation to annotate

replaceExistingViews - ignored by this AnnotatorService

Returns:

a reference to the updated TextAnnotation

Throws:

AnnotatorException