org.languagetool.rules

Class TestRemoteRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.RemoteRule

org.languagetool.rules.TestRemoteRule

public class TestRemoteRule
extends RemoteRule

Nested Class Summary

Nested classes/interfaces inherited from class org.languagetool.rules.RemoteRule

RemoteRule.RemoteRequest

Field Summary

Fields inherited from class org.languagetool.rules.RemoteRule

circuitBreakers, filterMatches, fixOffsets, inputLogging, lt, premium, ruleLanguage, serviceConfiguration, shutdownRoutines, suppressMisspelledMatch, suppressMisspelledSuggestions, whitespaceNormalisation

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
TestRemoteRule(Language lang, RemoteRuleConfig config)

Method Summary

Modifier and Type	Method and Description
protected Callable<RemoteRuleResult>	executeRequest(RemoteRule.RemoteRequest request, long timeoutMilliseconds)
protected RemoteRuleResult	fallbackResults(RemoteRule.RemoteRequest request) fallback if executeRequest times out or throws an error
String	getDescription() A short description of the error this rule can detect, usually in the language of the text that is checked.
protected RemoteRule.RemoteRequest	prepareRequest(List<AnalyzedSentence> sentences, Long textSessionId) run local preprocessing steps (or just store sentences)

Methods inherited from class org.languagetool.rules.RemoteRule

circuitBreaker, createCircuitBreaker, fixMatchOffsets, getId, getServiceConfiguration, getTimeout, isPremium, match, run, run, shutdown

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getMinPrevMatches, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasConfigurableValue, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setTags, setToneTags, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Constructor Detail

TestRemoteRule

public TestRemoteRule(Language lang,
                      RemoteRuleConfig config)

Method Detail

prepareRequest

protected RemoteRule.RemoteRequest prepareRequest(List<AnalyzedSentence> sentences,
                                                  Long textSessionId)

Description copied from class: RemoteRule

run local preprocessing steps (or just store sentences)

Specified by:

prepareRequest in class RemoteRule

Parameters:

sentences - text to process

textSessionId - session ID for caching, partial rollout, A/B testing

Returns:

parameter for executeRequest/fallbackResults

executeRequest

protected Callable<RemoteRuleResult> executeRequest(RemoteRule.RemoteRequest request,
                                                    long timeoutMilliseconds)
                                             throws TimeoutException

Specified by:

executeRequest in class RemoteRule

Parameters:

request - returned by prepareRequest

timeoutMilliseconds - timeout for this operation, <=0 -> unlimited

Returns:

callable that sends request, parses and returns result for this remote rule

Throws:

TimeoutException - if timeout was exceeded

fallbackResults

protected RemoteRuleResult fallbackResults(RemoteRule.RemoteRequest request)

Description copied from class: RemoteRule

fallback if executeRequest times out or throws an error

Specified by:

fallbackResults in class RemoteRule

Parameters:

request - returned by prepareRequest

Returns:

local results for this 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