WikipediaPage (Cloud9 2.0.1 API)

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

All Implemented Interfaces:

org.apache.hadoop.io.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

Nested Classes
Modifier and Type Class and Description

static class WikipediaPage.Link

Nested Classes
Modifier and Type	Class and Description
`static class`	`WikipediaPage.Link`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`isArticle`
`protected boolean`	`isDisambig`
`protected boolean`	`isRedirect`
`protected boolean`	`isStub`
`protected String`	`language`
`protected String`	`mId`
`protected String`	`page`
`protected int`	`textEnd`
`protected int`	`textStart`
`protected String`	`title`
`static String`	`XML_END_TAG` End delimiter of the page, which is <`/page`>.
`protected static String`	`XML_END_TAG_ID` End delimiter of the id, which is <`/id`>.
`protected static String`	`XML_END_TAG_NAMESPACE` End delimiter of the namespace, which is <`/ns`>.
`protected static String`	`XML_END_TAG_TEXT` End delimiter of the text, which is <`/text`>.
`protected static String`	`XML_END_TAG_TITLE` End delimiter of the title, which is <`/title`>.
`static String`	`XML_START_TAG` Start delimiter of the page, which is <`page`>.
`protected static String`	`XML_START_TAG_ID` Start delimiter of the id, which is <`id`>.
`protected static String`	`XML_START_TAG_NAMESPACE` Start delimiter of the namespace, which is <`ns`>.
`protected static String`	`XML_START_TAG_TEXT` Start delimiter of the text, which is <`text xml:space=\"preserve\"`>.
`protected static String`	`XML_START_TAG_TITLE` Start delimiter of the title, which is <`title`>.

Constructor Summary

Constructors
Constructor and Description

WikipediaPage()
Creates an empty WikipediaPage object.

Constructors
Constructor and Description
`WikipediaPage()` Creates an empty `WikipediaPage` object.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`protected abstract void`	`processPage(String s)` Reads a raw XML string into a `WikipediaPage` object.
`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
clone, equals, finalize, 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
  - XML_START_TAG_TITLE
```
protected static final String XML_START_TAG_TITLE
```
    Start delimiter of the title, which is <title>.
    
    See Also:
    Constant Field Values
  - XML_END_TAG_TITLE
```
protected static final String XML_END_TAG_TITLE
```
    End delimiter of the title, which is </title>.
    
    See Also:
    Constant Field Values
  - XML_START_TAG_NAMESPACE
```
protected static final String XML_START_TAG_NAMESPACE
```
    Start delimiter of the namespace, which is <ns>.
    
    See Also:
    Constant Field Values
  - XML_END_TAG_NAMESPACE
```
protected static final String XML_END_TAG_NAMESPACE
```
    End delimiter of the namespace, which is </ns>.
    
    See Also:
    Constant Field Values
  - XML_START_TAG_ID
```
protected static final String XML_START_TAG_ID
```
    Start delimiter of the id, which is <id>.
    
    See Also:
    Constant Field Values
  - XML_END_TAG_ID
```
protected static final String XML_END_TAG_ID
```
    End delimiter of the id, which is </id>.
    
    See Also:
    Constant Field Values
  - XML_START_TAG_TEXT
```
protected static final String XML_START_TAG_TEXT
```
    Start delimiter of the text, which is <text xml:space=\"preserve\">.
    
    See Also:
    Constant Field Values
  - XML_END_TAG_TEXT
```
protected static final String XML_END_TAG_TEXT
```
    End delimiter of the text, which is </text>.
    
    See Also:
    Constant Field Values
  - page
```
protected String page
```
  - title
```
protected String title
```
  - mId
```
protected String mId
```
  - textStart
```
protected int textStart
```
  - textEnd
```
protected int textEnd
```
  - isRedirect
```
protected boolean isRedirect
```
  - isDisambig
```
protected boolean isDisambig
```
  - isStub
```
protected boolean isStub
```
  - isArticle
```
protected boolean isArticle
```
  - language
```
protected String language
```
- 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
  - processPage
```
protected abstract void processPage(String s)
```
    Reads a raw XML string into a WikipediaPage object. Added for backwards compability.
    
    Parameters:
    s - raw XML string

Class WikipediaPage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XML_START_TAG

XML_END_TAG

XML_START_TAG_TITLE

XML_END_TAG_TITLE

XML_START_TAG_NAMESPACE

XML_END_TAG_NAMESPACE

XML_START_TAG_ID

XML_END_TAG_ID

XML_START_TAG_TEXT

XML_END_TAG_TEXT

page

title

mId

textStart

textEnd

isRedirect

isDisambig

isStub

isArticle

language

Constructor Detail

WikipediaPage

Method Detail

write

readFields

getDocid

setLanguage

getLanguage

getContent

getDisplayContent

getDisplayContentType

getRawXML

getWikiMarkup

getTitle

isDisambiguation

isRedirect

isEmpty

isStub

isArticle

findInterlanguageLink

extractLinks

extractLinkTargets

readPage

processPage