org.languagetool.dev.wikipedia

Class WikipediaQuickCheck

java.lang.Object

org.languagetool.dev.wikipedia.WikipediaQuickCheck

public class WikipediaQuickCheck
extends Object

Check a Wikipedia page (without spell check), fetching the page via the MediaWiki API.

Constructor Summary

Constructors

Constructor and Description
WikipediaQuickCheck()
WikipediaQuickCheck(File ngramDir)
WikipediaQuickCheck(File ngramDir, int maxSizeBytes)

Method Summary

Modifier and Type	Method and Description
WikipediaQuickCheckResult	checkPage(String plainText, Language lang)
MarkupAwareWikipediaResult	checkPage(URL url)
MarkupAwareWikipediaResult	checkPage(URL url, ErrorMarker errorMarker)
List<String>	getDisabledRuleIds()
Language	getLanguage(URL url)
String	getMediaWikiContent(URL wikipediaUrl)
String	getPageTitle(URL url)
String	getPlainText(String completeWikiContent)
PlainTextMapping	getPlainTextMapping(String completeWikiContent)
static void	main(String[] args)
void	setDisabledRuleIds(List<String> ruleIds)
void	validateWikipediaUrl(URL wikipediaUrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

WikipediaQuickCheck

public WikipediaQuickCheck()

WikipediaQuickCheck

public WikipediaQuickCheck(File ngramDir)

Parameters:

ngramDir - directory with sub directories like 'en', 'de' etc that contain '1grams' etc directories with ngram data (Lucene indexes)

Since:

3.1

WikipediaQuickCheck

public WikipediaQuickCheck(File ngramDir,
                           int maxSizeBytes)

Parameters:

ngramDir - directory with sub directories like 'en', 'de' etc that contain '1grams' etc directories with ngram data (Lucene indexes)

maxSizeBytes - the maximum bytes of XML for the methods that take an URL, longer content will throw an exception

Since:

3.3

Method Detail

getMediaWikiContent

public String getMediaWikiContent(URL wikipediaUrl)
                           throws IOException

Throws:

IOException

getLanguage

public Language getLanguage(URL url)

getPageTitle

public String getPageTitle(URL url)

setDisabledRuleIds

public void setDisabledRuleIds(List<String> ruleIds)

getDisabledRuleIds

public List<String> getDisabledRuleIds()

checkPage

public MarkupAwareWikipediaResult checkPage(URL url)
                                     throws IOException,
                                            PageNotFoundException

Throws:

IOException

PageNotFoundException

checkPage

public MarkupAwareWikipediaResult checkPage(URL url,
                                            ErrorMarker errorMarker)
                                     throws IOException,
                                            PageNotFoundException

Throws:

IOException

PageNotFoundException

Since:

2.6

checkPage

public WikipediaQuickCheckResult checkPage(String plainText,
                                           Language lang)
                                    throws IOException

Throws:

IOException

validateWikipediaUrl

public void validateWikipediaUrl(URL wikipediaUrl)

getPlainText

public String getPlainText(String completeWikiContent)

Parameters:

completeWikiContent - the Mediawiki syntax as it comes from the API, including surrounding XML

getPlainTextMapping

public PlainTextMapping getPlainTextMapping(String completeWikiContent)

Parameters:

completeWikiContent - the Mediawiki syntax as it comes from the API, including surrounding XML

main

public static void main(String[] args)
                 throws IOException,
                        PageNotFoundException

Throws:

IOException

PageNotFoundException