Package org.languagetool.server

Class TextChecker

java.lang.Object

org.languagetool.server.TextChecker

Direct Known Subclasses:

V2TextChecker

abstract class TextChecker
extends java.lang.Object

Since:

3.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	TextChecker.QueryParams

Field Summary

Fields

Modifier and Type	Field	Description
private org.languagetool.ResultCache	cache
private static int	CACHE_STATS_PRINT
protected HTTPServerConfig	config
protected static int	CONTEXT_SIZE
private DatabaseLogger	databaseLogger
private static java.lang.String	ENCODING
private java.util.concurrent.ExecutorService	executorService
private org.languagetool.language.LanguageIdentifier	identifier
private java.util.Map<java.lang.String,java.lang.Integer>	languageCheckCounts
private long	lastHiddenMatchesServerTimeout
private static org.slf4j.Logger	logger
private java.lang.Long	logServerId
protected static int	NUM_PIPELINES_PER_SETTING
(package private) PipelinePool	pipelinePool
private RequestCounter	reqCounter
private java.util.Queue<java.lang.Runnable>	workQueue

Constructor Summary

Constructors

Constructor	Description
TextChecker(HTTPServerConfig config, boolean internalServer, java.util.Queue<java.lang.Runnable> workQueue, RequestCounter reqCounter)

Method Summary

Modifier and Type	Method	Description
protected void	checkParams(java.util.Map<java.lang.String,java.lang.String> parameters)
(package private) void	checkText(org.languagetool.markup.AnnotatedText aText, com.sun.net.httpserver.HttpExchange httpExchange, java.util.Map<java.lang.String,java.lang.String> parameters, ErrorRequestLimiter errorRequestLimiter, java.lang.String remoteAddress)
(package private) org.languagetool.DetectedLanguage	detectLanguageOfString(java.lang.String text, java.lang.String fallbackLanguage, java.util.List<java.lang.String> preferredVariants, java.util.List<java.lang.String> noopLangs, java.util.List<java.lang.String> preferredLangs)
private @NotNull java.util.List<org.languagetool.rules.CategoryId>	getCategoryIds(java.lang.String paramName, java.util.Map<java.lang.String,java.lang.String> parameters)
protected @NotNull java.util.List<java.lang.String>	getCommaSeparatedStrings(java.lang.String paramName, java.util.Map<java.lang.String,java.lang.String> parameters)
protected abstract @NotNull java.util.List<java.lang.String>	getDisabledRuleIds(java.util.Map<java.lang.String,java.lang.String> parameters)
protected abstract @NotNull java.util.List<java.lang.String>	getEnabledRuleIds(java.util.Map<java.lang.String,java.lang.String> parameters)
protected abstract org.languagetool.DetectedLanguage	getLanguage(java.lang.String text, java.util.Map<java.lang.String,java.lang.String> parameters, java.util.List<java.lang.String> preferredVariants, java.util.List<java.lang.String> additionalDetectLangs, java.util.List<java.lang.String> preferredLangs)
protected abstract boolean	getLanguageAutoDetect(java.util.Map<java.lang.String,java.lang.String> parameters)
protected abstract @NotNull java.util.List<java.lang.String>	getPreferredVariants(java.util.Map<java.lang.String,java.lang.String> parameters)
protected abstract java.lang.String	getResponse(org.languagetool.markup.AnnotatedText text, org.languagetool.DetectedLanguage lang, org.languagetool.Language motherTongue, java.util.List<org.languagetool.rules.RuleMatch> matches, java.util.List<org.languagetool.rules.RuleMatch> hiddenMatches, java.lang.String incompleteResultReason, int compactMode)
private java.util.List<org.languagetool.rules.RuleMatch>	getRuleMatches(org.languagetool.markup.AnnotatedText aText, org.languagetool.Language lang, org.languagetool.Language motherTongue, java.util.Map<java.lang.String,java.lang.String> parameters, TextChecker.QueryParams params, org.languagetool.UserConfig userConfig, org.languagetool.RuleMatchListener listener)
private java.util.Map<java.lang.String,java.lang.Integer>	getRuleValues(java.util.Map<java.lang.String,java.lang.String> parameters)
private java.util.List<java.lang.String>	getUserDictWords(java.lang.Long userId)
private void	prewarmPipelinePool()
protected abstract void	setHeaders(com.sun.net.httpserver.HttpExchange httpExchange)
(package private) void	shutdownNow()

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_SIZE

protected static final int CONTEXT_SIZE

See Also:

Constant Field Values

NUM_PIPELINES_PER_SETTING

protected static final int NUM_PIPELINES_PER_SETTING

See Also:

Constant Field Values

config

protected final HTTPServerConfig config

logger

private static final org.slf4j.Logger logger

ENCODING

private static final java.lang.String ENCODING

See Also:

Constant Field Values

CACHE_STATS_PRINT

private static final int CACHE_STATS_PRINT

See Also:

Constant Field Values

languageCheckCounts

private final java.util.Map<java.lang.String,java.lang.Integer> languageCheckCounts

workQueue

private java.util.Queue<java.lang.Runnable> workQueue

reqCounter

private RequestCounter reqCounter

lastHiddenMatchesServerTimeout

private long lastHiddenMatchesServerTimeout

identifier

private final org.languagetool.language.LanguageIdentifier identifier

executorService

private final java.util.concurrent.ExecutorService executorService

cache

private final org.languagetool.ResultCache cache

databaseLogger

private final DatabaseLogger databaseLogger

logServerId

private final java.lang.Long logServerId

pipelinePool

PipelinePool pipelinePool

Constructor Detail

TextChecker

TextChecker(HTTPServerConfig config,
            boolean internalServer,
            java.util.Queue<java.lang.Runnable> workQueue,
            RequestCounter reqCounter)

Method Detail

setHeaders

protected abstract void setHeaders(com.sun.net.httpserver.HttpExchange httpExchange)

getResponse

protected abstract java.lang.String getResponse(org.languagetool.markup.AnnotatedText text,
                                                org.languagetool.DetectedLanguage lang,
                                                org.languagetool.Language motherTongue,
                                                java.util.List<org.languagetool.rules.RuleMatch> matches,
                                                java.util.List<org.languagetool.rules.RuleMatch> hiddenMatches,
                                                java.lang.String incompleteResultReason,
                                                int compactMode)

getPreferredVariants

@NotNull
protected abstract @NotNull java.util.List<java.lang.String> getPreferredVariants(java.util.Map<java.lang.String,java.lang.String> parameters)

getLanguage

protected abstract org.languagetool.DetectedLanguage getLanguage(java.lang.String text,
                                                                 java.util.Map<java.lang.String,java.lang.String> parameters,
                                                                 java.util.List<java.lang.String> preferredVariants,
                                                                 java.util.List<java.lang.String> additionalDetectLangs,
                                                                 java.util.List<java.lang.String> preferredLangs)

getLanguageAutoDetect

protected abstract boolean getLanguageAutoDetect(java.util.Map<java.lang.String,java.lang.String> parameters)

getEnabledRuleIds

@NotNull
protected abstract @NotNull java.util.List<java.lang.String> getEnabledRuleIds(java.util.Map<java.lang.String,java.lang.String> parameters)

getDisabledRuleIds

@NotNull
protected abstract @NotNull java.util.List<java.lang.String> getDisabledRuleIds(java.util.Map<java.lang.String,java.lang.String> parameters)

prewarmPipelinePool

private void prewarmPipelinePool()

shutdownNow

void shutdownNow()

checkText

void checkText(org.languagetool.markup.AnnotatedText aText,
               com.sun.net.httpserver.HttpExchange httpExchange,
               java.util.Map<java.lang.String,java.lang.String> parameters,
               ErrorRequestLimiter errorRequestLimiter,
               java.lang.String remoteAddress)
        throws java.lang.Exception

Throws:

java.lang.Exception

getRuleValues

private java.util.Map<java.lang.String,java.lang.Integer> getRuleValues(java.util.Map<java.lang.String,java.lang.String> parameters)

getUserDictWords

private java.util.List<java.lang.String> getUserDictWords(java.lang.Long userId)

checkParams

protected void checkParams(java.util.Map<java.lang.String,java.lang.String> parameters)

getRuleMatches

private java.util.List<org.languagetool.rules.RuleMatch> getRuleMatches(org.languagetool.markup.AnnotatedText aText,
                                                                        org.languagetool.Language lang,
                                                                        org.languagetool.Language motherTongue,
                                                                        java.util.Map<java.lang.String,java.lang.String> parameters,
                                                                        TextChecker.QueryParams params,
                                                                        org.languagetool.UserConfig userConfig,
                                                                        org.languagetool.RuleMatchListener listener)
                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getCategoryIds

@NotNull
private @NotNull java.util.List<org.languagetool.rules.CategoryId> getCategoryIds(java.lang.String paramName,
                                                                                  java.util.Map<java.lang.String,java.lang.String> parameters)

getCommaSeparatedStrings

@NotNull
protected @NotNull java.util.List<java.lang.String> getCommaSeparatedStrings(java.lang.String paramName,
                                                                             java.util.Map<java.lang.String,java.lang.String> parameters)

detectLanguageOfString

org.languagetool.DetectedLanguage detectLanguageOfString(java.lang.String text,
                                                         java.lang.String fallbackLanguage,
                                                         java.util.List<java.lang.String> preferredVariants,
                                                         java.util.List<java.lang.String> noopLangs,
                                                         java.util.List<java.lang.String> preferredLangs)