eu.openminted.uc.socialsciences.variabledetection.uima

Class VariableMentionDisambiguator

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.JCasAnnotator_ImplBase

org.apache.uima.fit.component.JCasAnnotator_ImplBase

eu.openminted.uc.socialsciences.variabledetection.uima.VariableMentionDisambiguator

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

public class VariableMentionDisambiguator
extends org.apache.uima.fit.component.JCasAnnotator_ImplBase

Assign variable IDs to sentences based on calculating the similarity between the sentence text and the description of the variable.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_DISAMBIGUATE_ALL_MENTIONS If set to false, only correct="Yes" mentions are disambiguated, otherwise all mentions are disambiguated.
static String	PARAM_LANGUAGE Use this language instead of the document language to resolve the model.
static String	PARAM_MAX_MENTIONS Maximum number of variables linked.
static String	PARAM_MODEL_LOCATION Location of the similarity model.
static String	PARAM_SCORE_THRESHOLD Minimum similarity score to a variable require to count as a match (0-5).
static String	PARAM_VARIABLE_FILE_LOCATION This parameter accepts a path to an XML file containing the specification of the variables.
static String	PARAM_VARIABLE_SPECIFICATION This parameter accepts an XML string containing the specification of the variables.
static String	PARAM_VARIANT Override the default variant used to locate the model.
static String	PARAM_WRITE_LOG Whether to write a detailed log of the results.

Constructor Summary

Constructors

Constructor and Description
VariableMentionDisambiguator()

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete()
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.jcas.JCas aJCas)

Methods inherited from class org.apache.uima.fit.component.JCasAnnotator_ImplBase

getLogger

Methods inherited from class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

getRequiredCasInterface, process

Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase

getCasInstancesRequired, hasNext, next

Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

batchProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_LANGUAGE

public static final String PARAM_LANGUAGE

Use this language instead of the document language to resolve the model.

See Also:

Constant Field Values

PARAM_VARIANT

public static final String PARAM_VARIANT

Override the default variant used to locate the model.

See Also:

Constant Field Values

PARAM_MODEL_LOCATION

public static final String PARAM_MODEL_LOCATION

Location of the similarity model.

See Also:

Constant Field Values

PARAM_VARIABLE_SPECIFICATION

public static final String PARAM_VARIABLE_SPECIFICATION

This parameter accepts an XML string containing the specification of the variables.

See Also:

Constant Field Values

PARAM_VARIABLE_FILE_LOCATION

public static final String PARAM_VARIABLE_FILE_LOCATION

This parameter accepts a path to an XML file containing the specification of the variables.

See Also:

Constant Field Values

PARAM_DISAMBIGUATE_ALL_MENTIONS

public static final String PARAM_DISAMBIGUATE_ALL_MENTIONS

If set to false, only correct="Yes" mentions are disambiguated, otherwise all mentions are disambiguated.

See Also:

Constant Field Values

PARAM_WRITE_LOG

public static final String PARAM_WRITE_LOG

Whether to write a detailed log of the results. This is mainly useful if gold-data is provided to the component.

See Also:

Constant Field Values

PARAM_SCORE_THRESHOLD

public static final String PARAM_SCORE_THRESHOLD

Minimum similarity score to a variable require to count as a match (0-5).

See Also:

Constant Field Values

PARAM_MAX_MENTIONS

public static final String PARAM_MAX_MENTIONS

Maximum number of variables linked.

See Also:

Constant Field Values

Constructor Detail

VariableMentionDisambiguator

public VariableMentionDisambiguator()

Method Detail

initialize

public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException

Specified by:

initialize in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

initialize in class org.apache.uima.fit.component.JCasAnnotator_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

process

public void process(org.apache.uima.jcas.JCas aJCas)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

process in class org.apache.uima.analysis_component.JCasAnnotator_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

collectionProcessComplete

public void collectionProcessComplete()
                               throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Specified by:

collectionProcessComplete in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

collectionProcessComplete in class org.apache.uima.analysis_component.AnalysisComponent_ImplBase

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException