SentenceResult (jMWE 1.0.2)

java.lang.Object
- edu.mit.jmwe.harness.result.SentenceResult<T,S>

Type Parameters:

T - the token type

S - the sentence type

All Implemented Interfaces:

IBaseResult, ISentenceResult<T,S>
```
public class SentenceResult<T extends IToken,S extends IMarkedSentence<T>>
extends java.lang.Object
implements ISentenceResult<T,S>
```
Default implementation of the ISentenceResult interface.

Since:

jMWE 1.0.0

Version:

$Id: SentenceResult.java 356 2015-11-25 22:36:46Z markaf $

Author:

Nidhi Kulkarni

Constructor Summary

Constructors
Constructor and Description
`SentenceResult(java.util.List<IMWE<T>> answer, java.util.List<IMWE<T>> retrieved, S sentence)` Constructs a sentence result from a list of answer multi-word expressions and a list of multi-word expressions found by the detector.
`SentenceResult(java.util.List<IMWE<T>> answer, java.util.List<IMWE<T>> retrieved, S sentence, boolean reallocate)` Constructs a sentence result from a list of answer multi-word expressions and a list of multi-word expressions found by the detector.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`double`	`getFScore()` Returns the F1 score, a double between zero and 1, inclusive.
`double`	`getPrecision()` Returns the precision, a double between zero and 1, inclusive.
`double`	`getRecall()` Returns the recall, a double between zero and 1, inclusive.
`S`	`getSentence()` Returns the sentence corresponding to this result.
`int`	`getTotalAnswers()` Returns the total number of answers.
`int`	`getTotalCorrect()` Returns the total number of items correctly identified.
`int`	`getTotalFound()` Returns the total number items found.
`java.util.List<IMWE<T>>`	`getTruePositives()` Returns a list of the true positives.
`static <T extends IToken,S extends IMarkedSentence<T>> void`	`printTable(java.lang.StringBuilder sb, ISentenceResult<T,S> result, java.util.Formatter f)` Prints a table of the correct, false negative and false positive expressions found by the detector in columns.
`java.lang.String`	`toString()`
`static <T extends IToken,S extends IMarkedSentence<T>> java.lang.String`	`toString(ISentenceResult<T,S> result, S sentence, boolean table)` Creates a graphical representation of the multi-word expressions found by the detector for a given sentence.
`static <T extends IToken,U extends IMarkedSentence<T>> java.lang.String`	`toString(ISentenceResult<T,U> result, U sentence)` Creates a graphical representation of the multi-word expressions found by the detector for a given sentence.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SentenceResult
```
public SentenceResult(java.util.List<IMWE<T>> answer,
                      java.util.List<IMWE<T>> retrieved,
                      S sentence)
```
    Constructs a sentence result from a list of answer multi-word expressions and a list of multi-word expressions found by the detector. Finds and stores the false negatives, false positives, and true positives by comparing the given lists. Reallocates new internal lists for the answer and retrieved lists, and so subsequent changes to the source lists will not affect this object.
    
    Parameters:
    
    answer - a non-null list of answer multi-word expressions.
    
    retrieved - a non-null list of multi-word expressions found by the detector.
    
    sentence - the sentence for which this object is a result
    
    Throws:
    
    java.lang.NullPointerException - if either list is null
    
    Since:
    
    jMWE 1.0.0
  - SentenceResult
```
public SentenceResult(java.util.List<IMWE<T>> answer,
                      java.util.List<IMWE<T>> retrieved,
                      S sentence,
                      boolean reallocate)
```
    Constructs a sentence result from a list of answer multi-word expressions and a list of multi-word expressions found by the detector. Finds and stores the false negatives, false positives, and true positives by comparing the given lists. If no reallocation is requested, this constructor reuses the given lists, and so subsequent changes to the source list will affect this object.
    
    Parameters:
    
    answer - a non-null list of answer multi-word expressions.
    
    retrieved - a non-null list of multi-word expressions found by the detector.
    
    sentence - the sentence for which this object is a result
    
    reallocate - If true, will allocate new internal lists for the answer and retrieved lists.
    
    Throws:
    
    java.lang.NullPointerException - if either list is null
    
    Since:
    
    jMWE 1.0.0
- Method Detail
  - getSentence
```
public S getSentence()
```
    Description copied from interface: ISentenceResult
    
    Returns the sentence corresponding to this result.
    
    Specified by:
    
    getSentence in interface ISentenceResult<T extends IToken,S extends IMarkedSentence<T>>
    
    Returns:
    
    the sentence corresponding to this result.
  - getFalseNegatives
```
public java.util.List<IMWE<T>> getFalseNegatives()
```
    Description copied from interface: ISentenceResult
    
    Returns a list of the false negatives. Should return the empty list if there are no false negatives. Should never return null.
    
    Specified by:
    
    getFalseNegatives in interface ISentenceResult<T extends IToken,S extends IMarkedSentence<T>>
    
    Returns:
    
    a list of false negatives. Should return the empty list if there are no false negatives. Should never return null.
  - getFalsePositives
```
public java.util.List<IMWE<T>> getFalsePositives()
```
    Description copied from interface: ISentenceResult
    
    Returns a list of the false positives. Should return the empty list if there are no false positives. Should never return null.
    
    Specified by:
    
    getFalsePositives in interface ISentenceResult<T extends IToken,S extends IMarkedSentence<T>>
    
    Returns:
    
    a list of false positives. Should return the empty list if there are no false positives. Should never return null.
  - getTruePositives
```
public java.util.List<IMWE<T>> getTruePositives()
```
    Description copied from interface: ISentenceResult
    
    Returns a list of the true positives. Should return the empty list if there are no true positives. Should never return null.
    
    Specified by:
    
    getTruePositives in interface ISentenceResult<T extends IToken,S extends IMarkedSentence<T>>
    
    Returns:
    
    a list of true positives. Should return the empty list if there are no true positives. Should never return null.
  - getAnswers
```
public java.util.List<IMWE<T>> getAnswers()
```
    Description copied from interface: ISentenceResult
    
    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.
    
    Specified by:
    
    getAnswers in interface ISentenceResult<T extends IToken,S extends IMarkedSentence<T>>
    
    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.
  - getFound
```
public java.util.List<IMWE<T>> getFound()
```
    Description copied from interface: ISentenceResult
    
    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.
    
    Specified by:
    
    getFound in interface ISentenceResult<T extends IToken,S extends IMarkedSentence<T>>
    
    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.
  - getPrecision
```
public double getPrecision()
```
    Description copied from interface: IBaseResult
    
    Returns the precision, a double between zero and 1, inclusive.
    
    Specified by:
    
    getPrecision in interface IBaseResult
    
    Returns:
    
    the precision, a double between zero and 1, inclusive.
  - getRecall
```
public double getRecall()
```
    Description copied from interface: IBaseResult
    
    Returns the recall, a double between zero and 1, inclusive.
    
    Specified by:
    
    getRecall in interface IBaseResult
    
    Returns:
    
    the recall, a double between zero and 1, inclusive.
  - getFScore
```
public double getFScore()
```
    Description copied from interface: IBaseResult
    
    Returns the F1 score, a double between zero and 1, inclusive. The F1 score, or f-measure, is the harmonic mean of the precision and the recall.
    
    Specified by:
    
    getFScore in interface IBaseResult
    
    Returns:
    
    the F1 score, a double between zero and 1, inclusive.
  - getTotalAnswers
```
public int getTotalAnswers()
```
    Description copied from interface: IBaseResult
    
    Returns the total number of answers.
    
    Specified by:
    
    getTotalAnswers in interface IBaseResult
    
    Returns:
    
    the total number of answers
  - getTotalCorrect
```
public int getTotalCorrect()
```
    Description copied from interface: IBaseResult
    
    Returns the total number of items correctly identified.
    
    Specified by:
    
    getTotalCorrect in interface IBaseResult
    
    Returns:
    
    the total number of items correctly identified
  - getTotalFound
```
public int getTotalFound()
```
    Description copied from interface: IBaseResult
    
    Returns the total number items found.
    
    Specified by:
    
    getTotalFound in interface IBaseResult
    
    Returns:
    
    the total number of items found
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public static <T extends IToken,U extends IMarkedSentence<T>> java.lang.String toString(ISentenceResult<T,U> result,
                                                                                        U sentence)
```
    Creates a graphical representation of the multi-word expressions found by the detector for a given sentence. Prints the sentence and each multi-word expression the detector finds on its own line under the corresponding tokens in the sentence. Underneath the sentence, prints out the correct, false negative, and false positive multi-word expressions in columns.
    
    Type Parameters:
    
    T - the type of tokens in the sentence and its associated multi-word expressions
    
    U - the type of sentence. Is parameterized by tokens of type T.
    
    Parameters:
    
    result - the sentence result obtained after running the detector over the sentence
    
    sentence - the sentence the detector is run over
    
    Returns:
    
    a graphical representation of the multi-word expressions found by the detector for a given sentence.
    
    Since:
    
    jMWE 1.0.0
  - toString
```
public static <T extends IToken,S extends IMarkedSentence<T>> java.lang.String toString(ISentenceResult<T,S> result,
                                                                                        S sentence,
                                                                                        boolean table)
```
    Creates a graphical representation of the multi-word expressions found by the detector for a given sentence. Prints the sentence and each multi-word expression the detector finds on its own line under the corresponding tokens in the sentence. May or may not print out the correct, false negative, and false positive multi-word expressions in columns under the sentence depending on the value of the table flag.
    
    Type Parameters:
    
    T - the type of tokens in the sentence and its associated multi-word expressions
    
    S - the type of sentence. Is parameterized by tokens of type T.
    
    Parameters:
    
    result - the sentence result obtained after running the detector over the sentence
    
    sentence - the sentence the detector is run over
    
    table - if true, prints the correct, false negative, and false positive expressions in columns under the sentence.
    
    Returns:
    
    a graphical representation of the multi-word expressions found by the detector for a given sentence.
    
    Since:
    
    jMWE 1.0.0
  - printTable
```
public static <T extends IToken,S extends IMarkedSentence<T>> void printTable(java.lang.StringBuilder sb,
                                                                              ISentenceResult<T,S> result,
                                                                              java.util.Formatter f)
```
    Prints a table of the correct, false negative and false positive expressions found by the detector in columns.
    
    Type Parameters:
    
    T - the type of tokens in the sentence and its associated multi-word expressions
    
    S - the type of sentence. Is parameterized by tokens of type T.
    
    Parameters:
    
    sb - the string builder to which the table should be written
    
    result - the result to be written
    
    f - the formatter to be used
    
    Since:
    
    jMWE 1.0.0

Class SentenceResult<T extends IToken,S extends IMarkedSentence<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SentenceResult

SentenceResult

Method Detail

getSentence

getFalseNegatives

getFalsePositives

getTruePositives

getAnswers

getFound

getPrecision

getRecall

getFScore

getTotalAnswers

getTotalCorrect

getTotalFound

toString

toString

toString

printTable