Package org.languagetool.server

Class ResultExtender.HiddenRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.server.ResultExtender.HiddenRule

Enclosing class:

ResultExtender

static class ResultExtender.HiddenRule
extends Rule

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final String	categoryId
(package private) final String	categoryName
(package private) final int	estimatedContextForSureMatch
(package private) final ITSIssueType	itsType
(package private) final List<Tag>	tags

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
HiddenRule(String categoryId, String categoryName, String type, List<Tag> tags, int estimatedContextForSureMatch)

Method Summary

Modifier and Type	Method	Description
int	estimateContextForSureMatch()	A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid.
final Category	getCategory()
String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
String	getId()	A string used to identify the rule in e.g.
ITSIssueType	getLocQualityIssueType()	Returns the Localization Quality Issue Type, as defined at http://www.w3.org/International/multilingualweb/lt/drafts/its20/its20.html#lqissue-typevalues.
List<Tag>	getTags()
RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, getAntiPatterns, getCorrectExamples, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getMinPrevMatches, getPriority, getRuleOptions, getSentenceWithImmunization, getSourceFile, getSubId, getToneTags, getUrl, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isIncludedInHiddenMatches, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncludedInHiddenMatches, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setPriority, setTags, setToneTags, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Details

categoryId

final String categoryId

categoryName

final String categoryName

itsType

final ITSIssueType itsType

estimatedContextForSureMatch

final int estimatedContextForSureMatch

tags

final List<Tag> tags

Constructor Details

HiddenRule

HiddenRule(String categoryId,
 String categoryName,
 String type,
 List<Tag> tags,
 int estimatedContextForSureMatch)

Method Details

getCategory

@NotNull
public final Category getCategory()

Overrides:

getCategory in class Rule

Returns:

a category (never null since LT 3.4)

getId

public String getId()

Description copied from class: Rule

A string used to identify the rule in e.g. configuration files. This string is supposed to be unique and to stay the same in all upcoming versions of LanguageTool. It's supposed to contain only the characters A-Z and the underscore.

Specified by:

getId in class Rule

getLocQualityIssueType

public ITSIssueType getLocQualityIssueType()

Description copied from class: Rule

Returns the Localization Quality Issue Type, as defined at http://www.w3.org/International/multilingualweb/lt/drafts/its20/its20.html#lqissue-typevalues.

Note that not all languages nor all rules actually map yet to a type yet. In those cases, uncategorized is returned.

Overrides:

getLocQualityIssueType in class Rule

Returns:

the Localization Quality Issue Type - uncategorized if no type has been assigned

getDescription

public String getDescription()

Description copied from class: Rule

A short description of the error this rule can detect, usually in the language of the text that is checked.

Specified by:

getDescription in class Rule

match

public RuleMatch[] match(AnalyzedSentence sentence)

Description copied from class: Rule

Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule. Note that the order in which this method is called is not always guaranteed, i.e. the sentence order in the text may be different from the order in which you get the sentences (this may be the case when LanguageTool is used as a LibreOffice/OpenOffice add-on, for example). In other words, implementations must be stateless, so that a previous call to this method has no influence on later calls.

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

estimateContextForSureMatch

public int estimateContextForSureMatch()

Description copied from class: Rule

A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid. This is useful for check-as-you-type, where a match might occur and the word that gets typed next makes the match disappear (something one would obviously like to avoid). Note: this may over-estimate the real context size. Returns -1 when the sentence needs to end to be sure there's a match.

Overrides:

estimateContextForSureMatch in class Rule

getTags

@NotNull
public List<Tag> getTags()

Overrides:

getTags in class Rule