org.languagetool.rules

Class RuleMatch

java.lang.Object

org.languagetool.rules.RuleMatch

All Implemented Interfaces:

Comparable<RuleMatch>

public class RuleMatch
extends Object
implements Comparable<RuleMatch>

Information about an error rule that matches text and the position of the match. See ContextTools for displaying errors in their original text context.

Author:

Daniel Naber

Constructor Summary

Constructors

Constructor and Description
RuleMatch(Rule rule, int fromPos, int toPos, String message) Creates a RuleMatch object, taking the rule that triggered this match, position of the match and an explanation message.
RuleMatch(Rule rule, int fromPos, int toPos, String message, String shortMessage) Creates a RuleMatch object, taking the rule that triggered this match, position of the match and an explanation message.
RuleMatch(Rule rule, int fromPos, int toPos, String message, String shortMessage, boolean startWithUppercase, String suggestionsOutMsg) Creates a RuleMatch object, taking the rule that triggered this match, position of the match and an explanation message.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(RuleMatch other) Compare by start position.
boolean	equals(Object o)
int	getColumn() Get the column number in which the match occurs (zero-based).
int	getEndColumn() Get the column number in which the match ends (zero-based).
int	getEndLine() Get the line number in which the match ends (zero-based).
int	getFromPos() Position of the start of the error (in characters, zero-based).
int	getLine() Get the line number in which the match occurs (zero-based).
String	getMessage() A human-readable explanation describing the error.
Rule	getRule()
String	getShortMessage() A shorter human-readable explanation describing the error or an empty string if no such explanation is available.
List<String>	getSuggestedReplacements() The text fragments which might be an appropriate fix for the problem.
int	getToPos() Position of the end of the error (in characters, zero-based).
int	hashCode()
void	setColumn(int column) Set the column number in which the match occurs (zero-based).
void	setEndColumn(int endColumn) Set the column number in which the match ends (zero-based).
void	setEndLine(int endLine) Set the line number in which the match ends (zero-based).
void	setLine(int fromLine) Set the line number in which the match occurs (zero-based).
void	setSuggestedReplacement(String replacement)
void	setSuggestedReplacements(List<String> replacements)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RuleMatch

public RuleMatch(Rule rule,
         int fromPos,
         int toPos,
         String message)

Creates a RuleMatch object, taking the rule that triggered this match, position of the match and an explanation message. This message is scanned for <suggestion>...</suggestion> to get suggested fixes for the problem detected by this rule.

RuleMatch

public RuleMatch(Rule rule,
         int fromPos,
         int toPos,
         String message,
         String shortMessage)

Creates a RuleMatch object, taking the rule that triggered this match, position of the match and an explanation message. This message is scanned for <suggestion>...</suggestion> to get suggested fixes for the problem detected by this rule.

Parameters:

shortMessage - used for example in OpenOffice/LibreOffice's context menu

RuleMatch

public RuleMatch(Rule rule,
         int fromPos,
         int toPos,
         String message,
         String shortMessage,
         boolean startWithUppercase,
         String suggestionsOutMsg)

Creates a RuleMatch object, taking the rule that triggered this match, position of the match and an explanation message. This message is scanned for <suggestion>...</suggestion> to get suggested fixes for the problem detected by this rule.

Parameters:

shortMessage - used for example in OpenOffice/LibreOffice's context menu (may be null)

startWithUppercase - whether the original text at the position of the match starts with an uppercase character

Method Detail

getRule

public Rule getRule()

setLine

public void setLine(int fromLine)

Set the line number in which the match occurs (zero-based).

getLine

public int getLine()

Get the line number in which the match occurs (zero-based).

setEndLine

public void setEndLine(int endLine)

Set the line number in which the match ends (zero-based).

getEndLine

public int getEndLine()

Get the line number in which the match ends (zero-based).

setColumn

public void setColumn(int column)

Set the column number in which the match occurs (zero-based).

getColumn

public int getColumn()

Get the column number in which the match occurs (zero-based).

setEndColumn

public void setEndColumn(int endColumn)

Set the column number in which the match ends (zero-based).

getEndColumn

public int getEndColumn()

Get the column number in which the match ends (zero-based).

getFromPos

public int getFromPos()

Position of the start of the error (in characters, zero-based).

getToPos

public int getToPos()

Position of the end of the error (in characters, zero-based).

getMessage

public String getMessage()

A human-readable explanation describing the error. This may contain one or more corrections marked up with <suggestion>...</suggestion>.

See Also:

getSuggestedReplacements(), getShortMessage()

getShortMessage

public String getShortMessage()

A shorter human-readable explanation describing the error or an empty string if no such explanation is available.

See Also:

getMessage()

setSuggestedReplacement

public void setSuggestedReplacement(String replacement)

See Also:

getSuggestedReplacements()

setSuggestedReplacements

public void setSuggestedReplacements(List<String> replacements)

See Also:

getSuggestedReplacements()

getSuggestedReplacements

public List<String> getSuggestedReplacements()

The text fragments which might be an appropriate fix for the problem. One of these fragments can be used to replace the old text between getFromPos() to getToPos().

Returns:

unmodifiable list of String objects or an empty List

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(RuleMatch other)

Compare by start position.

Specified by:

compareTo in interface Comparable<RuleMatch>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object