org.apache.ctakes.temporal.ae

Class EventEventRelationAnnotator

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

org.cleartk.ml.CleartkAnnotator<String>

org.apache.ctakes.temporal.ae.TemporalRelationExtractorAnnotator

org.apache.ctakes.temporal.ae.EventEventRelationAnnotator

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent, org.apache.uima.fit.factory.initializable.Initializable

@PipeBitInfo(name="E-E TLinker",
             description="Creates Event - Event TLinks.",
             dependencies={SECTION,SENTENCE,EVENT},
             products=TEMPORAL_RELATION)
public class EventEventRelationAnnotator
extends TemporalRelationExtractorAnnotator

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ctakes.temporal.ae.TemporalRelationExtractorAnnotator

TemporalRelationExtractorAnnotator.IdentifiedAnnotationPair

Field Summary

Fields inherited from class org.apache.ctakes.temporal.ae.TemporalRelationExtractorAnnotator

category_frequency, coin, MINMAX_EXTRACTOR_KEY, NO_RELATION_CATEGORY, PARAM_PROB_VIEW, PARAM_PROBABILITY_OF_KEEPING_A_NEGATIVE_EXAMPLE, probabilityOfKeepingANegativeExample

Fields inherited from class org.cleartk.ml.CleartkAnnotator

classifier, dataWriter, PARAM_CLASSIFIER_FACTORY_CLASS_NAME, PARAM_DATA_WRITER_FACTORY_CLASS_NAME, PARAM_IS_TRAINING

Constructor Summary

Constructors

Constructor and Description
EventEventRelationAnnotator()

Method Summary

Modifier and Type	Method and Description
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAnnotatorDescription(File modelDirectory) Deprecated. use String path instead of File. ClearTK will automatically Resolve the String to an InputStream. This will allow resources to be read within from a jar as well as File.
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createAnnotatorDescription(String modelPath)
static org.apache.uima.analysis_engine.AnalysisEngineDescription	createDataWriterDescription(Class<? extends org.cleartk.ml.DataWriter<String>> dataWriterClass, File outputDirectory, double probabilityOfKeepingANegativeExample)
protected void	createRelation(org.apache.uima.jcas.JCas jCas, IdentifiedAnnotation arg1, IdentifiedAnnotation arg2, String predictedCategory, double confidence) Create a UIMA relation type based on arguments and the relation label.
protected List<TemporalRelationExtractorAnnotator.IdentifiedAnnotationPair>	getCandidateRelationArgumentPairs(org.apache.uima.jcas.JCas jCas, org.apache.uima.jcas.tcas.Annotation sentence) Selects the relevant mentions/annotations within a covering annotation for relation identification/extraction.
protected Class<? extends org.apache.uima.jcas.tcas.Annotation>	getCoveringClass()
protected List<RelationFeaturesExtractor<IdentifiedAnnotation,IdentifiedAnnotation>>	getFeatureExtractors() Defines the list of feature extractors used by the classifier.
protected String	getRelationCategory(Map<List<org.apache.uima.jcas.tcas.Annotation>,BinaryTextRelation> relationLookup, IdentifiedAnnotation arg1, IdentifiedAnnotation arg2) Looks up the arguments in the specified lookup table and converts the relation into a label for classification

Methods inherited from class org.apache.ctakes.temporal.ae.TemporalRelationExtractorAnnotator

classify, getRelationClass, initialize, process

Methods inherited from class org.cleartk.ml.CleartkAnnotator

collectionProcessComplete, isTraining

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

Constructor Detail

EventEventRelationAnnotator

public EventEventRelationAnnotator()

Method Detail

createDataWriterDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createDataWriterDescription(Class<? extends org.cleartk.ml.DataWriter<String>> dataWriterClass,
                                                                                                    File outputDirectory,
                                                                                                    double probabilityOfKeepingANegativeExample)
                                                                                             throws org.apache.uima.resource.ResourceInitializationException

Throws:

org.apache.uima.resource.ResourceInitializationException

createAnnotatorDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAnnotatorDescription(String modelPath)
                                                                                            throws org.apache.uima.resource.ResourceInitializationException

Throws:

org.apache.uima.resource.ResourceInitializationException

createAnnotatorDescription

public static org.apache.uima.analysis_engine.AnalysisEngineDescription createAnnotatorDescription(File modelDirectory)
                                                                                            throws org.apache.uima.resource.ResourceInitializationException

Deprecated. use String path instead of File. ClearTK will automatically Resolve the String to an InputStream. This will allow resources to be read within from a jar as well as File.

Throws:

org.apache.uima.resource.ResourceInitializationException

getFeatureExtractors

protected List<RelationFeaturesExtractor<IdentifiedAnnotation,IdentifiedAnnotation>> getFeatureExtractors()

Description copied from class: TemporalRelationExtractorAnnotator

Defines the list of feature extractors used by the classifier. Subclasses may override this method to provide a different set of feature extractors.

Overrides:

getFeatureExtractors in class TemporalRelationExtractorAnnotator

Returns:

The list of feature extractors to use.

getCoveringClass

protected Class<? extends org.apache.uima.jcas.tcas.Annotation> getCoveringClass()

Specified by:

getCoveringClass in class TemporalRelationExtractorAnnotator

getCandidateRelationArgumentPairs

protected List<TemporalRelationExtractorAnnotator.IdentifiedAnnotationPair> getCandidateRelationArgumentPairs(org.apache.uima.jcas.JCas jCas,
                                                                                                              org.apache.uima.jcas.tcas.Annotation sentence)

Description copied from class: TemporalRelationExtractorAnnotator

Selects the relevant mentions/annotations within a covering annotation for relation identification/extraction.

Specified by:

getCandidateRelationArgumentPairs in class TemporalRelationExtractorAnnotator

createRelation

protected void createRelation(org.apache.uima.jcas.JCas jCas,
                              IdentifiedAnnotation arg1,
                              IdentifiedAnnotation arg2,
                              String predictedCategory,
                              double confidence)

Description copied from class: TemporalRelationExtractorAnnotator

Create a UIMA relation type based on arguments and the relation label. This allows subclasses to create/define their own types: e.g. coreference can create CoreferenceRelation instead of BinaryTextRelation

Overrides:

createRelation in class TemporalRelationExtractorAnnotator

Parameters:

jCas - - JCas object, needed to create new UIMA types

arg1 - - First argument to relation

arg2 - - Second argument to relation

predictedCategory - - Name of relation

confidence - - Confidence score of the relation prediction

getRelationCategory

protected String getRelationCategory(Map<List<org.apache.uima.jcas.tcas.Annotation>,BinaryTextRelation> relationLookup,
                                     IdentifiedAnnotation arg1,
                                     IdentifiedAnnotation arg2)

Description copied from class: TemporalRelationExtractorAnnotator

Looks up the arguments in the specified lookup table and converts the relation into a label for classification

Overrides:

getRelationCategory in class TemporalRelationExtractorAnnotator

Returns:

If this category should not be processed for training return null otherwise it returns the label sent to the datawriter