net.sourceforge.jwbf.mediawiki.actions.queries

Class BacklinkTitles

java.lang.Object

net.sourceforge.jwbf.mediawiki.actions.util.MWAction

net.sourceforge.jwbf.mediawiki.actions.queries.TitleQuery<String>

net.sourceforge.jwbf.mediawiki.actions.queries.BacklinkTitles

All Implemented Interfaces:

Iterable<String>, Iterator<String>, ContentProcessable, ReturningText

public class BacklinkTitles
extends TitleQuery<String>

action class using the MediaWiki-api's "list=backlinks".

Since:

JWBF 1.1

Author:

Thomas Stock, Tobias Knerr

Nested Class Summary

Nested classes/interfaces inherited from class net.sourceforge.jwbf.mediawiki.actions.queries.TitleQuery

TitleQuery.InnerAction

Field Summary

Fields inherited from class net.sourceforge.jwbf.mediawiki.actions.queries.TitleQuery

nextPageInfo, titleIterator

Constructor Summary

Constructors

Constructor and Description
BacklinkTitles(MediaWikiBot bot, String articleName)
BacklinkTitles(MediaWikiBot bot, String articleName, RedirectFilter redirectFilter, int... namespaces) The public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	clone()
protected Collection<String>	parseArticleTitles(String s) picks the article name from a MediaWiki api response.
protected String	parseHasMore(String s) gets the information about a follow-up page from a provided api response.
protected HttpAction	prepareCollection()

Methods inherited from class net.sourceforge.jwbf.mediawiki.actions.queries.TitleQuery

getInnerAction, getNextMessage, getNextPageInfo, hasNext, iterator, next, remove

Methods inherited from class net.sourceforge.jwbf.mediawiki.actions.util.MWAction

createNsString, evaluateXpath, getErrorElement, getRootElement, getRootElementWithError, hasMoreMessages, isSelfExecuter, processAllReturningText, processReturningText, setExceptionHandler, setHasMoreMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

BacklinkTitles

public BacklinkTitles(MediaWikiBot bot,
              String articleName,
              RedirectFilter redirectFilter,
              int... namespaces)

The public constructor. It will have a MediaWiki-request generated, which is then added to msgs. When it is answered, the method processAllReturningText will be called (from outside this class).

Parameters:

articleName - the title of the article, != null

namespaces - the namespace(s) that will be searched for links, as a string of numbers separated by '|'; if null, this parameter is omitted. See for e.g. MediaWiki.NS_ALL.

redirectFilter - filter that determines how to handle redirects, must be all for MW versions before 1.11; != null

BacklinkTitles

public BacklinkTitles(MediaWikiBot bot,
              String articleName)

Method Detail

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

parseHasMore

protected String parseHasMore(String s)

gets the information about a follow-up page from a provided api response. If there is one, the information for the next page parameter is added to the nextPageInfo field.

Specified by:

parseHasMore in class TitleQuery<String>

Parameters:

s - text for parsing

parseArticleTitles

protected Collection<String> parseArticleTitles(String s)

picks the article name from a MediaWiki api response.

Specified by:

parseArticleTitles in class TitleQuery<String>

Parameters:

s - text for parsing

prepareCollection

protected HttpAction prepareCollection()

Specified by:

prepareCollection in class TitleQuery<String>