cn.trinea.android.common.service.impl

Class PreloadDataCache<K,V>

java.lang.Object

cn.trinea.android.common.service.impl.SimpleCache<K,V>

cn.trinea.android.common.service.impl.PreloadDataCache<K,V>

All Implemented Interfaces:

Cache<K,V>, java.io.Serializable

Direct Known Subclasses:

ImageMemoryCache, ImageSDCardCache

public class PreloadDataCache<K,V>
extends SimpleCache<K,V>

Preload data cache, It a good choice for network application which need to preload data.

you can use this cache to preload data, it support preload data backward, forward or both. and you can set preload count.

Setting and Usage
• Use one of constructors below to init cache
• setOnGetDataListener(OnGetDataListener) set how to get data, this cache will get data and preload data by it
• SimpleCache.setCacheFullRemoveType(CacheFullRemoveType) set remove type when cache is full
• get(Object, List) get object, if list is not null, will preload data auto according to keys in list
• get(Object) get object, and not preload data
• setForwardCacheNumber(int) set count for preload forward, default is DEFAULT_FORWARD_CACHE_NUMBER
• setBackwardCacheNumber(int) set count for preload backward, default is DEFAULT_BACKWARD_CACHE_NUMBER
• setContext(Context) and setAllowedNetworkTypes(int) restrict the types of networks over which this data can get.
• SimpleCache.setValidTime(long) set valid time of elements in cache, in mills
• SimpleCache.saveCache(String, SimpleCache) save cache to a file

Constructor
• PreloadDataCache()
• PreloadDataCache(int)
• PreloadDataCache(int, int)
• loadCache(String) restore cache from file

Author:

Trinea 2012-3-4

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PreloadDataCache.OnGetDataListener<K,V> get data interface, implements this to get data

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BACKWARD_CACHE_NUMBER default count for preload backward
static int	DEFAULT_FORWARD_CACHE_NUMBER default count for preload forward
static int	DEFAULT_THREAD_POOL_SIZE default getting data thread pool size
static int	NETWORK_MOBILE Bit flag for setAllowedNetworkTypes(int) corresponding to ConnectivityManager#TYPE_MOBILE.
static int	NETWORK_WIFI Bit flag for setAllowedNetworkTypes(int) corresponding to ConnectivityManager#TYPE_WIFI.

Fields inherited from class cn.trinea.android.common.service.impl.SimpleCache

DEFAULT_MAX_SIZE

Constructor Summary

Constructors

Constructor and Description
PreloadDataCache() Maximum size of the cache is SimpleCache.DEFAULT_MAX_SIZE Elements of the cache will not invalid, can set by SimpleCache.setValidTime(long) Remove type is RemoveTypeEnterTimeFirst when cache is full Size of getting data thread pool is DEFAULT_THREAD_POOL_SIZE
PreloadDataCache(int maxSize) Elements of the cache will not invalid, can set by SimpleCache.setValidTime(long) Remove type is RemoveTypeEnterTimeFirst when cache is full Size of getting data thread pool is DEFAULT_THREAD_POOL_SIZE
PreloadDataCache(int maxSize, int threadPoolSize) Elements of the cache will not invalid, can set by SimpleCache.setValidTime(long) Remove type is RemoveTypeEnterTimeFirst when cache is full

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkIsNetworkTypeAllowed() Check if get data can proceed over the given network type.
CacheObject<V>	get(K key) get data synchronous if key is null, return null, else if key is already in cache, return the element that mapping with the specified key, else call PreloadDataCache.OnGetDataListener.onGetData(Object) to get data and wait for it finish
CacheObject<V>	get(K key, java.util.List<K> keyList) get data synchronous and preload new data asynchronous according to keyList
int	getAllowedNetworkTypes() get the types of networks over which this data can get
int	getBackwardCacheNumber() get count for preload backward, default is DEFAULT_BACKWARD_CACHE_NUMBER
Context	getContext()
int	getForwardCacheNumber() get count for preload forward, default is DEFAULT_FORWARD_CACHE_NUMBER
PreloadDataCache.OnGetDataListener<K,V>	getOnGetDataListener() get get data listener
boolean	isCheckNetwork() get whether to check the network at first when get data, used when checkIsNetworkTypeAllowed()
boolean	isExistGettingDataThread(K key) whether there is a thread which is getting data for the specified key
static <K,V> PreloadDataCache<K,V>	loadCache(java.lang.String filePath) restore cache from file
void	setAllowedNetworkTypes(int allowedNetworkTypes) Restrict the types of networks over which this data can get.
void	setBackwardCacheNumber(int backwardCacheNumber) set count for preload backward, default is DEFAULT_BACKWARD_CACHE_NUMBER
void	setCheckNetwork(boolean isCheckNetwork) set whether to check the network at first when get data, used when checkIsNetworkTypeAllowed()
void	setContext(Context context) used when checkIsNetworkTypeAllowed()
void	setForwardCacheNumber(int forwardCacheNumber) set count for preload forward, default is DEFAULT_FORWARD_CACHE_NUMBER
void	setOnGetDataListener(PreloadDataCache.OnGetDataListener<K,V> onGetDataListener) set get data listener, this cache will get data and preload data by it
java.util.List<java.lang.Runnable>	shutdownNow()

Methods inherited from class cn.trinea.android.common.service.impl.SimpleCache

clear, containsKey, entrySet, getCacheFullRemoveType, getHitCount, getHitRate, getMaxSize, getMissCount, getSize, getValidTime, keySet, put, put, putAll, remove, saveCache, setCacheFullRemoveType, setValidTime, values

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORWARD_CACHE_NUMBER

public static final int DEFAULT_FORWARD_CACHE_NUMBER

default count for preload forward

See Also:

Constant Field Values

DEFAULT_BACKWARD_CACHE_NUMBER

public static final int DEFAULT_BACKWARD_CACHE_NUMBER

default count for preload backward

See Also:

Constant Field Values

DEFAULT_THREAD_POOL_SIZE

public static final int DEFAULT_THREAD_POOL_SIZE

default getting data thread pool size

NETWORK_MOBILE

public static final int NETWORK_MOBILE

Bit flag for setAllowedNetworkTypes(int) corresponding to ConnectivityManager#TYPE_MOBILE.

See Also:

Constant Field Values

NETWORK_WIFI

public static final int NETWORK_WIFI

Bit flag for setAllowedNetworkTypes(int) corresponding to ConnectivityManager#TYPE_WIFI.

See Also:

Constant Field Values

Constructor Detail

PreloadDataCache

public PreloadDataCache()

• Maximum size of the cache is SimpleCache.DEFAULT_MAX_SIZE
• Elements of the cache will not invalid, can set by SimpleCache.setValidTime(long)
• Remove type is RemoveTypeEnterTimeFirst when cache is full
• Size of getting data thread pool is DEFAULT_THREAD_POOL_SIZE

PreloadDataCache

public PreloadDataCache(int maxSize)

• Elements of the cache will not invalid, can set by SimpleCache.setValidTime(long)
• Remove type is RemoveTypeEnterTimeFirst when cache is full
• Size of getting data thread pool is DEFAULT_THREAD_POOL_SIZE

Parameters:

maxSize - maximum size of the cache

PreloadDataCache

public PreloadDataCache(int maxSize,
                int threadPoolSize)

• Elements of the cache will not invalid, can set by SimpleCache.setValidTime(long)
• Remove type is RemoveTypeEnterTimeFirst when cache is full

Parameters:

maxSize - maximum size of the cache

threadPoolSize - getting data thread pool size

Method Detail

get

public CacheObject<V> get(K key,
                 java.util.List<K> keyList)

get data synchronous and preload new data asynchronous according to keyList

Parameters:

key -

keyList - key list, if is null, not preload, else preload forward by preloadDataForward(Object, List, int), preload backward by preloadDataBackward(Object, List, int)

Returns:

element if this cache contains the specified key, else get data realtime and wait for it

See Also:

get(Object)

get

public CacheObject<V> get(K key)

get data synchronous

• if key is null, return null, else
• if key is already in cache, return the element that mapping with the specified key, else
• call PreloadDataCache.OnGetDataListener.onGetData(Object) to get data and wait for it finish

Specified by:

get in interface Cache<K,V>

Overrides:

get in class SimpleCache<K,V>

Parameters:

key -

Returns:

element if this cache contains the specified key, else get data realtime and wait for it

isExistGettingDataThread

public boolean isExistGettingDataThread(K key)

whether there is a thread which is getting data for the specified key

Parameters:

key -

Returns:

getForwardCacheNumber

public int getForwardCacheNumber()

get count for preload forward, default is DEFAULT_FORWARD_CACHE_NUMBER

Returns:

setForwardCacheNumber

public void setForwardCacheNumber(int forwardCacheNumber)

set count for preload forward, default is DEFAULT_FORWARD_CACHE_NUMBER

Parameters:

forwardCacheNumber -

getBackwardCacheNumber

public int getBackwardCacheNumber()

get count for preload backward, default is DEFAULT_BACKWARD_CACHE_NUMBER

Returns:

setBackwardCacheNumber

public void setBackwardCacheNumber(int backwardCacheNumber)

set count for preload backward, default is DEFAULT_BACKWARD_CACHE_NUMBER

Parameters:

backwardCacheNumber -

getOnGetDataListener

public PreloadDataCache.OnGetDataListener<K,V> getOnGetDataListener()

get get data listener

Returns:

the onGetDataListener

setOnGetDataListener

public void setOnGetDataListener(PreloadDataCache.OnGetDataListener<K,V> onGetDataListener)

set get data listener, this cache will get data and preload data by it

Parameters:

onGetDataListener -

getAllowedNetworkTypes

public int getAllowedNetworkTypes()

get the types of networks over which this data can get

Returns:

any combination of the NETWORK_* bit flags.

setAllowedNetworkTypes

public void setAllowedNetworkTypes(int allowedNetworkTypes)

Restrict the types of networks over which this data can get. By default, all network types are allowed.

Attentions:
• To make it effective, you need to ensure that getContext() is not null

Parameters:

allowedNetworkTypes - any combination of the NETWORK_* bit flags.

isCheckNetwork

public boolean isCheckNetwork()

get whether to check the network at first when get data, used when checkIsNetworkTypeAllowed()

Returns:

setCheckNetwork

public void setCheckNetwork(boolean isCheckNetwork)

set whether to check the network at first when get data, used when checkIsNetworkTypeAllowed()

Parameters:

isCheckNetwork -

getContext

public Context getContext()

setContext

public void setContext(Context context)

used when checkIsNetworkTypeAllowed()

Parameters:

context -

checkIsNetworkTypeAllowed

public boolean checkIsNetworkTypeAllowed()

Check if get data can proceed over the given network type.

Parameters:

networkType - a constant from ConnectivityManager.TYPE_*.

Returns:

one of the NETWORK_* constants

• if getContext() is null, return true
• if network is not avaliable, return false
• if getAllowedNetworkTypes() is not match network, return false

loadCache

public static <K,V> PreloadDataCache<K,V> loadCache(java.lang.String filePath)

restore cache from file

Parameters:

filePath -

Returns:

shutdownNow

public java.util.List<java.lang.Runnable> shutdownNow()

See Also:

ExecutorService.shutdownNow()