com.github.agadar.nsapi.query.blueprint

Class DailyDumpQuery<Q extends DailyDumpQuery,R>

java.lang.Object

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

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

Type Parameters:

Q - the child class that extends this abstract class

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

Direct Known Subclasses:

NationDumpQuery, RegionDumpQuery

public abstract class DailyDumpQuery<Q extends DailyDumpQuery,R>
extends AbstractQuery<Q,R>

Query for retrieving daily dumps from NationStates.

Author:

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

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
DailyDumpQuery(DailyDumpMode mode) Constructor, accepting a mode.

Method Summary

Modifier and Type	Method and Description
protected String	buildURL() Generates a String URL based on the supplied values.
Q	downloadDir(String dir) Sets a specific directory to download the gzip file in, which will be used instead of the default directory.
<T extends R> T	execute(Class<T> type) Executes this query, returning any result.
protected abstract String	getFileName() Gives the file name to use.
Q	readFromDir(String dir) Sets a specific directory to read the gzip file from, which will be used instead of the default directory.
protected <T extends R> T	translateResponse(InputStream response, Class<T> type) Translates the stream response to the object this Query wishes to return via its execute() function.
protected void	validateQueryParameters() Validates the query parameters before executing the query.

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

closeInputStreamQuietly, execute, makeRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

DailyDumpQuery

public DailyDumpQuery(DailyDumpMode mode)

Constructor, accepting a mode.

Parameters:

mode - the daily dump mode to use

Method Detail

downloadDir

public final Q downloadDir(String dir)

Sets a specific directory to download the gzip file in, which will be used instead of the default directory.

Parameters:

dir - a specific directory to download the gzip in

Returns:

this

readFromDir

public final Q readFromDir(String dir)

Sets a specific directory to read the gzip file from, which will be used instead of the default directory.

Parameters:

dir - a specific directory to download the gzip in

Returns:

this

getFileName

protected abstract String getFileName()

Gives the file name to use. Daily regions dump is 'regions.xml.gz', daily nations dump is 'nations.xml.gz'.

Returns:

the file name to use

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 AbstractQuery<Q extends DailyDumpQuery,R>

Returns:

the generated String URL

translateResponse

protected <T extends R> T translateResponse(InputStream response,
                                            Class<T> type)

Description copied from class: AbstractQuery

Translates the stream response to the object this Query wishes to return via its execute() function. The standard way to translate is via JAXB, which assumes the stream is in a valid XML-format. Child classes might want to override this function if they wish to return primitives or something else.

Overrides:

translateResponse in class AbstractQuery<Q extends DailyDumpQuery,R>

Type Parameters:

T - type to parse to

Parameters:

response - the response to translate

type - type to parse to

Returns:

the translated response

execute

public <T extends R> T execute(Class<T> type)

Description copied from class: AbstractQuery

Executes this query, returning any result. Child classes may want to override this if they want to use rate limiters and such.

Overrides:

execute in class AbstractQuery<Q extends DailyDumpQuery,R>

Type Parameters:

T - the type to return

Parameters:

type - the type to return

Returns:

the result, of the given type

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 AbstractQuery<Q extends DailyDumpQuery,R>