edu.mit.jmwe.harness.result.error

Class MissingFromIndex

java.lang.Object

edu.mit.jmwe.harness.result.error.AbstractErrorDetector

edu.mit.jmwe.harness.result.error.MissingFromIndex

All Implemented Interfaces:

IHasID, IErrorDetector

public class MissingFromIndex
extends AbstractErrorDetector

Finds those MWEs that were not found because they do not appear in the given index.

Since:

jMWE 1.0.0

Version:

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

Author:

N. Kulkarni

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID The ID for this error detector, "edu.mit.jmwe.error.Miss"
protected IMWEIndex	index

Constructor Summary

Constructors

Constructor and Description
MissingFromIndex(IMWEIndex index) Constructs a new error detector that looks in the specified index for missing MWEs

Method Summary

Modifier and Type	Method and Description
<T extends IToken,S extends IMarkedSentence<T>> IErrorResult<T>	detect(ISentenceResult<T,S> result) Identifies the multi-word expressions in a unit result that fall under the specific error class this detector identifies.
static <T extends IToken> boolean	isProblem(IMWE<T> mwe, IMWEIndex index) Determines if the specified MWE is a problem, relative to the specified index, according to this error class.

Methods inherited from class edu.mit.jmwe.harness.result.error.AbstractErrorDetector

getID

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

The ID for this error detector, "edu.mit.jmwe.error.Miss"

Since:

jMWE 1.0.0

See Also:

Constant Field Values

index

protected final IMWEIndex index

Constructor Detail

MissingFromIndex

public MissingFromIndex(IMWEIndex index)

Constructs a new error detector that looks in the specified index for missing MWEs

Parameters:

index - the index which backs this detector

Throws:

java.lang.NullPointerException - if the specified index is null

Since:

jMWE 1.0.0

Method Detail

detect

public <T extends IToken,S extends IMarkedSentence<T>> IErrorResult<T> detect(ISentenceResult<T,S> result)

Description copied from interface: IErrorDetector

Identifies the multi-word expressions in a unit result that fall under the specific error class this detector identifies.

Type Parameters:

T - the type of tokens contained in the unit.

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

Parameters:

result - the sentence result obtained by running an IMWEDetector over a unit

Returns:

an error result containing the MWEs identified by this error detector

isProblem

public static <T extends IToken> boolean isProblem(IMWE<T> mwe,
                                                   IMWEIndex index)

Determines if the specified MWE is a problem, relative to the specified index, according to this error class.

Type Parameters:

T - the token type of the MWE

Parameters:

mwe - the MWE in question, may not be null

index - the index to use, may not be null

Returns:

true if the MWE is a problem; false otherwise.

Throws:

java.lang.NullPointerException - if the specified MWE or index is null

Since:

jMWE 1.0.0