net.sourceforge.jwbf.mediawiki.actions.queries

Class AllPageTitles

java.lang.Object

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

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

net.sourceforge.jwbf.mediawiki.actions.queries.AllPageTitles

All Implemented Interfaces:

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

public class AllPageTitles
extends TitleQuery<String>

Action class using the MediaWiki-api's "list=allpages".

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

Modifier	Constructor and Description
	AllPageTitles(MediaWikiBot bot, int... namespaces)
	AllPageTitles(MediaWikiBot bot, String from, String prefix, RedirectFilter rf, int... namespaces) The public constructor.
protected	AllPageTitles(MediaWikiBot bot, String from, String prefix, RedirectFilter rf, String namespaces)

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

AllPageTitles

public AllPageTitles(MediaWikiBot bot,
             String from,
             String prefix,
             RedirectFilter rf,
             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).

Parameters:

from - page title to start from, may be null

prefix - restricts search to titles that begin with this value, may be null

rf - include redirects in the list

namespaces - the namespace(s) that will be searched for links, as a string of numbers separated by '|'; if null, this parameter is omitted TODO are multible namespaces allowed?

AllPageTitles

public AllPageTitles(MediaWikiBot bot,
             int... namespaces)

AllPageTitles

protected AllPageTitles(MediaWikiBot bot,
             String from,
             String prefix,
             RedirectFilter rf,
             String namespaces)

Method Detail

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

Returns:

a

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. If no exists, the string is empty.

Specified by:

parseHasMore in class TitleQuery<String>

Parameters:

s - text for parsing

Returns:

the

prepareCollection

protected HttpAction prepareCollection()

Specified by:

prepareCollection in class TitleQuery<String>

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException