org.apache.uima.conceptMapper.support.dictionaryResource
Interface DictionaryResource

All Known Implementing Classes:
CompiledDictionaryResource_impl, DictionaryResource_impl

public interface DictionaryResource


Nested Class Summary
static interface DictionaryResource.DictEntries
           
static interface DictionaryResource.DictEntriesByLength
           
static interface DictionaryResource.DictEntry
           
 
Method Summary
 DictionaryResource.DictEntriesByLength getEntries(String key)
          return data structure containing a list of dictionary entries, sorted by number of tokens
 EntryPropertiesRoot getEntryPropertiesRoot()
           
 boolean isLoaded()
           
 Enumeration<String> keys()
           
 void load(org.apache.uima.resource.DataResource data)
           
 void loadDictionaryContents(org.apache.uima.analysis_engine.annotator.AnnotatorContext context, Logger logger, String tokenAnnotationName, String tokenTypeFeatureName, String tokenClassFeatureName, String tokenizerDescriptor)
           
 DictionaryResource newDictionaryResource(int initialSize)
           
 void putEntry(String key, String[] tokens, String unsortedEntry, int length, EntryProperties props)
           
 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(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(String key,
              String[] tokens,
              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

Enumeration<String> keys()

toString

String toString()
Overrides:
toString in class Object

loadDictionaryContents

void loadDictionaryContents(org.apache.uima.analysis_engine.annotator.AnnotatorContext context,
                            Logger logger,
                            String tokenAnnotationName,
                            String tokenTypeFeatureName,
                            String tokenClassFeatureName,
                            String tokenizerDescriptor)
                            throws org.apache.uima.resource.ResourceInitializationException
Parameters:
context -
logger -
tokenAnnotationName -
tokenTypeFeatureName -
tokenClassFeatureName -
tokenizerDescriptor -
Throws:
org.apache.uima.resource.ResourceInitializationException

isLoaded

boolean isLoaded()


Copyright © 2006-2011 The Apache Software Foundation. All Rights Reserved.