net.sourceforge.jwbf.mediawiki.actions.queries

Class CategoryMembersFull

java.lang.Object

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

net.sourceforge.jwbf.mediawiki.actions.queries.CategoryMembersFull

All Implemented Interfaces:

Iterable<CategoryItem>, Iterator<CategoryItem>, ContentProcessable, ReturningText

public class CategoryMembersFull
extends MWAction
implements Iterable<CategoryItem>, Iterator<CategoryItem>

A specialization of CategoryMembers with contains CategoryItems.

Author:

Thomas Stock

Field Summary

Fields

Modifier and Type	Field and Description
protected MediaWikiBot	bot
protected String	categoryName Name of the category.
protected boolean	hasMoreResults
protected boolean	init
protected static int	LIMIT constant value for the bllimit-parameter.
protected int[]	namespace
protected String	nextPageInfo information necessary to get the next api page.
protected net.sourceforge.jwbf.mediawiki.actions.queries.CategoryMembers.RequestGenerator	requestBuilder

Constructor Summary

Constructors

Constructor and Description
CategoryMembersFull(MediaWikiBot bot, String categoryName, int... namespaces) on any kind of http or version problems on inner problems like a version mismatch

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCatItem(String title, int pageid, int ns)
protected Object	clone()
protected void	finalizeParse()
protected Get	generateContinueRequest(String cmcontinue) generates the next MediaWiki-request (GetMethod) and adds it to msgs.
protected Get	generateFirstRequest() generates the next MediaWiki-request (GetMethod) and adds it to msgs.
HttpAction	getNextMessage()
boolean	hasNext()
Iterator<CategoryItem>	iterator()
CategoryItem	next()
String	processAllReturningText(String s) deals with the MediaWiki api's response by parsing the provided text.
void	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

Field Detail

LIMIT

protected static final int LIMIT

constant value for the bllimit-parameter.

See Also:

Constant Field Values

bot

protected final MediaWikiBot bot

nextPageInfo

protected String nextPageInfo

information necessary to get the next api page.

hasMoreResults

protected boolean hasMoreResults

init

protected boolean init

categoryName

protected final String categoryName

Name of the category.

requestBuilder

protected net.sourceforge.jwbf.mediawiki.actions.queries.CategoryMembers.RequestGenerator requestBuilder

namespace

protected final int[] namespace

Constructor Detail

CategoryMembersFull

public CategoryMembersFull(MediaWikiBot bot,
                   String categoryName,
                   int... namespaces)

on any kind of http or version problems on inner problems like a version mismatch

Method Detail

addCatItem

protected void addCatItem(String title,
              int pageid,
              int ns)

getNextMessage

public HttpAction getNextMessage()

Specified by:

getNextMessage in interface ContentProcessable

Returns:

the of messages in this action

iterator

public Iterator<CategoryItem> iterator()

Specified by:

iterator in interface Iterable<CategoryItem>

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

processAllReturningText

public String processAllReturningText(String s)

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

Parameters:

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

Returns:

empty string

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<CategoryItem>

next

public CategoryItem next()

Specified by:

next in interface Iterator<CategoryItem>

remove

public void remove()

Specified by:

remove in interface Iterator<CategoryItem>

finalizeParse

protected void finalizeParse()

generateFirstRequest

protected final Get generateFirstRequest()

generates the next MediaWiki-request (GetMethod) and adds it to msgs.

Returns:

a

generateContinueRequest

protected final Get generateContinueRequest(String cmcontinue)

generates the next MediaWiki-request (GetMethod) and adds it to msgs.

Parameters:

cmcontinue - the value for the blcontinue parameter, null for the generation of the initial request

Returns:

a