org.puimula.libvoikko

Class GrammarError

java.lang.Object

org.puimula.libvoikko.GrammarError

public class GrammarError
extends Object

A grammar error is associated with a segment of text in a paragraph. It contains an error code which can be used to provide human readable error explanation and optionally replacement suggestions for the error segment that would fix the error. GUI software could visually display the error by for example underlining the error segment starting from getStartPos() and consisting of getErrorLen() characters.

Constructor Summary

Constructors

Constructor and Description
GrammarError(int errorCode, int startPos, int errorLen, List<String> suggestions, String shortDescription)

Method Summary

Methods

Modifier and Type	Method and Description
int	getErrorCode() Error code describing the type of error.
int	getErrorLen()
String	getShortDescription()
int	getStartPos()
List<String>	getSuggestions()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GrammarError

public GrammarError(int errorCode,
            int startPos,
            int errorLen,
            List<String> suggestions,
            String shortDescription)

Method Detail

getErrorCode

public int getErrorCode()

Error code describing the type of error.

Returns:

the error code

getStartPos

public int getStartPos()

Returns:

start of the error segment within the paragraph

getErrorLen

public int getErrorLen()

Returns:

length of the error segment

getSuggestions

public List<String> getSuggestions()

Returns:

list of suggested replacements for the marked error

getShortDescription

public String getShortDescription()

Returns:

human readable short description for the error.

toString

public String toString()

Overrides:

toString in class Object