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 java.lang.Object
implements LookupInitializer

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CANONICAL_VARIANT_ATTR
private static java.lang.String	EXC_TAGS_PRP_KEY
private static java.lang.String	FALSE_STRING
private int[]	iv_annotTypeArr
private java.util.Set<java.lang.String>	iv_exclusionTagSet
private Logger	iv_logger
private java.util.Properties	iv_props
private java.lang.String	LOOKUP_TOKEN_ADAPTER
protected java.lang.reflect.Constructor	lookupTokenAdapterCtor
private static java.lang.String	MAX_P_LEVEL_PRP_KEY
private static java.lang.String	TEXT_MFS_PRP_KEY
private static java.lang.String	TRUE_STRING
private static java.lang.String	WINDOW_ANNOT_PRP_KEY

Constructor Summary

Constructors

Constructor and Description
FirstTokenPermLookupInitializerImpl(UimaContext uimaContext, java.util.Properties props)

Method Summary

Methods

Modifier and Type	Method and Description
private LookupToken	annoToLookupToken(Annotation bta) vng use the constructor identified during initialization to create the lookup token
private java.util.List<LookupAnnotation>	constrainToWindow(int begin, int end, java.util.Iterator<Annotation> annotItr) Gets a list of LookupAnnotation objects within the specified window.
java.util.Map<java.lang.String,java.util.List<LookupAnnotation>>	getContextMap(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.
java.util.Iterator<LookupToken>	getLookupTokenIterator(JCas jcas) Gets an iteration of tokens that represent the finest grain used for a lookup operation.
java.util.Iterator<Annotation>	getLookupWindowIterator(JCas jcas) Gets an iteration of windows.
java.util.List<LookupToken>	getSortedLookupTokens(JCas jcas, Annotation covering) Gets a list of tokens that we promise to return in sorted order that are constrained by the input annotation.
private boolean	isTagExcluded(java.lang.String tag)

Methods inherited from class java.lang.Object

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

Field Detail

TRUE_STRING

private static final java.lang.String TRUE_STRING

FALSE_STRING

private static final java.lang.String FALSE_STRING

iv_logger

private final Logger iv_logger

TEXT_MFS_PRP_KEY

private static final java.lang.String TEXT_MFS_PRP_KEY

See Also:

Constant Field Values

MAX_P_LEVEL_PRP_KEY

private static final java.lang.String MAX_P_LEVEL_PRP_KEY

See Also:

Constant Field Values

WINDOW_ANNOT_PRP_KEY

private static final java.lang.String WINDOW_ANNOT_PRP_KEY

See Also:

Constant Field Values

EXC_TAGS_PRP_KEY

private static final java.lang.String EXC_TAGS_PRP_KEY

See Also:

Constant Field Values

CANONICAL_VARIANT_ATTR

private static final java.lang.String CANONICAL_VARIANT_ATTR

See Also:

Constant Field Values

iv_props

private final java.util.Properties iv_props

iv_annotTypeArr

private final int[] iv_annotTypeArr

iv_exclusionTagSet

private final java.util.Set<java.lang.String> iv_exclusionTagSet

lookupTokenAdapterCtor

protected java.lang.reflect.Constructor lookupTokenAdapterCtor

LOOKUP_TOKEN_ADAPTER

private final java.lang.String LOOKUP_TOKEN_ADAPTER

See Also:

Constant Field Values

Constructor Detail

FirstTokenPermLookupInitializerImpl

public FirstTokenPermLookupInitializerImpl(UimaContext uimaContext,
                                   java.util.Properties props)
                                    throws java.lang.ClassNotFoundException,
                                           java.lang.IllegalAccessException,
                                           java.lang.NoSuchFieldException

Throws:

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.NoSuchFieldException

Method Detail

annoToLookupToken

private LookupToken annoToLookupToken(Annotation bta)
                               throws AnnotatorInitializationException

vng use the constructor identified during initialization to create the lookup token

Parameters:

bta -

Returns:

Throws:

AnnotatorInitializationException

getLookupAlgorithm

public LookupAlgorithm getLookupAlgorithm(DictionaryEngine dictEngine)
                                   throws 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:

AnnotatorInitializationException

isTagExcluded

private boolean isTagExcluded(java.lang.String tag)

getLookupTokenIterator

public java.util.Iterator<LookupToken> getLookupTokenIterator(JCas jcas)
                                                       throws 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:

AnnotatorInitializationException

getLookupWindowIterator

public java.util.Iterator<Annotation> getLookupWindowIterator(JCas jcas)
                                                       throws 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:

AnnotatorInitializationException

getContextMap

public java.util.Map<java.lang.String,java.util.List<LookupAnnotation>> getContextMap(JCas jcas,
                                                                             int windowBegin,
                                                                             int windowEnd)
                                                                               throws AnnotatorInitializationException

Gets context for the specified window.

Specified by:

getContextMap in interface LookupInitializer

Returns:

Throws:

AnnotatorInitializationException

constrainToWindow

private java.util.List<LookupAnnotation> constrainToWindow(int begin,
                                                 int end,
                                                 java.util.Iterator<Annotation> annotItr)
                                                    throws AnnotatorInitializationException

Gets a list of LookupAnnotation objects within the specified window.

Parameters:

annotItr - -

Returns:

list of lookup annotations

Throws:

AnnotatorInitializationException

getSortedLookupTokens

public java.util.List<LookupToken> getSortedLookupTokens(JCas jcas,
                                                Annotation covering)
                                                  throws 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:

AnnotatorInitializationException