org.apache.ctakes.dictionary.lookup

Class DictionaryEngine

java.lang.Object

org.apache.ctakes.dictionary.lookup.DictionaryEngine

public class DictionaryEngine
extends Object

The engine adds additional functionality to executing a dictionary.

1. Pre-lookup filtering. Filters the input text.
2. Post-lookup filtering. Filters individual dictionary hits based on metadata.
3. Collection filtering. Filters the collection of dictionary hits based on metadata and/or collection information.
4. Caching. Caches dictionary hits.
5. Case Sensitivity. Keeps case or makes case irrelevant to lookup.

Constructor Summary

Constructors

Constructor and Description
DictionaryEngine(Dictionary dictionary, boolean keepCase)

Method Summary

Modifier and Type	Method and Description
void	addCacheEntry(String text) Adds an entry to the dictionary lookup cache.
void	addCollectionFilter(CollectionFilter collectionFilter) Adds a Collection filter to the engine.
void	addPostLookupFilter(PostLookupFilter postLookupFilter) Adds a Post-lookup filter to the engine.
void	addPreLookupFilter(PreLookupFilter preLookupFilter) Adds a Pre-lookup filter to the engine.
boolean	binaryLookup(String text) Determines whether the input text is contained by the Dictionary.
Collection<MetaDataHit>	metaLookup(String text) Gets a collection of MetaDataHits from the Dictionary based on the input text.

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionaryEngine

public DictionaryEngine(Dictionary dictionary,
                        boolean keepCase)

Parameters:

dictionary - Dictionary to use for lookup operations.

keepCase - Determines whether to keep character Upper or Lower casing. False indicates that casing will be ignored by lower casing all lookups.

Method Detail

addPreLookupFilter

public void addPreLookupFilter(PreLookupFilter preLookupFilter)

Adds a Pre-lookup filter to the engine. Filters will be applied in the order of addition.

Parameters:

preLookupFilter - PreLookupFilter to add.

addPostLookupFilter

public void addPostLookupFilter(PostLookupFilter postLookupFilter)

Adds a Post-lookup filter to the engine. Filters will be applied in the order of addition.

Parameters:

postLookupFilter - PostLookupFilter to add.

addCollectionFilter

public void addCollectionFilter(CollectionFilter collectionFilter)

Adds a Collection filter to the engine. Filters will be applied in the order of addition. Filter will be applied after PostLookupFiltering.

Parameters:

collectionFilter - CollectionFilter to add.

addCacheEntry

public void addCacheEntry(String text)
                   throws DictionaryException,
                          FilterException

Adds an entry to the dictionary lookup cache. The given text will be cached immediately when this method is invoked. This cache does not expire.

Parameters:

text - to add to the caches as a hit or miss

Throws:

DictionaryException

FilterException

metaLookup

public Collection<MetaDataHit> metaLookup(String text)
                                   throws DictionaryException,
                                          FilterException

Gets a collection of MetaDataHits from the Dictionary based on the input text. Both Pre-lookup and Post-lookup filtering are applied.

Parameters:

text - text to check for in the filters

Returns:

Collection of MetaDataHit objects

Throws:

DictionaryException

FilterException

binaryLookup

public boolean binaryLookup(String text)
                     throws DictionaryException,
                            FilterException

Determines whether the input text is contained by the Dictionary. Only pre-lookup filtering is applied.

Parameters:

text - The input text.

Returns:

true if contained by Dictionary, false otherwise

Throws:

DictionaryException

FilterException