org.apache.uima.conceptMapper.support.dictionaryResource

Interface DictionaryResource

All Known Implementing Classes:

CompiledDictionaryResource_impl, DictionaryResource_impl

public interface DictionaryResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DictionaryResource.DictEntries
static interface	DictionaryResource.DictEntriesByLength
static interface	DictionaryResource.DictEntry

Method Summary

Methods

Modifier and Type	Method and Description
DictionaryResource.DictEntriesByLength	getEntries(java.lang.String key) return data structure containing a list of dictionary entries, sorted by number of tokens
EntryPropertiesRoot	getEntryPropertiesRoot()
boolean	isLoaded()
java.util.Enumeration<java.lang.String>	keys()
void	load(org.apache.uima.resource.DataResource data)
void	loadDictionaryContents(org.apache.uima.analysis_engine.annotator.AnnotatorContext context, Logger logger, java.lang.String tokenAnnotationName, java.lang.String tokenTypeFeatureName, java.lang.String tokenClassFeatureName, java.lang.String tokenizerDescriptor)
DictionaryResource	newDictionaryResource(int initialSize)
void	putEntry(java.lang.String key, java.lang.String[] tokens, java.lang.String unsortedEntry, int length, EntryProperties props)
java.lang.String	toString()

Method Detail

load

void load(org.apache.uima.resource.DataResource data)
          throws org.apache.uima.resource.ResourceInitializationException

Throws:

org.apache.uima.resource.ResourceInitializationException

newDictionaryResource

DictionaryResource newDictionaryResource(int initialSize)

getEntryPropertiesRoot

EntryPropertiesRoot getEntryPropertiesRoot()

getEntries

DictionaryResource.DictEntriesByLength getEntries(java.lang.String key)

return data structure containing a list of dictionary entries, sorted by number of tokens

Parameters:

key -

Returns:

data structure containing a list of dictionary entries, sorted by number of tokens

putEntry

void putEntry(java.lang.String key,
            java.lang.String[] tokens,
            java.lang.String unsortedEntry,
            int length,
            EntryProperties props)

Parameters:

key - the key to index on

tokens - array of tokens to be entered in the dictionary

unsortedEntry - String representation of tokens to be entered in the dictionary in sorted order, if "entry" is sorted, otherwise null

length - Number of tokens in entry

props - the properties object for the dictionary entry

keys

java.util.Enumeration<java.lang.String> keys()

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

loadDictionaryContents

void loadDictionaryContents(org.apache.uima.analysis_engine.annotator.AnnotatorContext context,
                          Logger logger,
                          java.lang.String tokenAnnotationName,
                          java.lang.String tokenTypeFeatureName,
                          java.lang.String tokenClassFeatureName,
                          java.lang.String tokenizerDescriptor)
                            throws org.apache.uima.resource.ResourceInitializationException

Parameters:

context -

logger -

tokenAnnotationName -

tokenTypeFeatureName -

tokenClassFeatureName -

tokenizerDescriptor -

Throws:

org.apache.uima.resource.ResourceInitializationException

isLoaded

boolean isLoaded()