edu.mit.jmwe.harness.result

Interface ISentenceResult<T extends IToken,S extends IMarkedSentence<T>>

Type Parameters:

T - the type of tokens contained in the sentence.

S - the type of sentence whose results are stored. Is parameterized by tokens of type T.

All Superinterfaces:

IBaseResult

All Known Implementing Classes:

SentenceResult

public interface ISentenceResult<T extends IToken,S extends IMarkedSentence<T>>
extends IBaseResult

Contains results for one IMarkedSentence object. Contains a list of false positives, false negatives, and true positives as well as the precision and recall for that sentence.

Since:

jMWE 1.0.0

Version:

$Id: ISentenceResult.java 321 2011-05-06 23:44:50Z markaf $

Author:

Nidhi Kulkarni

Method Summary

Modifier and Type	Method and Description
java.util.List<IMWE<T>>	getAnswers() Returns the answer multi-word expression in the sentence.
java.util.List<IMWE<T>>	getFalseNegatives() Returns a list of the false negatives.
java.util.List<IMWE<T>>	getFalsePositives() Returns a list of the false positives.
java.util.List<IMWE<T>>	getFound() Returns the multi-word expression found by the detector in the sentence.
S	getSentence() Returns the sentence corresponding to this result.
java.util.List<IMWE<T>>	getTruePositives() Returns a list of the true positives.

Methods inherited from interface edu.mit.jmwe.harness.result.IBaseResult

getFScore, getPrecision, getRecall, getTotalAnswers, getTotalCorrect, getTotalFound

Method Detail

getSentence

S getSentence()

Returns the sentence corresponding to this result.

Returns:

the sentence corresponding to this result.

Since:

jMWE 1.0.0

getFalsePositives

java.util.List<IMWE<T>> getFalsePositives()

Returns a list of the false positives. Should return the empty list if there are no false positives. Should never return null.

Returns:

a list of false positives. Should return the empty list if there are no false positives. Should never return null.

Since:

jMWE 1.0.0

getFalseNegatives

java.util.List<IMWE<T>> getFalseNegatives()

Returns a list of the false negatives. Should return the empty list if there are no false negatives. Should never return null.

Returns:

a list of false negatives. Should return the empty list if there are no false negatives. Should never return null.

Since:

jMWE 1.0.0

getTruePositives

java.util.List<IMWE<T>> getTruePositives()

Returns a list of the true positives. Should return the empty list if there are no true positives. Should never return null.

Returns:

a list of true positives. Should return the empty list if there are no true positives. Should never return null.

Since:

jMWE 1.0.0

getAnswers

java.util.List<IMWE<T>> getAnswers()

Returns the answer multi-word expression in the sentence. Should return the empty list if there are no answer multi-word expressions. Should never return null.

Returns:

a list of the answer multi-word expression in the sentence. Should return the empty list if there are no answer multi-word expression. Should never return null.

Since:

jMWE 1.0.0

getFound

java.util.List<IMWE<T>> getFound()

Returns the multi-word expression found by the detector in the sentence. Should return the empty list if the detector found no multi-word expressions. Should never return null.

Returns:

a list of the multi-word expression found by the detector in the sentence. Should return the empty list if the detector found no multi-word expressions. Should never return null.

Since:

jMWE 1.0.0