org.languagetool.tools

Class Tools

Object

Tools

public final class Tools
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static int	checkBitext(BitextReader reader, JLanguageTool srcLt, JLanguageTool trgLt, List<BitextRule> bRules, boolean apiFormat) Checks the bilingual input (bitext) and displays the output (considering the target language) in API format or in the simple text format.
static List<RuleMatch>	checkBitext(String src, String trg, 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	checkBitext(String src, String trg, JLanguageTool srcLt, JLanguageTool trgLt, List<BitextRule> bRules, boolean apiFormat, StringTools.XmlPrintMode xmlMode) 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 apiFormat, int lineOffset)
static int	checkText(String contents, JLanguageTool lt, boolean apiFormat, int contextSize, int lineOffset, int prevMatches, StringTools.XmlPrintMode xmlMode) Check the given text and print results to System.out.
static int	checkText(String contents, JLanguageTool lt, int lineOffset)
static void	correctBitext(BitextReader reader, JLanguageTool sourceLt, JLanguageTool targetLt, List<BitextRule> bRules) Automatically applies suggestions to the bilingual text.
static String	correctText(String contents, JLanguageTool lt) Automatically applies suggestions to the text.
static List<BitextRule>	getBitextRules(Language source, Language target) Gets default bitext rules for a given pair of languages
static String	getFullStackTrace(Throwable e) Get a stacktrace as a string.
static InputStream	getStream(String filename) Load a file form the classpath using getResourceAsStream().
static long	median(long[] m)
static int	profileRulesOnLine(String contents, JLanguageTool lt, Rule rule)
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.

Methods inherited from class Object

equals, 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.

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,
            int lineOffset)
                     throws IOException

Throws:

IOException

checkText

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

Throws:

IOException

checkText

public static int checkText(String contents,
            JLanguageTool lt,
            boolean apiFormat,
            int contextSize,
            int lineOffset,
            int prevMatches,
            StringTools.XmlPrintMode xmlMode)
                     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

apiFormat - whether to print the result in a simple XML 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

xmlMode - mode of xml printout for simple xml output

Returns:

Number of rule matches to the input text.

Throws:

IOException

checkBitext

public static int checkBitext(String src,
              String trg,
              JLanguageTool srcLt,
              JLanguageTool trgLt,
              List<BitextRule> bRules,
              boolean apiFormat,
              StringTools.XmlPrintMode xmlMode)
                       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 relative to the target string only, and always start at the first line and first column, no matter how many lines were checked before. To have multiple lines taken into account, use the checkBitext method that takes a BitextReader.

Parameters:

src - Source text.

trg - Target text.

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.

apiFormat - Whether API format should be used.

xmlMode - The mode of XML output display.

Returns:

The number of rules matched on the bitext.

Throws:

IOException

Since:

1.0.1

checkBitext

public static int checkBitext(BitextReader reader,
              JLanguageTool srcLt,
              JLanguageTool trgLt,
              List<BitextRule> bRules,
              boolean apiFormat)
                       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.

apiFormat - Whether API format should be used.

Returns:

The number of rules matched on the bitext.

Throws:

IOException

Since:

1.0.1

checkBitext

public static List<RuleMatch> checkBitext(String src,
                          String trg,
                          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.

Parameters:

src - Source text.

trg - Target text.

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 list of rule matches on the bitext.

Throws:

IOException

Since:

1.0.1

getBitextRules

public static List<BitextRule> getBitextRules(Language source,
                              Language target)
                                       throws IOException,
                                              ParserConfigurationException,
                                              SAXException

Gets default bitext rules for a given pair of languages

Parameters:

source - Source language.

target - Target language.

Returns:

List of Bitext rules

Throws:

IOException

ParserConfigurationException

SAXException

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.

Parameters:

contents - - text to check

lt - - instance of LanguageTool

Throws:

IOException

profileRulesOnLine

public static int profileRulesOnLine(String contents,
                     JLanguageTool lt,
                     Rule rule)
                              throws IOException

Throws:

IOException

median

public static long median(long[] m)

correctText

public static String correctText(String contents,
                 JLanguageTool lt)
                          throws IOException

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

Parameters:

contents - - String to be corrected

lt - - Initialized LanguageTool object

Returns:

Corrected text as String.

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.

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

getFullStackTrace

public static String getFullStackTrace(Throwable e)

Get a stacktrace as a string.

getStream

public static InputStream getStream(String filename)
                             throws IOException

Load a file form the classpath using getResourceAsStream().

Parameters:

filename -

Returns:

the stream of the file

Throws:

IOException