opennlp.tools.namefind

Class TokenNameFinderEvaluator

java.lang.Object

opennlp.tools.util.eval.Evaluator<NameSample>

opennlp.tools.namefind.TokenNameFinderEvaluator

public class TokenNameFinderEvaluator
extends Evaluator<NameSample>

The TokenNameFinderEvaluator measures the performance of the given TokenNameFinder with the provided reference NameSamples.

See Also:

Evaluator, TokenNameFinder, NameSample

Constructor Summary

Constructors

Constructor and Description
TokenNameFinderEvaluator(TokenNameFinder nameFinder, TokenNameFinderEvaluationMonitor... listeners) Initializes the current instance with the given TokenNameFinder.

Method Summary

Modifier and Type	Method and Description
FMeasure	getFMeasure()
static void	main(String[] args) Deprecated.
protected NameSample	processSample(NameSample reference) Evaluates the given reference NameSample object.

Methods inherited from class opennlp.tools.util.eval.Evaluator

evaluate, evaluateSample

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenNameFinderEvaluator

public TokenNameFinderEvaluator(TokenNameFinder nameFinder,
                                TokenNameFinderEvaluationMonitor... listeners)

Initializes the current instance with the given TokenNameFinder.

Parameters:

nameFinder - the TokenNameFinder to evaluate.

listeners - evaluation sample listeners

Method Detail

processSample

protected NameSample processSample(NameSample reference)

Evaluates the given reference NameSample object. This is done by finding the names with the TokenNameFinder in the sentence from the reference NameSample. The found names are then used to calculate and update the scores.

Overrides:

processSample in class Evaluator<NameSample>

Parameters:

reference - the reference NameSample.

Returns:

the predicted NameSample.

getFMeasure

public FMeasure getFMeasure()

main

@Deprecated
public static void main(String[] args)
                             throws IOException,
                                    InvalidFormatException

Deprecated.

Throws:

IOException

InvalidFormatException