org.apache.ctakes.dictionary.lookup.ae

Interface LookupInitializer

All Known Implementing Classes:

DirectLookupInitializerImpl, FirstTokenPermLookupInitializerImpl, FirstTokenPermLookupInitializerImpl

public interface LookupInitializer

Defines how to initialize the LookupAnnotator. NOTE: Constructor for implementation will be passed 2 arguments 1.) AnnotatorContext for accessing external resources 2.) Properties object for customization purposes.

Author:

Mayo Clinic

Method Summary

Modifier and Type	Method and Description
Map<String,List<LookupAnnotation>>	getContextMap(org.apache.uima.jcas.JCas jcas, int windowBegin, int windowEnd) Gets context for the specified window.
LookupAlgorithm	getLookupAlgorithm(DictionaryEngine dictEngine) Gets the LookupAlgorithm to be used to perform the lookup operations.
Iterator<LookupToken>	getLookupTokenIterator(org.apache.uima.jcas.JCas jcas) Gets an iteration of tokens that represent the finest grain used for a lookup operation.
Iterator<org.apache.uima.jcas.tcas.Annotation>	getLookupWindowIterator(org.apache.uima.jcas.JCas jcas) Gets an iteration of windows.
List<LookupToken>	getSortedLookupTokens(org.apache.uima.jcas.JCas jcas, org.apache.uima.jcas.tcas.Annotation annotation) Gets a list of tokens that we promise to return in sorted order that are constrained by the input annotation.

Method Detail

getLookupTokenIterator

Iterator<LookupToken> getLookupTokenIterator(org.apache.uima.jcas.JCas jcas)
                                      throws org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

Gets an iteration of tokens that represent the finest grain used for a lookup operation. These tokens may be as simple as a single word or perhaps an entire phrase.

Parameters:

jcas - Use the JCas to pull out pre-existing feature structures to build the LookupToken objects. Add attributes to the LookupToken objects as you see fit.

Returns:

Iterator over LookupToken objects.

Throws:

org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

getLookupWindowIterator

Iterator<org.apache.uima.jcas.tcas.Annotation> getLookupWindowIterator(org.apache.uima.jcas.JCas jcas)
                                                                throws org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

Gets an iteration of windows. A window is used to scope which LookupToken objects are passed to the LookupAlgorithm.

Parameters:

jcas - Use the JCas to pull out pre-existing feature structures to build LookupAnnotation objects.

Returns:

Iterator over org.apache.uima.jcas.tcas.Annotation objects, each representing a window.

Throws:

org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

getSortedLookupTokens

List<LookupToken> getSortedLookupTokens(org.apache.uima.jcas.JCas jcas,
                                        org.apache.uima.jcas.tcas.Annotation annotation)
                                 throws org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

Gets a list of tokens that we promise to return in sorted order that are constrained by the input annotation. Puts the onus for sorting performance on the implementing methods since a sort is implicitly required at some point.

Parameters:

jcas -

annotation -

Returns:

List over tokens that are in the window specified.

Throws:

org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

getLookupAlgorithm

LookupAlgorithm getLookupAlgorithm(DictionaryEngine dictEngine)
                            throws org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

Gets the LookupAlgorithm to be used to perform the lookup operations. Properties specified from the descriptor will be passed in to customize the behavior of the algorithm.

Parameters:

dictEngine - DictionaryEngine that will execute lookup operations.

Returns:

LookupAlgorithm that will be used for lookup operations.

Throws:

org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

getContextMap

Map<String,List<LookupAnnotation>> getContextMap(org.apache.uima.jcas.JCas jcas,
                                                 int windowBegin,
                                                 int windowEnd)
                                          throws org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

Gets context for the specified window.

Parameters:

jcas -

windowBegin -

windowEnd -

Returns:

Throws:

org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException