org.apache.ctakes.ytex.uima.lookup.ae

Class FirstTokenPermLookupInitializerImpl

java.lang.Object

org.apache.ctakes.ytex.uima.lookup.ae.FirstTokenPermLookupInitializerImpl

All Implemented Interfaces:

LookupInitializer

public class FirstTokenPermLookupInitializerImpl
extends Object
implements LookupInitializer

Author:

Mayo Clinic

Field Summary

Fields

Modifier and Type	Field and Description
protected Constructor	lookupTokenAdapterCtor

Constructor Summary

Constructors

Constructor and Description
FirstTokenPermLookupInitializerImpl(org.apache.uima.UimaContext uimaContext, Properties props)

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 covering) Gets a list of tokens that we promise to return in sorted order that are constrained by the input annotation.

Methods inherited from class java.lang.Object

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

Field Detail

lookupTokenAdapterCtor

protected Constructor lookupTokenAdapterCtor

Constructor Detail

FirstTokenPermLookupInitializerImpl

public FirstTokenPermLookupInitializerImpl(org.apache.uima.UimaContext uimaContext,
                                           Properties props)
                                    throws ClassNotFoundException,
                                           IllegalAccessException,
                                           NoSuchFieldException

Throws:

ClassNotFoundException

IllegalAccessException

NoSuchFieldException

Method Detail

getLookupAlgorithm

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

Specified by:

getLookupAlgorithm in interface LookupInitializer

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

getLookupTokenIterator

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

Specified by:

getLookupTokenIterator in interface LookupInitializer

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

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

Specified by:

getLookupWindowIterator in interface LookupInitializer

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

getContextMap

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

Specified by:

getContextMap in interface LookupInitializer

Returns:

Throws:

org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException

getSortedLookupTokens

public List<LookupToken> getSortedLookupTokens(org.apache.uima.jcas.JCas jcas,
                                               org.apache.uima.jcas.tcas.Annotation covering)
                                        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.

Specified by:

getSortedLookupTokens in interface LookupInitializer

Returns:

List over tokens that are in the window specified.

Throws:

org.apache.uima.analysis_engine.annotator.AnnotatorInitializationException