Package org.languagetool.tools

Class RuleMatchesAsJsonSerializer

java.lang.Object

org.languagetool.tools.RuleMatchesAsJsonSerializer

public class RuleMatchesAsJsonSerializer
extends Object

Write rule matches and some meta information as JSON.

Since:

3.4, public since 3.6

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	API_VERSION
private final int	compactMode
private static final com.fasterxml.jackson.core.JsonFactory	factory
private static final String	PREMIUM_HINT
private static final String	START_MARKER
private static final String	STATUS

Constructor Summary

Constructors

Constructor	Description
RuleMatchesAsJsonSerializer()
RuleMatchesAsJsonSerializer(int compactMode)

Method Summary

Modifier and Type	Method	Description
private String	cleanSuggestion(String s)
String	ruleMatchesToJson(List<RuleMatch> matches, String text, int contextSize, DetectedLanguage detectedLang)
String	ruleMatchesToJson(List<RuleMatch> matches, List<RuleMatch> hiddenMatches, String text, int contextSize, DetectedLanguage detectedLang, String incompleteResultsReason)
String	ruleMatchesToJson(List<RuleMatch> matches, List<RuleMatch> hiddenMatches, AnnotatedText text, int contextSize, DetectedLanguage detectedLang, String incompleteResultsReason)
private void	writeCategory(com.fasterxml.jackson.core.JsonGenerator g, Category category)
private void	writeContext(com.fasterxml.jackson.core.JsonGenerator g, RuleMatch match, AnnotatedText text, ContextTools contextTools)
private void	writeLanguageSection(com.fasterxml.jackson.core.JsonGenerator g, DetectedLanguage detectedLang)
private void	writeMatchesSection(String sectionName, com.fasterxml.jackson.core.JsonGenerator g, List<RuleMatch> matches, AnnotatedText text, ContextTools contextTools)
private void	writeReplacements(com.fasterxml.jackson.core.JsonGenerator g, RuleMatch match)
private void	writeRule(com.fasterxml.jackson.core.JsonGenerator g, RuleMatch match)
private void	writeSoftwareSection(com.fasterxml.jackson.core.JsonGenerator g)
private void	writeWarningsSection(com.fasterxml.jackson.core.JsonGenerator g, String incompleteResultsReason)

Methods inherited from class java.lang.Object

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

Field Details

API_VERSION

private static final int API_VERSION

See Also:

• Constant Field Values

STATUS

private static final String STATUS

See Also:

• Constant Field Values

PREMIUM_HINT

private static final String PREMIUM_HINT

See Also:

• Constant Field Values

START_MARKER

private static final String START_MARKER

See Also:

• Constant Field Values

factory

private static final com.fasterxml.jackson.core.JsonFactory factory

compactMode

private final int compactMode

Constructor Details

RuleMatchesAsJsonSerializer

public RuleMatchesAsJsonSerializer()

RuleMatchesAsJsonSerializer

public RuleMatchesAsJsonSerializer(int compactMode)

Since:

4.7

Method Details

ruleMatchesToJson

public String ruleMatchesToJson(List<RuleMatch> matches,
 String text,
 int contextSize,
 DetectedLanguage detectedLang)

ruleMatchesToJson

public String ruleMatchesToJson(List<RuleMatch> matches,
 List<RuleMatch> hiddenMatches,
 String text,
 int contextSize,
 DetectedLanguage detectedLang,
 String incompleteResultsReason)

Parameters:

incompleteResultsReason - use a string that explains why results are incomplete (e.g. due to a timeout) - a 'warnings' section will be added to the JSON. Use null if results are complete.

Since:

3.7

ruleMatchesToJson

public String ruleMatchesToJson(List<RuleMatch> matches,
 List<RuleMatch> hiddenMatches,
 AnnotatedText text,
 int contextSize,
 DetectedLanguage detectedLang,
 String incompleteResultsReason)

Parameters:

incompleteResultsReason - use a string that explains why results are incomplete (e.g. due to a timeout) - a 'warnings' section will be added to the JSON. Use null if results are complete.

Since:

4.3

writeSoftwareSection

private void writeSoftwareSection(com.fasterxml.jackson.core.JsonGenerator g)
                           throws IOException

Throws:

IOException

writeWarningsSection

private void writeWarningsSection(com.fasterxml.jackson.core.JsonGenerator g,
 String incompleteResultsReason)
                           throws IOException

Throws:

IOException

writeLanguageSection

private void writeLanguageSection(com.fasterxml.jackson.core.JsonGenerator g,
 DetectedLanguage detectedLang)
                           throws IOException

Throws:

IOException

writeMatchesSection

private void writeMatchesSection(String sectionName,
 com.fasterxml.jackson.core.JsonGenerator g,
 List<RuleMatch> matches,
 AnnotatedText text,
 ContextTools contextTools)
                          throws IOException

Throws:

IOException

cleanSuggestion

private String cleanSuggestion(String s)

writeReplacements

private void writeReplacements(com.fasterxml.jackson.core.JsonGenerator g,
 RuleMatch match)
                        throws IOException

Throws:

IOException

writeContext

private void writeContext(com.fasterxml.jackson.core.JsonGenerator g,
 RuleMatch match,
 AnnotatedText text,
 ContextTools contextTools)
                   throws IOException

Throws:

IOException

writeRule

private void writeRule(com.fasterxml.jackson.core.JsonGenerator g,
 RuleMatch match)
                throws IOException

Throws:

IOException

writeCategory

private void writeCategory(com.fasterxml.jackson.core.JsonGenerator g,
 Category category)
                    throws IOException

Throws:

IOException