net.sourceforge.jwbf.mediawiki.actions.queries

Class TemplateUserTitles

java.lang.Object

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

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

net.sourceforge.jwbf.mediawiki.actions.queries.TemplateUserTitles

All Implemented Interfaces:

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

public class TemplateUserTitles
extends TitleQuery<String>

action class using the MediaWiki-api's "list=embeddedin" that is used to find all articles which use a template.

Since:

MediaWiki 1.9.0

Author:

Tobias Knerr, Thomas Stock

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
TemplateUserTitles(MediaWikiBot bot, String templateName, 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()
String	processAllReturningText(String s) deals with the MediaWiki api's response by parsing the provided text.

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, processReturningText, setExceptionHandler, setHasMoreMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateUserTitles

public TemplateUserTitles(MediaWikiBot bot,
                  String templateName,
                  int... namespaces)

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

Method Detail

processAllReturningText

public String processAllReturningText(String s)

deals with the MediaWiki api's response by parsing the provided text.

Overrides:

processAllReturningText in class MWAction

Parameters:

s - the answer to the most recently generated MediaWiki-request

Returns:

empty string

parseHasMore

protected String parseHasMore(String s)

gets the information about a follow-up page from a provided api response. If there is one, a new request is added to msgs by calling generateRequest.

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>

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException