org.apache.ctakes.dictionary.lookup2.dictionary

Class DictionaryDescriptorParser

java.lang.Object

org.apache.ctakes.dictionary.lookup2.dictionary.DictionaryDescriptorParser

public final class DictionaryDescriptorParser
extends java.lang.Object

Parses the XML descriptor indicated by the externalResource for DictionaryDescriptorFile in the XML descriptor for the Rare Word Term Lookup Annotator DefaultJCasTermAnnotator

If there is a problem with the descriptor then the whole pipeline goes down, so care must be taken by the User and any messages (logged or otherwise) produced by this class should be as specific as possible. Devs take notice.

Author: SPF Affiliation: CHIP-NLP Date: 11/20/13

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CONCEPT_FACTORIES_KEY
private static java.lang.String	CONSUMER_KEY XML key specifying the section that defines the single TermConsumer that should be used to consume discovered terms.
private static java.lang.String	DICTIONARIES_KEY XML keys specifying the main sections that define dictionaries, concept factories, and the pairing of the two
private static java.lang.Object[]	EMPTY_OBJECT_ARRAY
private static java.lang.String	IMPLEMENTATION_KEY Each RareWordDictionary, ConceptFactory, and TermConsumer must have a java implementation.
private static Logger	LOGGER
private static int	MAX_LIST_SIZE
private static java.lang.String	NAME_KEY Each dictionary, concept factory, pairing and term consumer should have a unique name
private static java.lang.String	PAIR_CONCEPT_FACTORY_NAME
private static java.lang.String	PAIR_DICTIONARY_NAME pairings must have specified dictionaries and concept factories
private static java.lang.String	PAIRS_KEY
private static java.lang.String	PROPERTIES_KEY everything else is implementation-specific and therefore optional and therefore set as a property

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DictionaryDescriptorParser() A Utility Class cannot be instantiated

Method Summary

Methods

Modifier and Type	Method and Description
private static java.lang.String	getName(java.lang.String elementName, Element element)
private static java.util.Map<java.lang.String,ConceptFactory>	parseConceptFactories(UimaContext uimaContext, Element conceptFactoriesElement) Creates concept factories by parsing the section defined by {@link this.CONCEPT_FACTORY_KEY
private static ConceptFactory	parseConceptFactory(UimaContext uimaContext, Element conceptFactoryElement) Creates a dictionary by parsing each child element of this.DICTIONARIES_KEY
private static TermConsumer	parseConsumerXml(UimaContext uimaContext, Element lookupConsumerElement) Creates a term consumer by parsing section defined by this.CONSUMER_KEY
static DictionarySpec	parseDescriptor(java.io.File descriptorFile, UimaContext uimaContext) Initiates the parsing of the XML descriptor file containing definition of dictionaries and a consumer for the Rare Word Term dictionary paradigm
private static java.util.Map<java.lang.String,RareWordDictionary>	parseDictionaries(UimaContext uimaContext, Element dictionariesElement) Creates dictionary engines by parsing the section defined by this.DICTIONARIES_KEY
private static RareWordDictionary	parseDictionary(UimaContext uimaContext, Element dictionaryElement) Creates a dictionary by parsing each child element of this.DICTIONARIES_KEY
private static java.util.Map<java.lang.String,java.lang.String>	parsePairingNames(Element pairingsElement, java.lang.String pairingName)
private static java.util.Properties	parsePropertiesXml(Element propertiesElement) Builds a collection of key, value properties

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Logger LOGGER

EMPTY_OBJECT_ARRAY

private static final java.lang.Object[] EMPTY_OBJECT_ARRAY

DICTIONARIES_KEY

private static final java.lang.String DICTIONARIES_KEY

XML keys specifying the main sections that define dictionaries, concept factories, and the pairing of the two

See Also:

Constant Field Values

CONCEPT_FACTORIES_KEY

private static final java.lang.String CONCEPT_FACTORIES_KEY

See Also:

Constant Field Values

PAIRS_KEY

private static final java.lang.String PAIRS_KEY

See Also:

Constant Field Values

CONSUMER_KEY

private static final java.lang.String CONSUMER_KEY

XML key specifying the section that defines the single TermConsumer that should be used to consume discovered terms.

See Also:

Constant Field Values

NAME_KEY

private static final java.lang.String NAME_KEY

Each dictionary, concept factory, pairing and term consumer should have a unique name

See Also:

Constant Field Values

IMPLEMENTATION_KEY

private static final java.lang.String IMPLEMENTATION_KEY

Each RareWordDictionary, ConceptFactory, and TermConsumer must have a java implementation.

See Also:

Constant Field Values

PAIR_DICTIONARY_NAME

private static final java.lang.String PAIR_DICTIONARY_NAME

pairings must have specified dictionaries and concept factories

See Also:

Constant Field Values

PAIR_CONCEPT_FACTORY_NAME

private static final java.lang.String PAIR_CONCEPT_FACTORY_NAME

See Also:

Constant Field Values

PROPERTIES_KEY

private static final java.lang.String PROPERTIES_KEY

everything else is implementation-specific and therefore optional and therefore set as a property

See Also:

Constant Field Values

MAX_LIST_SIZE

private static final int MAX_LIST_SIZE

See Also:

Constant Field Values

Constructor Detail

DictionaryDescriptorParser

private DictionaryDescriptorParser()

A Utility Class cannot be instantiated

Method Detail

parseDescriptor

public static DictionarySpec parseDescriptor(java.io.File descriptorFile,
                             UimaContext uimaContext)
                                      throws AnnotatorContextException

Initiates the parsing of the XML descriptor file containing definition of dictionaries and a consumer for the Rare Word Term dictionary paradigm

Parameters:

descriptorFile - XML-formatted file, see the dictionary-lookup resources file RareWordTermsUMLS.xml for an example

uimaContext - -

Returns:

DefaultDictionarySpec with specification of dictionaries and a consumer as read from the descriptorFile

Throws:

AnnotatorContextException - if the File could not be found/read or the xml could not be parsed

parseDictionaries

private static java.util.Map<java.lang.String,RareWordDictionary> parseDictionaries(UimaContext uimaContext,
                                                                   Element dictionariesElement)
                                                                             throws AnnotatorContextException

Creates dictionary engines by parsing the section defined by this.DICTIONARIES_KEY

Parameters:

uimaContext - -

dictionariesElement - contains definition of all dictionaries

Returns:

Mapping of dictionary names to new RareWordDictionary instances

Throws:

AnnotatorContextException - if the resource specified by this.EXTERNAL_RESOURCE does not match the type specified by this.IMPLEMENTATION or for some reason could not be used

parseDictionary

private static RareWordDictionary parseDictionary(UimaContext uimaContext,
                                 Element dictionaryElement)
                                           throws AnnotatorContextException

Creates a dictionary by parsing each child element of this.DICTIONARIES_KEY

Parameters:

uimaContext - -

dictionaryElement - contains the definition of a single dictionary

Returns:

a dictionary or null if there is a problem

Throws:

AnnotatorContextException - if any of a dozen things goes wrong

parseConceptFactories

private static java.util.Map<java.lang.String,ConceptFactory> parseConceptFactories(UimaContext uimaContext,
                                                                   Element conceptFactoriesElement)
                                                                             throws AnnotatorContextException

Creates concept factories by parsing the section defined by {@link this.CONCEPT_FACTORY_KEY

Parameters:

uimaContext - -

conceptFactoriesElement - contains definition of all concept factories

Returns:

Mapping of concept factory names to new ConceptFactory instances

Throws:

AnnotatorContextException - if the resource specified by this.EXTERNAL_RESOURCE does not match the type specified by this.IMPLEMENTATION or for some reason could not be used

parseConceptFactory

private static ConceptFactory parseConceptFactory(UimaContext uimaContext,
                                 Element conceptFactoryElement)
                                           throws AnnotatorContextException

Creates a dictionary by parsing each child element of this.DICTIONARIES_KEY

Parameters:

uimaContext - -

conceptFactoryElement - contains the definition of a single dictionary

Returns:

a dictionary or null if there is a problem

Throws:

AnnotatorContextException - if any of a dozen things goes wrong

parsePairingNames

private static java.util.Map<java.lang.String,java.lang.String> parsePairingNames(Element pairingsElement,
                                                                 java.lang.String pairingName)
                                                                           throws AnnotatorContextException

Parameters:

pairingsElement - -

pairingName - one of "dictionaryName" or "conceptFactoryName"

Returns:

-

Throws:

AnnotatorContextException - -

getName

private static java.lang.String getName(java.lang.String elementName,
                       Element element)
                                 throws AnnotatorContextException

Throws:

AnnotatorContextException

parseConsumerXml

private static TermConsumer parseConsumerXml(UimaContext uimaContext,
                            Element lookupConsumerElement)
                                      throws AnnotatorContextException

Creates a term consumer by parsing section defined by this.CONSUMER_KEY

Parameters:

uimaContext - -

lookupConsumerElement - contains the definition of the term consumer

Returns:

a term consumer

Throws:

AnnotatorContextException - if any of a dozen things goes wrong

parsePropertiesXml

private static java.util.Properties parsePropertiesXml(Element propertiesElement)

Builds a collection of key, value properties

Parameters:

propertiesElement - element with key, value pairs

Returns:

Properties