cat.lump.aq.wikilink.jwpl

Class WikipediaJwpl

java.lang.Object

Wikipedia

cat.lump.aq.wikilink.jwpl.WikipediaJwpl

public class WikipediaJwpl
extends Wikipedia

This class provides methods for initialising a jwpl Wikipedia instance. It includes definitions for images and categories in 13 languages, namely:

• Arabic
• Basque
• Catalan
• Croatian
• English
• Estonian
• French
• German
• Greek
• Italian
• Latvian
• Lithuanian
• Romanian
• Slovenian
• Spanish

Since:

Jan 15, 2013

Version:

0.1.2

Author:

albarron

Constructor Summary

Constructors

Constructor and Description
WikipediaJwpl(DatabaseConfiguration dbConfig) Invokes the super class with the database configuration, sets the constants loads the JWPL Wikipedia instance.
WikipediaJwpl(java.util.Locale lang, int year) Creates its own database configuration according to language and year

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getCategoryLabels()
java.lang.String[]	getImageLabels()
static java.lang.String	getJwplDBprefix()
java.util.List<Paragraph>	getParagraphsFromArticle(int id) Obtains the paragraphs of a parsed article id
java.util.List<Paragraph>	getParagraphsFromArticle(java.lang.String title) Obtains the paragraphs of a parsed article title
ParsedPage	getParsedArticle(int id) Parses a Wikipedia article
ParsedPage	getParsedArticle(java.lang.String title) Parses a Wikipedia article
MediaWikiParser	getParser() TODO determine whether this parser should be returned.
java.util.List<Section>	getSectionsFromArticle(int id) Obtains the sections of parsed article
java.util.List<Section>	getSectionsFromArticle(java.lang.String title) Obtains the sections of a parsed article
void	getSubSectionsFromArticle(int id) Obtains the sub-sections of a parsed article
void	getSubSectionsFromArticle(java.lang.String title) Obtains the sub-sections of a parsed article
boolean	isAcronym(Page page) Checks if the page is an acronym page
boolean	isDisambiguation(Page page) Checks if this is a disambiguation page
boolean	isRedirect(Page page) Checks if the page is a redirect page
void	loadWikipedia() Sets the image and category labels for the working language.
static void	main(java.lang.String[] args) In this example we run an instance of Wikipedia and display a couple of articles' contents.

Methods inherited from class java.lang.Object

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

Constructor Detail

WikipediaJwpl

public WikipediaJwpl(java.util.Locale lang,
             int year)
              throws WikiApiException

Creates its own database configuration according to language and year

Parameters:

lang -

year - can be only "2010", "2012", or "2013"

Throws:

WikiApiException

WikipediaJwpl

public WikipediaJwpl(DatabaseConfiguration dbConfig)
              throws WikiApiException

Invokes the super class with the database configuration, sets the constants loads the JWPL Wikipedia instance.

Parameters:

dbConfig -

Throws:

WikiApiException

Method Detail

loadWikipedia

public void loadWikipedia()
                   throws WikiApiException

Sets the image and category labels for the working language. We initialise the parser to get Wikipedia chunks in different formats.

Throws:

WikiApiException

isAcronym

public boolean isAcronym(Page page)
                  throws WikiTitleParsingException

Checks if the page is an acronym page

Parameters:

page - The page to check

Returns:

true if the given page is an acronym page; false otherwise.

Throws:

WikiTitleParsingException

isRedirect

public boolean isRedirect(Page page)

Checks if the page is a redirect page

Parameters:

page - The page to check

Returns:

true if the given page is a redirect page; false otherwise.

getJwplDBprefix

public static java.lang.String getJwplDBprefix()

Returns:

prefix for the database containing the JWPL Wikipedia database

getImageLabels

public java.lang.String[] getImageLabels()

Returns:

Label for images in the language

getCategoryLabels

public java.lang.String[] getCategoryLabels()

Returns:

Label for categories in the language

getParser

public MediaWikiParser getParser()

TODO determine whether this parser should be returned. This should be made here.

Returns:

The parser for this WIkipedia

getParsedArticle

public ParsedPage getParsedArticle(int id)
                            throws WikiApiException

Parses a Wikipedia article

Parameters:

id - id for the article to be parsed

Returns:

a parsed version of the Article

Throws:

WikiApiException

See Also:

MediaWikiParser}

getParsedArticle

public ParsedPage getParsedArticle(java.lang.String title)
                            throws WikiApiException

Parses a Wikipedia article

Parameters:

title - Title for the Wikipedia article

Returns:

a parsed version of the Article

Throws:

WikiApiException

See Also:

MediaWikiParser}

getSectionsFromArticle

public java.util.List<Section> getSectionsFromArticle(int id)
                                               throws WikiApiException

Obtains the sections of parsed article

Parameters:

id - for the article

Returns:

List including all the sections of the article.

Throws:

WikiApiException

getSectionsFromArticle

public java.util.List<Section> getSectionsFromArticle(java.lang.String title)
                                               throws WikiApiException

Obtains the sections of a parsed article

Parameters:

title - of the article

Returns:

List including all the sections of the article.

Throws:

WikiApiException

getSubSectionsFromArticle

public void getSubSectionsFromArticle(int id)
                               throws WikiApiException

Obtains the sub-sections of a parsed article

Parameters:

id - of the article

Throws:

WikiApiException

getSubSectionsFromArticle

public void getSubSectionsFromArticle(java.lang.String title)
                               throws WikiApiException

Obtains the sub-sections of a parsed article

Parameters:

title - of the article

Throws:

WikiApiException - TODO: right now this doesn't get anything

getParagraphsFromArticle

public java.util.List<Paragraph> getParagraphsFromArticle(int id)
                                                   throws WikiApiException

Obtains the paragraphs of a parsed article id

Parameters:

id -

Returns:

A list with all of the paragraphs.

Throws:

WikiApiException

getParagraphsFromArticle

public java.util.List<Paragraph> getParagraphsFromArticle(java.lang.String title)
                                                   throws WikiApiException

Obtains the paragraphs of a parsed article title

Parameters:

title -

Returns:

A list with all of the paragraphs.

Throws:

WikiApiException

isDisambiguation

public boolean isDisambiguation(Page page)
                         throws WikiTitleParsingException

Checks if this is a disambiguation page

Parameters:

page - The page to check

Returns:

true if the given page is a disambiguation page; false otherwise.

Throws:

WikiTitleParsingException

main

public static void main(java.lang.String[] args)
                 throws WikiApiException

In this example we run an instance of Wikipedia and display a couple of articles' contents.

Parameters:

args -

Throws:

WikiApiException