org.languagetool.commandline

Class CommandLineTools

java.lang.Object

org.languagetool.commandline.CommandLineTools

public final class CommandLineTools
extends Object

Since:

2.3

Method Summary

Modifier and Type	Method and Description
static int	checkBitext(BitextReader reader, JLanguageTool srcLt, JLanguageTool trgLt, List<BitextRule> bRules) Checks the bilingual input (bitext) and displays the output (considering the target language) in API format or in the simple text format.
static int	checkText(String contents, JLanguageTool lt)
static int	checkText(String contents, JLanguageTool lt, boolean isJsonFormat, int lineOffset)
static int	checkText(String contents, JLanguageTool lt, boolean isJsonFormat, int contextSize, int lineOffset, int prevMatches, StringTools.ApiPrintMode apiMode, boolean listUnknownWords, JLanguageTool.Level level, List<String> unknownWords, boolean verbose) Check the given text and print results to System.out.
static int	checkText(String contents, JLanguageTool lt, boolean isJsonFormat, int lineOffset, JLanguageTool.Level level, boolean listUnknownWords)
static int	checkText(String contents, JLanguageTool lt, boolean isJsonFormat, int lineOffset, JLanguageTool.Level level, boolean listUnknownWords, boolean verbose)
static void	correctBitext(BitextReader reader, JLanguageTool sourceLt, JLanguageTool targetLt, List<BitextRule> bRules) Automatically applies suggestions to the bilingual text.
static void	printMatches(List<RuleMatch> ruleMatches, int prevMatches, String contents, int contextSize, Language lang, boolean verbose) Displays matches in a simple text format.
static void	profileRulesOnText(String contents, JLanguageTool lt) Simple rule profiler - used to run LT on a corpus to see which rule takes most time.
static void	tagText(String contents, JLanguageTool lt) Tags text using the LanguageTool tagger, printing results to System.out.

Methods inherited from class java.lang.Object

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

Method Detail

tagText

public static void tagText(String contents,
                           JLanguageTool lt)
                    throws IOException

Tags text using the LanguageTool tagger, printing results to System.out.

Parameters:

contents - Text to tag.

lt - LanguageTool instance

Throws:

IOException

checkText

public static int checkText(String contents,
                            JLanguageTool lt)
                     throws IOException

Throws:

IOException

checkText

public static int checkText(String contents,
                            JLanguageTool lt,
                            boolean isJsonFormat,
                            int lineOffset)
                     throws IOException

Throws:

IOException

checkText

public static int checkText(String contents,
                            JLanguageTool lt,
                            boolean isJsonFormat,
                            int lineOffset,
                            JLanguageTool.Level level,
                            boolean listUnknownWords)
                     throws IOException

Throws:

IOException

checkText

public static int checkText(String contents,
                            JLanguageTool lt,
                            boolean isJsonFormat,
                            int lineOffset,
                            JLanguageTool.Level level,
                            boolean listUnknownWords,
                            boolean verbose)
                     throws IOException

Throws:

IOException

checkText

public static int checkText(String contents,
                            JLanguageTool lt,
                            boolean isJsonFormat,
                            int contextSize,
                            int lineOffset,
                            int prevMatches,
                            StringTools.ApiPrintMode apiMode,
                            boolean listUnknownWords,
                            JLanguageTool.Level level,
                            List<String> unknownWords,
                            boolean verbose)
                     throws IOException

Check the given text and print results to System.out.

Parameters:

contents - a text to check (may be more than one sentence)

lt - Initialized LanguageTool

isJsonFormat - whether to print the result in JSON format

contextSize - error text context size: -1 for default

lineOffset - line number offset to be added to line numbers in matches

prevMatches - number of previously matched rules

apiMode - mode of xml/json printout for simple xml/json output

Returns:

Number of rule matches to the input text.

Throws:

IOException

printMatches

public static void printMatches(List<RuleMatch> ruleMatches,
                                int prevMatches,
                                String contents,
                                int contextSize,
                                Language lang,
                                boolean verbose)

Displays matches in a simple text format.

Parameters:

ruleMatches - Matches from rules.

prevMatches - Number of previously found matches.

contents - The text that was checked.

contextSize - The size of contents displayed.

Since:

1.0.1

checkBitext

public static int checkBitext(BitextReader reader,
                              JLanguageTool srcLt,
                              JLanguageTool trgLt,
                              List<BitextRule> bRules)
                       throws IOException

Checks the bilingual input (bitext) and displays the output (considering the target language) in API format or in the simple text format. NOTE: the positions returned by the rule matches are adjusted according to the data returned by the reader.

Parameters:

reader - Reader of bitext strings.

srcLt - Source JLanguageTool (used to analyze the text).

trgLt - Target JLanguageTool (used to analyze the text).

bRules - Bilingual rules used in addition to target standard rules.

Returns:

The number of rules matched on the bitext.

Throws:

IOException

Since:

1.0.1

profileRulesOnText

public static void profileRulesOnText(String contents,
                                      JLanguageTool lt)
                               throws IOException

Simple rule profiler - used to run LT on a corpus to see which rule takes most time. Prints results to System.out.

Parameters:

contents - text to check

lt - instance of LanguageTool

Throws:

IOException

correctBitext

public static void correctBitext(BitextReader reader,
                                 JLanguageTool sourceLt,
                                 JLanguageTool targetLt,
                                 List<BitextRule> bRules)
                          throws IOException

Automatically applies suggestions to the bilingual text. Note: if there is more than one suggestion, always the first one is applied, and others ignored silently. Prints results to System.out.

Parameters:

reader - a bitext file reader

sourceLt - Initialized source JLanguageTool object

targetLt - Initialized target JLanguageTool object

bRules - List of all BitextRules to use

Throws:

IOException