edu.umd.cloud9.collection.wikipedia
Class WikipediaPage

java.lang.Object
  edu.umd.cloud9.collection.Indexable
      edu.umd.cloud9.collection.wikipedia.WikipediaPage

All Implemented Interfaces:

Writable

Direct Known Subclasses:

ArabicWikipediaPage, ChineseWikipediaPage, CzechWikipediaPage, EnglishWikipediaPage, GermanWikipediaPage, SpanishWikipediaPage, SwedishWikipediaPage, TurkishWikipediaPage

public abstract class WikipediaPage
extends Indexable

A page from Wikipedia.

Author:

Jimmy Lin, Peter Exner

Nested Class Summary

static class

WikipediaPage.Link

Field Summary

static String	XML_END_TAG End delimiter of the page, which is </page>.
static String	XML_START_TAG Start delimiter of the page, which is <page>.

Constructor Summary

WikipediaPage()
Creates an empty WikipediaPage object.

Method Summary

List<WikipediaPage.Link>	extractLinks()
List<String>	extractLinkTargets()
String	findInterlanguageLink(String lang) Returns the inter-language link to a specific language (if any).
String	getContent() Returns the contents of this page (title + text).
String	getDisplayContent() Returns the content of the document for display to a human.
String	getDisplayContentType() Returns the type of the display content, per IANA MIME Media Type (e.g., "text/html").
String	getDocid() Returns the article title (i.e., the docid).
String	getLanguage()
String	getRawXML() Returns the raw XML of this page.
String	getTitle() Returns the title of this page.
String	getWikiMarkup() Returns the text of this page.
boolean	isArticle() Checks to see if this page lives in the main/article namespace, and not, for example, "File:", "Category:", "Wikipedia:", etc.
boolean	isDisambiguation() Checks to see if this page is a disambiguation page.
boolean	isEmpty() Checks to see if this page is an empty page.
boolean	isRedirect() Checks to see if this page is a redirect page.
boolean	isStub() Checks to see if this article is a stub.
void	readFields(DataInput in) Serializes this object.
static void	readPage(WikipediaPage page, String s) Reads a raw XML string into a WikipediaPage object.
void	setLanguage(String language) Deprecated.
void	write(DataOutput out) Deserializes this object.

Methods inherited from class java.lang.Object

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

Field Detail

XML_START_TAG

public static final String XML_START_TAG

Start delimiter of the page, which is <page>.

See Also:

Constant Field Values

XML_END_TAG

public static final String XML_END_TAG

End delimiter of the page, which is </page>.

See Also:

Constant Field Values

Constructor Detail

WikipediaPage

public WikipediaPage()

Creates an empty WikipediaPage object.

Method Detail

write

public void write(DataOutput out)
           throws IOException

Deserializes this object.

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Serializes this object.

Throws:

IOException

getDocid

public String getDocid()

Returns the article title (i.e., the docid).

Specified by:

getDocid in class Indexable

Returns:

docid of the document

setLanguage

@Deprecated
public void setLanguage(String language)

Deprecated.

getLanguage

public String getLanguage()

getContent

public String getContent()

Returns the contents of this page (title + text).

Specified by:

getContent in class Indexable

Returns:

content of the document

getDisplayContent

public String getDisplayContent()

Description copied from class: Indexable

Returns the content of the document for display to a human.

Overrides:

getDisplayContent in class Indexable

Returns:

displayable content

getDisplayContentType

public String getDisplayContentType()

Description copied from class: Indexable

Returns the type of the display content, per IANA MIME Media Type (e.g., "text/html"). See http://www.iana.org/assignments/media-types/index.html

Overrides:

getDisplayContentType in class Indexable

Returns:

IANA MIME Media Type

getRawXML

public String getRawXML()

Returns the raw XML of this page.

getWikiMarkup

public String getWikiMarkup()

Returns the text of this page.

getTitle

public String getTitle()

Returns the title of this page.

isDisambiguation

public boolean isDisambiguation()

Checks to see if this page is a disambiguation page. A WikipediaPage is either an article, a disambiguation page, a redirect page, or an empty page.

Returns:

true if this page is a disambiguation page

isRedirect

public boolean isRedirect()

Checks to see if this page is a redirect page. A WikipediaPage is either an article, a disambiguation page, a redirect page, or an empty page.

Returns:

true if this page is a redirect page

isEmpty

public boolean isEmpty()

Checks to see if this page is an empty page. A WikipediaPage is either an article, a disambiguation page, a redirect page, or an empty page.

Returns:

true if this page is an empty page

isStub

public boolean isStub()

Checks to see if this article is a stub. Return value is only meaningful if this page isn't a disambiguation page, a redirect page, or an empty page.

Returns:

true if this article is a stub

isArticle

public boolean isArticle()

Checks to see if this page lives in the main/article namespace, and not, for example, "File:", "Category:", "Wikipedia:", etc.

Returns:

true if this page is an actual article

findInterlanguageLink

public String findInterlanguageLink(String lang)

Returns the inter-language link to a specific language (if any).

Parameters:

lang - language

Returns:

title of the article in the foreign language if link exists, null otherwise

extractLinks

public List<WikipediaPage.Link> extractLinks()

extractLinkTargets

public List<String> extractLinkTargets()

readPage

public static void readPage(WikipediaPage page,
                            String s)

Reads a raw XML string into a WikipediaPage object.

Parameters:

page - the WikipediaPage object

s - raw XML string