cn.trinea.android.common.service.impl

Class ImageCache

java.lang.Object

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

cn.trinea.android.common.service.impl.PreloadDataCache<java.lang.String,Bitmap>

cn.trinea.android.common.service.impl.ImageMemoryCache

cn.trinea.android.common.service.impl.ImageCache

All Implemented Interfaces:

Cache<java.lang.String,Bitmap>, java.io.Serializable

public class ImageCache
extends ImageMemoryCache

Image Cache

It's a cache with primary cache and secondary cache. It's a combination of ImageMemoryCache and ImageSDCardCache. It applies to apps those used much images, like sina weibo, twitter, taobao, huaban, weixin and so on.

Setting and Usage
• Use one of constructors in sections II to init cache
• ImageMemoryCache.setOnImageCallbackListener(OnImageCallbackListener) set callback interface after image get success
• ImageMemoryCache.get(String, List, View) get image asynchronous and preload other images asynchronous according to urlList
• ImageMemoryCache.get(String, View) get image asynchronous
• initData(Context, String) or loadDataFromDb(Context, String) to init data when app start, saveDataToDb(Context, String) to save data when app exit
• setHttpReadTimeOut(int) set http read image time out, if less than 0, not set. default is not set
• PreloadDataCache.setContext(Context) and setAllowedNetworkTypes(int) restrict the types of networks over which this data can get.
• ImageMemoryCache.setOpenWaitingQueue(boolean) set whether open waiting queue, default is true. If true, save all view waiting for image loaded, else only save the newest one
• PreloadDataCache.setOnGetDataListener(OnGetDataListener) set how to get image, this cache will get image and preload images by it
• SimpleCache.setCacheFullRemoveType(CacheFullRemoveType) set remove type when primary cache is full
• setCacheFullRemoveTypeOfSecondaryCache(CacheFullRemoveType) set remove type when secondary cache is full

Constructor
• ImageCache()
• ImageCache(int)
• ImageCache(int, int)
• ImageCache(int, int, int, int)

Attentions
• You should add android.permission.WRITE_EXTERNAL_STORAGE in manifest, to store image to sdcard.
• You should add android.permission.ACCESS_NETWORK_STATE in manifest if you get image from network.

Author:

Trinea 2013-10-18

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImageCache.CompressListener set image compress scale

Nested classes/interfaces inherited from class cn.trinea.android.common.service.impl.ImageMemoryCache

ImageMemoryCache.OnImageCallbackListener

Nested classes/interfaces inherited from class cn.trinea.android.common.service.impl.PreloadDataCache

PreloadDataCache.OnGetDataListener<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CACHE_FOLDER cache folder path which be used when saving images

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

DEFAULT_MAX_SIZE

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

DEFAULT_BACKWARD_CACHE_NUMBER, DEFAULT_FORWARD_CACHE_NUMBER, DEFAULT_THREAD_POOL_SIZE, NETWORK_MOBILE, NETWORK_WIFI

Constructor Summary

Constructors

Constructor and Description
ImageCache() max size of primary cache is ImageMemoryCache.DEFAULT_MAX_SIZE, max size of secondary cache is ImageSDCardCache.DEFAULT_MAX_SIZE thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE
ImageCache(int primaryCacheMaxSize) max size of secondary cache is ImageSDCardCache.DEFAULT_MAX_SIZE thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE
ImageCache(int primaryCacheMaxSize, int secondaryCacheMaxSize) thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE
ImageCache(int primaryCacheMaxSize, int primaryCacheThreadPoolSize, int secondaryCacheMaxSize, int secondaryCacheThreadPoolSize) Callback interface after image get success is null, can set by PreloadDataCache#setOnImageCallbackListener(OnImageCallbackListener) Get data listener of primary cache is getOnGetImageListenerOfPrimaryCache(), you can set by #setOnGetImageListenerOfPrimaryCache(OnGetDataListener), but not recommended, you may destory secondary cache.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkIsNetworkTypeAllowed() Check if get data can proceed over the given network type.
void	clear() clear both primary cache and secondary cache
void	deleteUnusedFiles() delete unused file in getCacheFolder(), you can use it after loadDataFromDb(Context, String) at first time
int	getAllowedNetworkTypes() get the types of networks over which this data can get
java.lang.String	getCacheFolder() get cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER
CacheFullRemoveType<java.lang.String>	getCacheFullRemoveTypeOfSecondaryCache() get remove type when secondary cache is full
ImageCache.CompressListener	getCompressListener() get compressListener
int	getCompressSize() get compressSize
Context	getContext()
FileNameRule	getFileNameRule() get file name rule which be used when saving images, default is FileNameRuleImageUrl
int	getHttpReadTimeOut() get http read image time out of secondary cache, if less than 0, not set. default is not set
java.lang.String	getImagePath(java.lang.String imageUrl) get image file path
PreloadDataCache.OnGetDataListener<java.lang.String,Bitmap>	getOnGetImageListenerOfPrimaryCache() get get image listener of primary cache
PreloadDataCache.OnGetDataListener<java.lang.String,java.lang.String>	getOnGetImageListenerOfSecondaryCache() get get image listener of secondary cache
java.util.Map<java.lang.String,java.lang.String>	getRequestProperties() get http request properties
void	initData(Context context, java.lang.String tag) load all data from db and delete unused file in getCacheFolder() It's a combination of loadDataFromDb(Context, String) and deleteUnusedFiles() You should use saveDataToDb(Context, String) to save data when app exit
boolean	isCheckNetwork() get whether to check the network at first when get data, used when PreloadDataCache.checkIsNetworkTypeAllowed()
boolean	loadDataFromDb(Context context, java.lang.String tag) load all data in db whose tag is same to tag to this cache. just put, do not affect the original data Attentions: If tag is null or empty, throws exception You should use saveDataToDb(Context, String) to save data when app exit
boolean	saveDataToDb(Context context, java.lang.String tag) delete all rows in db whose tag is same to tag at first, and insert all data in this cache to db Attentions: If tag is null or empty, throws exception Will delete all rows in db whose tag is same to tag at first You can use initData(Context, String) or loadDataFromDb(Context, String) to init data when app start
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 PreloadDataCache.DEFAULT_BACKWARD_CACHE_NUMBER
void	setCacheFolder(java.lang.String cacheFolder) set cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER
void	setCacheFullRemoveTypeOfSecondaryCache(CacheFullRemoveType<java.lang.String> cacheFullRemoveType) set remove type when secondary cache is full
void	setCheckNetwork(boolean isCheckNetwork) set whether to check the network at first when get data, used when PreloadDataCache.checkIsNetworkTypeAllowed()
void	setCompressListener(ImageCache.CompressListener compressListener) set compressListener Attentions: if this function is set, the function #setCompressSize(String) is not work
void	setCompressSize(int compressSize) set image compress scale Attentions: if setCompressListener(CompressListener) is set, this function is not work
void	setContext(Context context) used when PreloadDataCache.checkIsNetworkTypeAllowed()
void	setFileNameRule(FileNameRule fileNameRule) set file name rule which be used when saving images, default is FileNameRuleImageUrl
void	setForwardCacheNumber(int forwardCacheNumber) set count for preload forward, default is PreloadDataCache.DEFAULT_FORWARD_CACHE_NUMBER
void	setHttpReadTimeOut(int readTimeOutMillis) set http read image time out of secondary cache, if less than 0, not set. default is not set, in mills
void	setOnGetImageListenerOfPrimaryCache(PreloadDataCache.OnGetDataListener<java.lang.String,Bitmap> onGetImageListener) set get data listener of primary cache, primary cache will get data and preload data by it
void	setOnGetImageListenerOfSecondaryCache(PreloadDataCache.OnGetDataListener<java.lang.String,java.lang.String> onGetImageListener) set get data listener of secondary cache, secondary cache will get data and preload data by it
void	setRequestProperties(java.util.Map<java.lang.String,java.lang.String> requestProperties) set http request properties If image is from the different server, setRequestProperty("Connection", "false") is recommended.
void	setRequestProperty(java.lang.String field, java.lang.String newValue) Sets the value of the http request header field
java.util.List<java.lang.Runnable>	shutdownNow()

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

get, get, getDefaultOnGetImageListener, getOnImageCallbackListener, isOpenWaitingQueue, setOnImageCallbackListener, setOpenWaitingQueue

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

get, getBackwardCacheNumber, getForwardCacheNumber, getOnGetDataListener, isExistGettingDataThread, loadCache, setOnGetDataListener

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

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_CACHE_FOLDER

public static final java.lang.String DEFAULT_CACHE_FOLDER

cache folder path which be used when saving images

Constructor Detail

ImageCache

public ImageCache()

• max size of primary cache is ImageMemoryCache.DEFAULT_MAX_SIZE, max size of secondary cache is ImageSDCardCache.DEFAULT_MAX_SIZE
• thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE

See Also:

#ImageCache(int, int, int, int)}

ImageCache

public ImageCache(int primaryCacheMaxSize)

• max size of secondary cache is ImageSDCardCache.DEFAULT_MAX_SIZE
• thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE

Parameters:

primaryCacheMaxSize -

secondaryCacheMaxSize -

See Also:

#ImageCache(int, int, int, int)}

ImageCache

public ImageCache(int primaryCacheMaxSize,
          int secondaryCacheMaxSize)

thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE

Parameters:

primaryCacheMaxSize -

secondaryCacheMaxSize -

See Also:

#ImageCache(int, int, int, int)}

ImageCache

public ImageCache(int primaryCacheMaxSize,
          int primaryCacheThreadPoolSize,
          int secondaryCacheMaxSize,
          int secondaryCacheThreadPoolSize)

• Callback interface after image get success is null, can set by PreloadDataCache#setOnImageCallbackListener(OnImageCallbackListener)
• Get data listener of primary cache is getOnGetImageListenerOfPrimaryCache(), you can set by #setOnGetImageListenerOfPrimaryCache(OnGetDataListener), but not recommended, you may destory secondary cache.
• Get data listener of secondary cache is getOnGetImageListenerOfSecondaryCache(), you can set by #setOnGetImageListenerOfSecondaryCache(OnGetDataListener).
• Elements of the cache will not invalid
• Remove type of primary cache is RemoveTypeUsedCountSmall when cache is full

Parameters:

primaryCacheMaxSize - maximum size of the primary cache

primaryCacheThreadPoolSize - getting data thread pool size of the primary cache

secondaryCacheMaxSize - maximum size of the secondary cache

secondaryCacheThreadPoolSize - getting data thread pool size of the secondary cache

Method Detail

getCompressSize

public int getCompressSize()

get compressSize

Returns:

the compressSize

setCompressSize

public void setCompressSize(int compressSize)

set image compress scale

Attentions:
• if setCompressListener(CompressListener) is set, this function is not work

Parameters:

compressSize - the compressSize to set

See Also:

#setCompressSize(String)}

setCompressListener

public void setCompressListener(ImageCache.CompressListener compressListener)

set compressListener

Attentions:
• if this function is set, the function #setCompressSize(String) is not work

Parameters:

compressListener -

getCompressListener

public ImageCache.CompressListener getCompressListener()

get compressListener

Returns:

compressListener

getHttpReadTimeOut

public int getHttpReadTimeOut()

get http read image time out of secondary cache, if less than 0, not set. default is not set

Overrides:

getHttpReadTimeOut in class ImageMemoryCache

Returns:

the httpReadTimeOut

setHttpReadTimeOut

public void setHttpReadTimeOut(int readTimeOutMillis)

set http read image time out of secondary cache, if less than 0, not set. default is not set, in mills

Overrides:

setHttpReadTimeOut in class ImageMemoryCache

Parameters:

readTimeOutMillis -

clear

public void clear()

clear both primary cache and secondary cache

Specified by:

clear in interface Cache<java.lang.String,Bitmap>

Overrides:

clear in class SimpleCache<java.lang.String,Bitmap>

See Also:

Map.clear()

setForwardCacheNumber

public void setForwardCacheNumber(int forwardCacheNumber)

Description copied from class: PreloadDataCache

set count for preload forward, default is PreloadDataCache.DEFAULT_FORWARD_CACHE_NUMBER

Overrides:

setForwardCacheNumber in class PreloadDataCache<java.lang.String,Bitmap>

setBackwardCacheNumber

public void setBackwardCacheNumber(int backwardCacheNumber)

Description copied from class: PreloadDataCache

set count for preload backward, default is PreloadDataCache.DEFAULT_BACKWARD_CACHE_NUMBER

Overrides:

setBackwardCacheNumber in class PreloadDataCache<java.lang.String,Bitmap>

getAllowedNetworkTypes

public int getAllowedNetworkTypes()

Description copied from class: PreloadDataCache

get the types of networks over which this data can get

Overrides:

getAllowedNetworkTypes in class PreloadDataCache<java.lang.String,Bitmap>

Returns:

any combination of the NETWORK_* bit flags.

setAllowedNetworkTypes

public void setAllowedNetworkTypes(int allowedNetworkTypes)

Description copied from class: PreloadDataCache

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 PreloadDataCache.getContext() is not null

Overrides:

setAllowedNetworkTypes in class PreloadDataCache<java.lang.String,Bitmap>

Parameters:

allowedNetworkTypes - any combination of the NETWORK_* bit flags.

isCheckNetwork

public boolean isCheckNetwork()

Description copied from class: PreloadDataCache

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

Overrides:

isCheckNetwork in class PreloadDataCache<java.lang.String,Bitmap>

Returns:

setCheckNetwork

public void setCheckNetwork(boolean isCheckNetwork)

Description copied from class: PreloadDataCache

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

Overrides:

setCheckNetwork in class PreloadDataCache<java.lang.String,Bitmap>

checkIsNetworkTypeAllowed

public boolean checkIsNetworkTypeAllowed()

Description copied from class: PreloadDataCache

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

Overrides:

checkIsNetworkTypeAllowed in class PreloadDataCache<java.lang.String,Bitmap>

Returns:

one of the NETWORK_* constants

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

getContext

public Context getContext()

Overrides:

getContext in class PreloadDataCache<java.lang.String,Bitmap>

setContext

public void setContext(Context context)

Description copied from class: PreloadDataCache

used when PreloadDataCache.checkIsNetworkTypeAllowed()

Overrides:

setContext in class PreloadDataCache<java.lang.String,Bitmap>

setRequestProperties

public void setRequestProperties(java.util.Map<java.lang.String,java.lang.String> requestProperties)

set http request properties

• If image is from the different server, setRequestProperty("Connection", "false") is recommended. If image is from the same server, true is recommended, and this is the default value

Overrides:

setRequestProperties in class ImageMemoryCache

Parameters:

requestProperties -

getRequestProperties

public java.util.Map<java.lang.String,java.lang.String> getRequestProperties()

get http request properties

Overrides:

getRequestProperties in class ImageMemoryCache

Returns:

setRequestProperty

public void setRequestProperty(java.lang.String field,
                      java.lang.String newValue)

Sets the value of the http request header field

Overrides:

setRequestProperty in class ImageMemoryCache

Parameters:

field - the request header field to be set

newValue - the new value of the specified property

See Also:

#setRequestProperties(Map)}

getCacheFolder

public java.lang.String getCacheFolder()

get cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER

Returns:

the cacheFolder

See Also:

ImageSDCardCache.getCacheFolder()

setCacheFolder

public void setCacheFolder(java.lang.String cacheFolder)

set cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER

Parameters:

cacheFolder -

See Also:

ImageSDCardCache.setCacheFolder(String)

getFileNameRule

public FileNameRule getFileNameRule()

get file name rule which be used when saving images, default is FileNameRuleImageUrl

Returns:

the fileNameRule

See Also:

ImageSDCardCache.getFileNameRule()

setFileNameRule

public void setFileNameRule(FileNameRule fileNameRule)

set file name rule which be used when saving images, default is FileNameRuleImageUrl

Parameters:

fileNameRule -

See Also:

ImageSDCardCache.setFileNameRule(FileNameRule)

initData

public void initData(Context context,
            java.lang.String tag)

load all data from db and delete unused file in getCacheFolder()

• It's a combination of loadDataFromDb(Context, String) and deleteUnusedFiles()
• You should use saveDataToDb(Context, String) to save data when app exit

Parameters:

context -

tag -

See Also:

loadDataFromDb(Context, String), deleteUnusedFiles()

deleteUnusedFiles

public void deleteUnusedFiles()

delete unused file in getCacheFolder(), you can use it after loadDataFromDb(Context, String) at first time

See Also:

ImageSDCardCache#deleteUnusedFiles()}

loadDataFromDb

public boolean loadDataFromDb(Context context,
                     java.lang.String tag)

load all data in db whose tag is same to tag to this cache. just put, do not affect the original data

Attentions:
• If tag is null or empty, throws exception
• You should use saveDataToDb(Context, String) to save data when app exit

Parameters:

context -

tag - tag used to mark this cache when save to and load from db, should be unique and cannot be null or empty

Returns:

See Also:

ImageSDCardCache.loadDataFromDb(Context, ImageSDCardCache, String)

saveDataToDb

public boolean saveDataToDb(Context context,
                   java.lang.String tag)

delete all rows in db whose tag is same to tag at first, and insert all data in this cache to db

Attentions:
• If tag is null or empty, throws exception
• Will delete all rows in db whose tag is same to tag at first
• You can use initData(Context, String) or loadDataFromDb(Context, String) to init data when app start

Parameters:

context -

tag - tag used to mark this cache when save to and load from db, should be unique and cannot be null or empty

Returns:

See Also:

ImageSDCardCache.saveDataToDb(Context, ImageSDCardCache, String)

getImagePath

public java.lang.String getImagePath(java.lang.String imageUrl)

get image file path

Parameters:

imageUrl -

Returns:

if not in cache return null, else return full path.

shutdownNow

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

Overrides:

shutdownNow in class ImageMemoryCache

See Also:

ExecutorService.shutdownNow()

getOnGetImageListenerOfPrimaryCache

public PreloadDataCache.OnGetDataListener<java.lang.String,Bitmap> getOnGetImageListenerOfPrimaryCache()

get get image listener of primary cache

Returns:

See Also:

PreloadDataCache#getOnGetDataListener()}

setOnGetImageListenerOfPrimaryCache

public void setOnGetImageListenerOfPrimaryCache(PreloadDataCache.OnGetDataListener<java.lang.String,Bitmap> onGetImageListener)

set get data listener of primary cache, primary cache will get data and preload data by it

Parameters:

onGetImageListener -

See Also:

PreloadDataCache#setOnGetDataListener(OnGetDataListener)}

getOnGetImageListenerOfSecondaryCache

public PreloadDataCache.OnGetDataListener<java.lang.String,java.lang.String> getOnGetImageListenerOfSecondaryCache()

get get image listener of secondary cache

Returns:

setOnGetImageListenerOfSecondaryCache

public void setOnGetImageListenerOfSecondaryCache(PreloadDataCache.OnGetDataListener<java.lang.String,java.lang.String> onGetImageListener)

set get data listener of secondary cache, secondary cache will get data and preload data by it

Parameters:

onGetImageListener -

getCacheFullRemoveTypeOfSecondaryCache

public CacheFullRemoveType<java.lang.String> getCacheFullRemoveTypeOfSecondaryCache()

get remove type when secondary cache is full

Returns:

setCacheFullRemoveTypeOfSecondaryCache

public void setCacheFullRemoveTypeOfSecondaryCache(CacheFullRemoveType<java.lang.String> cacheFullRemoveType)

set remove type when secondary cache is full

Parameters:

cacheFullRemoveType - the cacheFullRemoveType to set