org.aksw.gerbil.annotator.decorator

Class ErrorCountingAnnotatorDecorator

java.lang.Object

org.aksw.gerbil.annotator.decorator.AbstractAnnotatorDecorator

org.aksw.gerbil.annotator.decorator.ErrorCountingAnnotatorDecorator

All Implemented Interfaces:

Closeable, AutoCloseable, Annotator, AnnotatorDecorator, ErrorCounter, Evaluator<org.aksw.gerbil.transfer.nif.Marking>

public abstract class ErrorCountingAnnotatorDecorator
extends AbstractAnnotatorDecorator
implements Evaluator<org.aksw.gerbil.transfer.nif.Marking>, ErrorCounter

This is a simple decorator for an annotator which handles exceptions thrown by the decorated annotator. It logs these exceptions and counts the errors. This behavior makes it possible, that the BAT-Framework doesn't quit the experiment even if an exception is thrown.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_COUNT_RESULT_NAME
protected int	errorCount
protected int	maxErrors

Fields inherited from class org.aksw.gerbil.annotator.decorator.AbstractAnnotatorDecorator

decoratedAnnotator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ErrorCountingAnnotatorDecorator(Annotator decoratedAnnotator, int maxErrors)

Method Summary

Modifier and Type	Method and Description
static ErrorCountingAnnotatorDecorator	createDecorator(ExperimentType type, Annotator annotator, int numberOfExpectedCalls)
void	evaluate(List<List<org.aksw.gerbil.transfer.nif.Marking>> annotatorResults, List<List<org.aksw.gerbil.transfer.nif.Marking>> goldStandard, EvaluationResultContainer results)
int	getErrorCount()
protected void	increaseErrorCount()
protected static void	logResult(List<? extends org.aksw.gerbil.transfer.nif.Marking> result, String annotatorName, String markingName)
protected static List<org.aksw.gerbil.transfer.nif.Meaning>	performC2KB(ErrorCountingAnnotatorDecorator errorCounter, org.aksw.gerbil.transfer.nif.Document document)
protected static List<org.aksw.gerbil.transfer.nif.MeaningSpan>	performD2KBTask(ErrorCountingAnnotatorDecorator errorCounter, org.aksw.gerbil.transfer.nif.Document document)
protected static List<org.aksw.gerbil.transfer.nif.MeaningSpan>	performExtraction(ErrorCountingAnnotatorDecorator errorCounter, org.aksw.gerbil.transfer.nif.Document document)
protected static List<org.aksw.gerbil.transfer.nif.data.TypedNamedEntity>	performOKETask1(ErrorCountingAnnotatorDecorator errorCounter, org.aksw.gerbil.transfer.nif.Document document)
protected static List<org.aksw.gerbil.transfer.nif.data.TypedNamedEntity>	performOKETask2(ErrorCountingAnnotatorDecorator errorCounter, org.aksw.gerbil.transfer.nif.Document document)
protected static List<org.aksw.gerbil.transfer.nif.Span>	performRecognition(ErrorCountingAnnotatorDecorator errorCounter, org.aksw.gerbil.transfer.nif.Document document)
static List<org.aksw.gerbil.transfer.nif.TypedSpan>	performRT2KBTask(ErrorCountingAnnotatorDecorator errorCounter, org.aksw.gerbil.transfer.nif.Document document)
protected static List<org.aksw.gerbil.transfer.nif.TypedSpan>	performTyping(ErrorCountingAnnotatorDecorator errorCounter, org.aksw.gerbil.transfer.nif.Document document)
void	setErrorCount(int errorCount)
static void	setPrintDebugMsg(boolean flag)

Methods inherited from class org.aksw.gerbil.annotator.decorator.AbstractAnnotatorDecorator

close, getDecoratedAnnotator, getName, setClosePermitionGranter, setName

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_COUNT_RESULT_NAME

public static final String ERROR_COUNT_RESULT_NAME

See Also:

Constant Field Values

errorCount

protected int errorCount

maxErrors

protected int maxErrors

Constructor Detail

ErrorCountingAnnotatorDecorator

protected ErrorCountingAnnotatorDecorator(Annotator decoratedAnnotator,
                                          int maxErrors)

Method Detail

createDecorator

public static ErrorCountingAnnotatorDecorator createDecorator(ExperimentType type,
                                                              Annotator annotator,
                                                              int numberOfExpectedCalls)

logResult

protected static void logResult(List<? extends org.aksw.gerbil.transfer.nif.Marking> result,
                                String annotatorName,
                                String markingName)

performC2KB

protected static List<org.aksw.gerbil.transfer.nif.Meaning> performC2KB(ErrorCountingAnnotatorDecorator errorCounter,
                                                                        org.aksw.gerbil.transfer.nif.Document document)
                                                                 throws GerbilException

Throws:

GerbilException

performD2KBTask

protected static List<org.aksw.gerbil.transfer.nif.MeaningSpan> performD2KBTask(ErrorCountingAnnotatorDecorator errorCounter,
                                                                                org.aksw.gerbil.transfer.nif.Document document)
                                                                         throws GerbilException

Throws:

GerbilException

performExtraction

protected static List<org.aksw.gerbil.transfer.nif.MeaningSpan> performExtraction(ErrorCountingAnnotatorDecorator errorCounter,
                                                                                  org.aksw.gerbil.transfer.nif.Document document)
                                                                           throws GerbilException

Throws:

GerbilException

performTyping

protected static List<org.aksw.gerbil.transfer.nif.TypedSpan> performTyping(ErrorCountingAnnotatorDecorator errorCounter,
                                                                            org.aksw.gerbil.transfer.nif.Document document)
                                                                     throws GerbilException

Throws:

GerbilException

performRecognition

protected static List<org.aksw.gerbil.transfer.nif.Span> performRecognition(ErrorCountingAnnotatorDecorator errorCounter,
                                                                            org.aksw.gerbil.transfer.nif.Document document)
                                                                     throws GerbilException

Throws:

GerbilException

performOKETask1

protected static List<org.aksw.gerbil.transfer.nif.data.TypedNamedEntity> performOKETask1(ErrorCountingAnnotatorDecorator errorCounter,
                                                                                          org.aksw.gerbil.transfer.nif.Document document)
                                                                                   throws GerbilException

Throws:

GerbilException

performOKETask2

protected static List<org.aksw.gerbil.transfer.nif.data.TypedNamedEntity> performOKETask2(ErrorCountingAnnotatorDecorator errorCounter,
                                                                                          org.aksw.gerbil.transfer.nif.Document document)
                                                                                   throws GerbilException

Throws:

GerbilException

performRT2KBTask

public static List<org.aksw.gerbil.transfer.nif.TypedSpan> performRT2KBTask(ErrorCountingAnnotatorDecorator errorCounter,
                                                                            org.aksw.gerbil.transfer.nif.Document document)
                                                                     throws GerbilException

Throws:

GerbilException

getErrorCount

public int getErrorCount()

Specified by:

getErrorCount in interface ErrorCounter

setErrorCount

public void setErrorCount(int errorCount)

Specified by:

setErrorCount in interface ErrorCounter

increaseErrorCount

protected void increaseErrorCount()
                           throws GerbilException

Throws:

GerbilException

evaluate

public void evaluate(List<List<org.aksw.gerbil.transfer.nif.Marking>> annotatorResults,
                     List<List<org.aksw.gerbil.transfer.nif.Marking>> goldStandard,
                     EvaluationResultContainer results)

Specified by:

evaluate in interface Evaluator<org.aksw.gerbil.transfer.nif.Marking>

setPrintDebugMsg

public static void setPrintDebugMsg(boolean flag)