org.apache.ctakes.dictionary.lookup2.util

Interface DictionarySpec

All Known Implementing Classes:

DefaultDictionarySpec

public interface DictionarySpec

Simple Container class that holds a RareWordDictionary collection, a a ConceptFactory and a TermConsumer

Since:

9/19/2014

Version:

%I%

Author:

SPF , chip-nlp

Method Summary

Modifier and Type	Method and Description
Collection<ConceptFactory>	getConceptFactories()
ConceptFactory	getConceptFactory(String pairName)
TermConsumer	getConsumer()
Collection<RareWordDictionary>	getDictionaries()
RareWordDictionary	getDictionary(String pairName)
Collection<ConceptFactory>	getPairedConceptFactories(String dictionaryName)
Collection<RareWordDictionary>	getPairedDictionaries(String conceptFactoryName)
Collection<String>	getPairNames()

Method Detail

getPairNames

Collection<String> getPairNames()

Returns:

the available pair names

getDictionary

RareWordDictionary getDictionary(String pairName)

Returns:

the dictionary associated with the given pair name

getConceptFactory

ConceptFactory getConceptFactory(String pairName)

Returns:

the concept factory for concept creation associated with the given pair name

getPairedDictionaries

Collection<RareWordDictionary> getPairedDictionaries(String conceptFactoryName)

Parameters:

conceptFactoryName - name of a used concept factory

Returns:

all dictionaries associated with the concept factory

getPairedConceptFactories

Collection<ConceptFactory> getPairedConceptFactories(String dictionaryName)

Parameters:

dictionaryName - name of a used dictionary

Returns:

all concept factories associated with the dictionary

getDictionaries

Collection<RareWordDictionary> getDictionaries()

Returns:

all known dictionaries

getConceptFactories

Collection<ConceptFactory> getConceptFactories()

Returns:

all known concept factories

getConsumer

TermConsumer getConsumer()

Returns:

the consumer to add terms to the Cas