com.github.agadar.nsapi.query

Class WorldQuery

java.lang.Object

com.github.agadar.nsapi.query.blueprint.AbstractQuery<Q,R>

com.github.agadar.nsapi.query.blueprint.APIQuery<Q,R>

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

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

com.github.agadar.nsapi.query.blueprint.CensusRankQuery<WorldQuery,World,WorldShard>

com.github.agadar.nsapi.query.WorldQuery

public final class WorldQuery
extends CensusRankQuery<WorldQuery,World,WorldShard>

A query to the NationStates API's world resource.

Author:

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

Field Summary

Fields inherited from class com.github.agadar.nsapi.query.blueprint.ShardQuery

shards

Fields inherited from class com.github.agadar.nsapi.query.blueprint.APIQuery

rateLimiter, resourceValue

Fields inherited from class com.github.agadar.nsapi.query.blueprint.AbstractQuery

logger

Constructor Summary

Constructors

Constructor and Description
WorldQuery(WorldShard... shards) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildURL() Generates a String URL based on the supplied values.
WorldQuery	dispatchAuthor(String nation) Sets the author to list dispatches of.
WorldQuery	dispatchCategory(DispatchCat category) Sets the category to list dispatches of.
WorldQuery	dispatchGetBest() Sets the type to list dispatches of to 'best', as opposed to the default 'new'.
WorldQuery	dispatchId(int dispatchId) Sets the id of the dispatch to select.
WorldQuery	dispatchSubcategory(DispatchSubCat subcategory) Sets the subcategory to list dispatches of.
WorldQuery	happeningsBeforeId(int id) If this is set, only happenings with a lower id than the one supplied will be retrieved.
WorldQuery	happeningsFilter(HapFilter... filters) Sets the filters for happenings.
WorldQuery	happeningsLimit(int limit) Sets the maximum number of happenings to retrieve.
WorldQuery	happeningsOfNation(String... nation) Sets the nation(s) to view happenings of.
WorldQuery	happeningsOfRegion(String... region) Sets the region(s) to view happenings of.
WorldQuery	happeningsSinceId(int id) If this is set, only happenings with a higher id than the one supplied will be retrieved.
WorldQuery	regionsWithoutTags(String... tags) Sets the tags, used for retrieving regions that do NOT have those tags.
WorldQuery	regionsWithTags(String... tags) Sets the tags, used for retrieving regions that have those tags.
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.nsapi.query.blueprint.CensusRankQuery

censusRanksStart

Methods inherited from class com.github.agadar.nsapi.query.blueprint.CensusQuery

censusHistoryFrom, censusHistoryTo, censusIds, censusIds, censusModes

Methods inherited from class com.github.agadar.nsapi.query.blueprint.ShardQuery

shards

Methods inherited from class com.github.agadar.nsapi.query.blueprint.APIQuery

execute, getRateLimiter, slowMode

Methods inherited from class com.github.agadar.nsapi.query.blueprint.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

WorldQuery

public WorldQuery(WorldShard... shards)

Constructor. Accepts one or more shards.

Parameters:

shards - the shards to select

Method Detail

dispatchAuthor

public final WorldQuery dispatchAuthor(String nation)

Sets the author to list dispatches of. Does nothing if Dispatches shard is not selected.

Parameters:

nation - the author to list dispatches of

Returns:

this

dispatchCategory

public final WorldQuery dispatchCategory(DispatchCat category)

Sets the category to list dispatches of. Does nothing if Dispatches shard is not selected.

Parameters:

category - the category to list dispatches of

Returns:

this

dispatchSubcategory

public final WorldQuery dispatchSubcategory(DispatchSubCat subcategory)

Sets the subcategory to list dispatches of. Does nothing if Dispatches shard is not selected or category is not set.

Parameters:

subcategory - the subcategory to list dispatches of

Returns:

this

dispatchGetBest

public final WorldQuery dispatchGetBest()

Sets the type to list dispatches of to 'best', as opposed to the default 'new'. Does nothing if Dispatches shard is not selected.

Returns:

this

dispatchId

public final WorldQuery dispatchId(int dispatchId)

Sets the id of the dispatch to select. Does nothing if SelectedDispatch shard is not selected.

Parameters:

dispatchId - id of the dispatch to select.

Returns:

this

regionsWithTags

public final WorldQuery regionsWithTags(String... tags)

Sets the tags, used for retrieving regions that have those tags. Does nothing if the RegionsByTag shard is not selected.

Parameters:

tags - the tags

Returns:

this

regionsWithoutTags

public final WorldQuery regionsWithoutTags(String... tags)

Sets the tags, used for retrieving regions that do NOT have those tags. Does nothing if the RegionsByTag shard is not selected.

Parameters:

tags - the tags

Returns:

this

happeningsOfNation

public final WorldQuery happeningsOfNation(String... nation)

Sets the nation(s) to view happenings of. Does nothing if the Happenings shard is not selected.

Parameters:

nation - the nation(s) to view happenings of

Returns:

this

happeningsOfRegion

public final WorldQuery happeningsOfRegion(String... region)

Sets the region(s) to view happenings of. Does nothing if the Happenings shard is not selected.

Parameters:

region - the region(s) to view happenings of

Returns:

this

happeningsFilter

public final WorldQuery happeningsFilter(HapFilter... filters)

Sets the filters for happenings. Does nothing if the Happenings shard is not selected.

Parameters:

filters - the filters for happenings

Returns:

this

happeningsLimit

public final WorldQuery happeningsLimit(int limit)

Sets the maximum number of happenings to retrieve. Does nothing if the Happenings shard is not selected.

Parameters:

limit - the maximum number of happenings to retrieve

Returns:

this

happeningsSinceId

public final WorldQuery happeningsSinceId(int id)

If this is set, only happenings with a higher id than the one supplied will be retrieved.

Parameters:

id - the id

Returns:

this

happeningsBeforeId

public final WorldQuery happeningsBeforeId(int id)

If this is set, only happenings with a lower id than the one supplied will be retrieved.

Parameters:

id - the id

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<WorldQuery,World>

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<WorldQuery,World>

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<WorldQuery,World,WorldShard>

Returns:

the generated String URL