in.srain.cube.request

Class CacheAbleRequest<T>

java.lang.Object

in.srain.cube.request.RequestBase<T>

in.srain.cube.request.CacheAbleRequest<T>

All Implemented Interfaces:

ICacheAble<T>, ICacheAbleRequest<T>, IRequest<T>

public class CacheAbleRequest<T>
extends RequestBase<T>
implements ICacheAbleRequest<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CacheAbleRequest.ResultType

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEBUG
protected static java.lang.String	LOG_TAG
protected boolean	mForceQueryFromServer

Constructor Summary

Constructors

Constructor and Description
CacheAbleRequest()
CacheAbleRequest(CacheAbleRequestHandler<T> handler)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cacheIsDisabled() check if cache is disabled
protected boolean	cacheRequestResult()
protected void	doQueryFromServer()
protected T	doRequestSync() Timeout will not be considerate
void	doSendRequest() implement this method to process request data
void	forceQueryFromServer(boolean force)
java.lang.String	getAssertInitDataPath()
java.lang.String	getCacheKey()
long	getCacheTime() In seconds
void	onCacheData(CacheResultType cacheResultType, T data, boolean outOfDate) when data loaded from cache
T	onDataFromServer(java.lang.String data)
void	onNoCacheData(CacheManager cacheManager) When there is no cache data is available, this method will be called.
void	onRequestFail(FailData failData)
void	onRequestSuccess(T data)
protected void	prepareRequest() prepare request
T	processOriginDataFromServer(JsonData rawData) filter the origin data or convert its structure.
T	processRawDataFromCache(JsonData rawData) We need to process the data from data source, do some filter of convert the structure.
CacheAbleRequest<T>	setAssertInitDataPath(java.lang.String path)
void	setCacheAbleRequestHandler(CacheAbleRequestHandler<T> handler)
CacheAbleRequest<T>	setCacheKey(java.lang.String cacheKey)
CacheAbleRequest<T>	setCacheTime(long time) set cache time, in seconds
CacheAbleRequest<T>	setDisableCache(boolean disable) temporarily disable cache.
void	setTimeout(int timeOut) set a timeout, when request time over this value, cache data will be used.
CacheAbleRequest<T>	setUseCacheAnyway(boolean use) Using cache data if existent, ignore whether it is expired or not.
boolean	useCacheAnyway() check if use cache anyway

Methods inherited from class in.srain.cube.request.RequestBase

cancelRequest, getFailData, getRequestData, hasBeenCanceled, onCancel, requestSync, send, setFailData

Methods inherited from class java.lang.Object

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

Methods inherited from interface in.srain.cube.request.IRequest

cancelRequest, getFailData, getRequestData, requestSync, send, setFailData

Field Detail

DEBUG

protected static final boolean DEBUG

LOG_TAG

protected static final java.lang.String LOG_TAG

See Also:

Constant Field Values

mForceQueryFromServer

protected boolean mForceQueryFromServer

Constructor Detail

CacheAbleRequest

public CacheAbleRequest()

CacheAbleRequest

public CacheAbleRequest(CacheAbleRequestHandler<T> handler)

Method Detail

setCacheAbleRequestHandler

public void setCacheAbleRequestHandler(CacheAbleRequestHandler<T> handler)

forceQueryFromServer

public void forceQueryFromServer(boolean force)

doSendRequest

public void doSendRequest()

Description copied from class: RequestBase

implement this method to process request data

Specified by:

doSendRequest in class RequestBase<T>

doRequestSync

protected T doRequestSync()

Timeout will not be considerate

Specified by:

doRequestSync in class RequestBase<T>

Returns:

prepareRequest

protected void prepareRequest()

prepare request

Specified by:

prepareRequest in class RequestBase<T>

setTimeout

public void setTimeout(int timeOut)

Description copied from interface: ICacheAbleRequest

set a timeout, when request time over this value, cache data will be used.

Specified by:

setTimeout in interface ICacheAbleRequest<T>

setUseCacheAnyway

public CacheAbleRequest<T> setUseCacheAnyway(boolean use)

Description copied from interface: ICacheAble

Using cache data if existent, ignore whether it is expired or not.

Specified by:

setUseCacheAnyway in interface ICacheAble<T>

useCacheAnyway

public boolean useCacheAnyway()

Description copied from interface: ICacheAble

check if use cache anyway

Specified by:

useCacheAnyway in interface ICacheAble<T>

Returns:

onRequestSuccess

public void onRequestSuccess(T data)

Specified by:

onRequestSuccess in interface IRequest<T>

onRequestFail

public void onRequestFail(FailData failData)

Specified by:

onRequestFail in interface IRequest<T>

onNoCacheData

public void onNoCacheData(CacheManager cacheManager)

Description copied from interface: ICacheAble

When there is no cache data is available, this method will be called. Will always in Main UI thread

Specified by:

onNoCacheData in interface ICacheAble<T>

doQueryFromServer

protected void doQueryFromServer()

cacheRequestResult

protected boolean cacheRequestResult()

cacheIsDisabled

public boolean cacheIsDisabled()

Description copied from interface: ICacheAble

check if cache is disabled

Specified by:

cacheIsDisabled in interface ICacheAble<T>

Returns:

onCacheData

public void onCacheData(CacheResultType cacheResultType,
               T data,
               boolean outOfDate)

Description copied from interface: ICacheAble

when data loaded from cache

Specified by:

onCacheData in interface ICacheAble<T>

getCacheTime

public long getCacheTime()

Description copied from interface: ICacheAble

In seconds

Specified by:

getCacheTime in interface ICacheAble<T>

Returns:

getCacheKey

public java.lang.String getCacheKey()

Specified by:

getCacheKey in interface ICacheAble<T>

getAssertInitDataPath

public java.lang.String getAssertInitDataPath()

Specified by:

getAssertInitDataPath in interface ICacheAble<T>

Returns:

file path under /res, For example: "/cache_init/test.json";

onDataFromServer

public T onDataFromServer(java.lang.String data)

Specified by:

onDataFromServer in interface IRequest<T>

Overrides:

onDataFromServer in class RequestBase<T>

processOriginDataFromServer

public T processOriginDataFromServer(JsonData rawData)

Description copied from interface: IRequest

filter the origin data or convert its structure.

Specified by:

processOriginDataFromServer in interface IRequest<T>

Returns:

processRawDataFromCache

public T processRawDataFromCache(JsonData rawData)

Description copied from interface: ICacheAble

We need to process the data from data source, do some filter of convert the structure.

As the "Assert Data" is a special data source, we also need to do the same work.

Specified by:

processRawDataFromCache in interface ICacheAble<T>

setCacheKey

public CacheAbleRequest<T> setCacheKey(java.lang.String cacheKey)

Specified by:

setCacheKey in interface ICacheAble<T>

setDisableCache

public CacheAbleRequest<T> setDisableCache(boolean disable)

Description copied from interface: ICacheAble

temporarily disable cache. The data will no be load from cache and will also not be put into cache

Specified by:

setDisableCache in interface ICacheAble<T>

setAssertInitDataPath

public CacheAbleRequest<T> setAssertInitDataPath(java.lang.String path)

Specified by:

setAssertInitDataPath in interface ICacheAble<T>

Parameters:

path - file path under /res, For example: "/cache_init/test.json";

Returns:

setCacheTime

public CacheAbleRequest<T> setCacheTime(long time)

Description copied from interface: ICacheAble

set cache time, in seconds

Specified by:

setCacheTime in interface ICacheAble<T>

Returns: