com.github.agadar.nationstates.query

Class RegionQuery

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<RegionQuery,Region,RegionShard>

com.github.agadar.nationstates.query.RegionQuery

public final class RegionQuery
extends CensusRankQuery<RegionQuery,Region,RegionShard>

A query to the NationStates API's region resource.

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
RegionQuery(IXmlConverter xmlConverter, IRateLimiter generalRateLimiter, IRateLimiter scrapingRateLimiter, String baseUrl, String userAgent, int apiVersion, String regionName) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildURL() Generates a String URL based on the supplied values.
RegionQuery	messagesFromId(long id) Sets the id of the post to start from.
RegionQuery	messagesLimit(int limit) Sets the maximum number of posts to retrieve, or the maximum number of results to return for MostLiked, MostLikes, or MostPosts to retrieve.
RegionQuery	messagesOffset(int offset) Sets the offset for the 10 most recent regional messages.
RegionQuery	postsFrom(long postsFrom) Sets the earliest epoch date of messages to take into account for MostPosts, MostLiked, and MostLikes shards.
RegionQuery	postsTo(long postsTo) Sets the latest epoch date of messages to take into account for MostPosts, MostLiked, and MostLikes shards.
protected String	resourceString() Gives the resource string of this Query, e.g.
protected void	validateQueryParameters() Validates the query parameters before executing the query.

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

censusRanksStart

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, slowMode

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

RegionQuery

public RegionQuery(IXmlConverter xmlConverter,
                   IRateLimiter generalRateLimiter,
                   IRateLimiter scrapingRateLimiter,
                   String baseUrl,
                   String userAgent,
                   int apiVersion,
                   String regionName)

Constructor. Sets the name of the region to query.

Parameters:

xmlConverter -

generalRateLimiter -

scrapingRateLimiter -

baseUrl -

userAgent -

apiVersion -

regionName - name of the region to query

Method Detail

messagesOffset

public final RegionQuery messagesOffset(int offset)

Sets the offset for the 10 most recent regional messages. Does nothing if the RegionalMessages shard is not selected.

Parameters:

offset - the offset for the 10 most recent regional messages

Returns:

this

messagesFromId

public final RegionQuery messagesFromId(long id)

Sets the id of the post to start from. Does nothing if the RegionalMessages shard is not selected.

Parameters:

id - the id of the post to start from

Returns:

this

messagesLimit

public final RegionQuery messagesLimit(int limit)

Sets the maximum number of posts to retrieve, or the maximum number of results to return for MostLiked, MostLikes, or MostPosts to retrieve. Does nothing if the RegionalMessages, MostLiked, MostLikes, or MostPosts shard is not selected.

Parameters:

limit - maximum number of posts or results to retrieve

Returns:

this

postsFrom

public final RegionQuery postsFrom(long postsFrom)

Sets the earliest epoch date of messages to take into account for MostPosts, MostLiked, and MostLikes shards.

Parameters:

postsFrom - earliest epoch date of messages to take into account

Returns:

this

postsTo

public final RegionQuery postsTo(long postsTo)

Sets the latest epoch date of messages to take into account for MostPosts, MostLiked, and MostLikes shards.

Parameters:

postsTo - latest epoch date of messages to take into account

Returns:

this

resourceString

protected String resourceString()

Description copied from class: APIQuery

Gives the resource string of this Query, e.g. 'nation', 'region', etc.

Specified by:

resourceString in class APIQuery<RegionQuery,Region>

Returns:

the resource string of this Query

validateQueryParameters

protected void validateQueryParameters()

Description copied from class: AbstractQuery

Validates the query parameters before executing the query. If the query parameters are invalid, an exception is thrown. Child classes will want to override this class (making sure to still call super.validateQueryParameters()) if they have additional parameters to validate.

Overrides:

validateQueryParameters in class APIQuery<RegionQuery,Region>

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 CensusRankQuery<RegionQuery,Region,RegionShard>

Returns:

the generated String URL