Package org.languagetool.rules.uk

Class TypographyRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.uk.TypographyRule

public class TypographyRule
extends Rule

A rule that matches short dash inside words

Field Summary

Fields

Modifier and Type	Field	Description
private static final Pattern	BAD_LATIN
private static final Pattern	PATTERN
private static final Pattern	SHORT_DASH_WORD

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
TypographyRule(ResourceBundle messages)

Method Summary

Modifier and Type	Method	Description
private RuleMatch	createRuleMatch(AnalyzedTokenReadings readings, List<String> replacements, String msg, AnalyzedSentence sentence)
String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
final String	getId()	A string used to identify the rule in e.g.
String	getShort()
private static boolean	isNumber(AnalyzedTokenReadings analyzedTokenReadings)
final RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.
private String	shortDashToken(AnalyzedTokenReadings tokenReadings)

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getAntiPatterns, getCategory, getCorrectExamples, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMinPrevMatches, getPriority, getRuleOptions, getSentenceWithImmunization, getSourceFile, getSubId, getTags, 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

PATTERN

private static final Pattern PATTERN

SHORT_DASH_WORD

private static final Pattern SHORT_DASH_WORD

BAD_LATIN

private static final Pattern BAD_LATIN

Constructor Details

TypographyRule

public TypographyRule(ResourceBundle messages)
               throws IOException

Throws:

IOException

Method Details

getId

public final 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

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

getShort

public String getShort()

match

public final 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

isNumber

private static boolean isNumber(AnalyzedTokenReadings analyzedTokenReadings)

shortDashToken

private String shortDashToken(AnalyzedTokenReadings tokenReadings)

createRuleMatch

private RuleMatch createRuleMatch(AnalyzedTokenReadings readings,
 List<String> replacements,
 String msg,
 AnalyzedSentence sentence)