com.github.agadar.nationstates.query

Class CensusRankQuery<Q extends CensusRankQuery,R,S extends Shard>

java.lang.Object

com.github.agadar.nationstates.query.AbstractQuery<Q,R>

com.github.agadar.nationstates.query.APIQuery<Q,R>

com.github.agadar.nationstates.query.ShardQuery<Q,R,S>

com.github.agadar.nationstates.query.CensusQuery<Q,R,S>

com.github.agadar.nationstates.query.CensusRankQuery<Q,R,S>

Type Parameters:

Q - the child class that extends this abstract class

R - the type the child class' execute()-function returns

S - the shard type the child class accepts

Direct Known Subclasses:

RegionQuery, WorldQuery

public abstract class CensusRankQuery<Q extends CensusRankQuery,R,S extends Shard>
extends CensusQuery<Q,R,S>

Intermediate parent class that adds options for census ranks.

Author:

Agadar (https://github.com/Agadar/)

Field Summary

Fields inherited from class com.github.agadar.nationstates.query.ShardQuery

shards

Fields inherited from class com.github.agadar.nationstates.query.APIQuery

generalRateLimiter, resourceValue

Fields inherited from class com.github.agadar.nationstates.query.AbstractQuery

userAgent

Constructor Summary

Constructors

Constructor and Description
CensusRankQuery(IXmlConverter xmlConverter, IRateLimiter generalRateLimiter, IRateLimiter scrapingRateLimiter, String baseUrl, String userAgent, int apiVersion, String resourceValue) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildURL() Generates a String URL based on the supplied values.
Q	censusRanksStart(int rank) Sets a rank to start the retrieved census rank scores list from.

Methods inherited from class com.github.agadar.nationstates.query.CensusQuery

censusHistoryFrom, censusHistoryTo, censusIds, censusModes

Methods inherited from class com.github.agadar.nationstates.query.ShardQuery

shards

Methods inherited from class com.github.agadar.nationstates.query.APIQuery

execute, getRateLimiter, resourceString, slowMode, validateQueryParameters

Methods inherited from class com.github.agadar.nationstates.query.AbstractQuery

closeInputStreamQuietly, execute, makeRequest, translateResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

CensusRankQuery

public CensusRankQuery(IXmlConverter xmlConverter,
                       IRateLimiter generalRateLimiter,
                       IRateLimiter scrapingRateLimiter,
                       String baseUrl,
                       String userAgent,
                       int apiVersion,
                       String resourceValue)

Constructor. Sets the resource value, e.g. the nation's or region's name.

Parameters:

xmlConverter -

generalRateLimiter -

scrapingRateLimiter -

baseUrl -

userAgent -

apiVersion -

resourceValue - the resource value

Method Detail

censusRanksStart

public final Q censusRanksStart(int rank)

Sets a rank to start the retrieved census rank scores list from. Does nothing if the CensusRanks shard is not selected.

Parameters:

rank - the rank to start the retrieved census rank scores list from

Returns:

this

buildURL

protected String buildURL()

Description copied from class: AbstractQuery

Generates a String URL based on the supplied values. Subclasses might want to override this method to build the String URL further to accommodate for additional shards/modes/options/etc.

Overrides:

buildURL in class CensusQuery<Q extends CensusRankQuery,R,S extends Shard>

Returns:

the generated String URL