org.cleartk.timeml.event

Class EventClassAnnotator

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<OUTCOME_TYPE>

org.cleartk.timeml.event.EventAttributeAnnotator<String>

org.cleartk.timeml.event.EventClassAnnotator

All Implemented Interfaces:

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

public class EventClassAnnotator
extends EventAttributeAnnotator<String>

Copyright (c) 2010, Regents of the University of Colorado
All rights reserved. Annotator for the "class" attribute of TimeML EVENTs.

Author:

Steven Bethard

Field Summary

Fields

Modifier and Type	Field and Description
static CleartkInternalModelFactory	FACTORY

Fields inherited from class org.cleartk.timeml.event.EventAttributeAnnotator

contextExtractors, eventFeatureExtractors

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
EventClassAnnotator()

Method Summary

Modifier and Type	Method and Description
protected String	getAttribute(Event event) Get the attribute value from the Event annotation.
protected String	getDefaultValue() The attribute value that should be considered as a default, e.g.
void	initialize(org.apache.uima.UimaContext context)
protected void	setAttribute(Event event, String value) Set the attribute value on the Event annotation.

Methods inherited from class org.cleartk.timeml.event.EventAttributeAnnotator

process

Methods inherited from class org.cleartk.ml.CleartkAnnotator

collectionProcessComplete, isTraining

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, getLogger, getResultSpecification, reconfigure, setResultSpecification

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final CleartkInternalModelFactory FACTORY

Constructor Detail

EventClassAnnotator

public EventClassAnnotator()

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

Specified by:

initialize in interface org.apache.uima.fit.factory.initializable.Initializable

Overrides:

initialize in class EventAttributeAnnotator<String>

Throws:

org.apache.uima.resource.ResourceInitializationException

getDefaultValue

protected String getDefaultValue()

Description copied from class: EventAttributeAnnotator

The attribute value that should be considered as a default, e.g. "NONE". When the attribute value is null in the CAS, this value will be used instead. Additionally, when the classifier produces this value, no attribute will be added.

Specified by:

getDefaultValue in class EventAttributeAnnotator<String>

Returns:

The default attribute value.

getAttribute

protected String getAttribute(Event event)

Description copied from class: EventAttributeAnnotator

Get the attribute value from the Event annotation. Typically this will be by calling something like Event.getTense(). If this method returns null, EventAttributeAnnotator.getDefaultValue() will be called to produce an appropriate attribute value.

Specified by:

getAttribute in class EventAttributeAnnotator<String>

Parameters:

event - The Event annotation whose attribute is to be retrieved.

Returns:

The selected attribute value.

setAttribute

protected void setAttribute(Event event,
                            String value)

Description copied from class: EventAttributeAnnotator

Set the attribute value on the Event annotation. Typically this will be by calling something like Event.setTense(String). This method will not be called if the value is equal to EventAttributeAnnotator.getDefaultValue().

Specified by:

setAttribute in class EventAttributeAnnotator<String>

Parameters:

event - The Event annotation whose attribute is to be set.

value - The new attribute value.