cn.trinea.android.common.service.impl

Class ImageSDCardCache

java.lang.Object

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

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

cn.trinea.android.common.service.impl.ImageSDCardCache

All Implemented Interfaces:

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

public class ImageSDCardCache
extends PreloadDataCache<java.lang.String,java.lang.String>

Image SDCard Cache

It applies to images those uesd frequently and their size is big that we cannot store too much in memory, like pictures of twitter or sina weibo. Cache of small images you can consider of ImageMemoryCache.

Setting and Usage
• Use one of constructors in sections II to init cache
• setOnImageSDCallbackListener(OnImageSDCallbackListener) set callback interface when getting image
• get(String, List, View) get image asynchronous and preload other images asynchronous according to urlList
• 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
• setFileNameRule(FileNameRule) set file name rule which be used when saving images, default is FileNameRuleImageUrl
• setCacheFolder(String) set cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER
• setHttpReadTimeOut(int) set http read image time out, if less than 0, not set. default is not set
• 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 cache is full
• other see PreloadDataCache and SimpleCache

Constructor
• ImageSDCardCache()
• ImageSDCardCache(int)
• ImageSDCardCache(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 2012-4-5

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImageSDCardCache.OnImageSDCallbackListener callback interface when getting image

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
static int	DEFAULT_MAX_SIZE recommend default max cache size according to dalvik max memory

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
ImageSDCardCache() Get data listener is getDefaultOnGetImageListener() callback interface when getting image is null, can set by setOnImageSDCallbackListener(OnImageSDCallbackListener) Maximum size of the cache is DEFAULT_MAX_SIZE Elements of the cache will not invalid Remove type is RemoveTypeUsedCountSmall when cache is full
ImageSDCardCache(int maxSize) Get data listener is getDefaultOnGetImageListener() callback interface when getting image is null, can set by setOnImageSDCallbackListener(OnImageSDCallbackListener) Elements of the cache will not invalid Remove type is RemoveTypeUsedCountSmall when cache is full
ImageSDCardCache(int maxSize, int threadPoolSize) Get data listener is getDefaultOnGetImageListener() callback interface when getting image is null, can set by setOnImageSDCallbackListener(OnImageSDCallbackListener) Elements of the cache will not invalid Remove type is RemoveTypeUsedCountSmall when cache is full

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() delete file when clear cache
void	deleteUnusedFiles() delete unused file in getCacheFolder(), you can use it after loadDataFromDb(Context, String) at first time
boolean	get(java.lang.String imageUrl, java.util.List<java.lang.String> urlList, View view) get image asynchronous and preload other images asynchronous according to urlList
boolean	get(java.lang.String imageUrl, View view) get image asynchronous. when get image success, it will pass to ImageSDCardCache.OnImageSDCallbackListener.onGetSuccess(String, String, View, boolean)
java.lang.String	getCacheFolder() get cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER
PreloadDataCache.OnGetDataListener<java.lang.String,java.lang.String>	getDefaultOnGetImageListener() default get image listener
FileNameRule	getFileNameRule() get file name rule which be used when saving images, default is FileNameRuleImageUrl
int	getHttpReadTimeOut() get http read image time out, if less than 0, not set. default is not set
java.lang.String	getImagePath(java.lang.String imageUrl) get image file path
ImageSDCardCache.OnImageSDCallbackListener	getOnImageSDCallbackListener() get callback interface when getting image
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	isOpenWaitingQueue() get whether open waiting queue, default is true.
static boolean	loadDataFromDb(Context context, ImageSDCardCache imageSDCardCache, java.lang.String tag) load all data in db whose tag is same to tag to imageSDCardCache. just put, do not affect the original data Attentions: If imageSDCardCache is null, throws exception If tag is null or empty, throws exception You should use saveDataToDb(Context, ImageSDCardCache, String) to save data when app exit
boolean	loadDataFromDb(Context context, java.lang.String tag) load all data in db whose tag is same to tag to imageSDCardCache. 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
CacheObject<java.lang.String>	remove(java.lang.String key) delete file when remove
static boolean	saveDataToDb(Context context, ImageSDCardCache imageSDCardCache, java.lang.String tag) delete all rows in db whose tag is same to tag at first, and insert all data in imageSDCardCache to db Attentions: If imageSDCardCache is null, throws exception 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, ImageSDCardCache, String) to init data when app start
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 imageSDCardCache 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	setCacheFolder(java.lang.String cacheFolder) set cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER
void	setFileNameRule(FileNameRule fileNameRule) set file name rule which be used when saving images, default is FileNameRuleImageUrl
void	setHttpReadTimeOut(int readTimeOutMillis) set http read image time out, if less than 0, not set. default is not set, in mills
void	setOnImageSDCallbackListener(ImageSDCardCache.OnImageSDCallbackListener onImageSDCallbackListener) set callback interface when getting image
void	setOpenWaitingQueue(boolean isOpenWaitingQueue) set whether open waiting queue, default is true.
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.PreloadDataCache

checkIsNetworkTypeAllowed, get, getAllowedNetworkTypes, getBackwardCacheNumber, getContext, getForwardCacheNumber, getOnGetDataListener, isCheckNetwork, isExistGettingDataThread, loadCache, setAllowedNetworkTypes, setBackwardCacheNumber, setCheckNetwork, setContext, setForwardCacheNumber, 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, saveCache, setCacheFullRemoveType, setValidTime, values

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_SIZE

public static final int DEFAULT_MAX_SIZE

recommend default max cache size according to dalvik max memory

DEFAULT_CACHE_FOLDER

public static final java.lang.String DEFAULT_CACHE_FOLDER

cache folder path which be used when saving images

Constructor Detail

ImageSDCardCache

public ImageSDCardCache()

• Get data listener is getDefaultOnGetImageListener()
• callback interface when getting image is null, can set by setOnImageSDCallbackListener(OnImageSDCallbackListener)
• Maximum size of the cache is DEFAULT_MAX_SIZE
• Elements of the cache will not invalid
• Remove type is RemoveTypeUsedCountSmall when cache is full

See Also:

PreloadDataCache.PreloadDataCache()

ImageSDCardCache

public ImageSDCardCache(int maxSize)

• Get data listener is getDefaultOnGetImageListener()
• callback interface when getting image is null, can set by setOnImageSDCallbackListener(OnImageSDCallbackListener)
• Elements of the cache will not invalid
• Remove type is RemoveTypeUsedCountSmall when cache is full

Parameters:

maxSize - maximum size of the cache

See Also:

PreloadDataCache.PreloadDataCache(int)

ImageSDCardCache

public ImageSDCardCache(int maxSize,
                int threadPoolSize)

• Get data listener is getDefaultOnGetImageListener()
• callback interface when getting image is null, can set by setOnImageSDCallbackListener(OnImageSDCallbackListener)
• Elements of the cache will not invalid
• Remove type is RemoveTypeUsedCountSmall when cache is full

Parameters:

maxSize - maximum size of the cache

threadPoolSize - getting data thread pool size

See Also:

PreloadDataCache.PreloadDataCache(int, int)

Method Detail

get

public boolean get(java.lang.String imageUrl,
          View view)

get image asynchronous. when get image success, it will pass to ImageSDCardCache.OnImageSDCallbackListener.onGetSuccess(String, String, View, boolean)

Parameters:

imageUrl -

view -

Returns:

whether image already in cache or not

get

public boolean get(java.lang.String imageUrl,
          java.util.List<java.lang.String> urlList,
          View view)

get image asynchronous and preload other images asynchronous according to urlList

Parameters:

imageUrl -

urlList - url list, if is null, not preload, else preload forward by PreloadDataCache.preloadDataForward(Object, List, int), preload backward by PreloadDataCache.preloadDataBackward(Object, List, int)

view -

Returns:

whether image already in cache or not

getCacheFolder

public java.lang.String getCacheFolder()

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

Returns:

the cacheFolder

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 -

getFileNameRule

public FileNameRule getFileNameRule()

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

Returns:

the fileNameRule

setFileNameRule

public void setFileNameRule(FileNameRule fileNameRule)

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

Parameters:

fileNameRule -

getOnImageSDCallbackListener

public ImageSDCardCache.OnImageSDCallbackListener getOnImageSDCallbackListener()

get callback interface when getting image

Returns:

the onImageSDCallbackListener

setOnImageSDCallbackListener

public void setOnImageSDCallbackListener(ImageSDCardCache.OnImageSDCallbackListener onImageSDCallbackListener)

set callback interface when getting image

Parameters:

onImageSDCallbackListener - the onImageSDCallbackListener to set

getHttpReadTimeOut

public int getHttpReadTimeOut()

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

Returns:

the httpReadTimeOut

setHttpReadTimeOut

public void setHttpReadTimeOut(int readTimeOutMillis)

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

Parameters:

readTimeOutMillis -

isOpenWaitingQueue

public boolean isOpenWaitingQueue()

get whether open waiting queue, default is true. If true, save all view waiting for image loaded, else only save the newest one

Returns:

setOpenWaitingQueue

public void setOpenWaitingQueue(boolean isOpenWaitingQueue)

set whether open waiting queue, default is true. If true, save all view waiting for image loaded, else only save the newest one

Parameters:

isOpenWaitingQueue -

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

Parameters:

requestProperties -

getRequestProperties

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

get http request properties

Returns:

setRequestProperty

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

Sets the value of the http request header field

Parameters:

field - the request header field to be set

newValue - the new value of the specified property

See Also:

#setRequestProperties(Map)}

shutdownNow

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

Overrides:

shutdownNow in class PreloadDataCache<java.lang.String,java.lang.String>

See Also:

ExecutorService.shutdownNow()

remove

public CacheObject<java.lang.String> remove(java.lang.String key)

delete file when remove

Specified by:

remove in interface Cache<java.lang.String,java.lang.String>

Overrides:

remove in class SimpleCache<java.lang.String,java.lang.String>

Returns:

the value of the removed or null if no mapping for the specified key was found.

clear

public void clear()

delete file when clear cache

Specified by:

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

Overrides:

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

See Also:

Map.clear()

deleteUnusedFiles

public void deleteUnusedFiles()

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

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()

loadDataFromDb

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

load all data in db whose tag is same to tag to imageSDCardCache. 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:

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 imageSDCardCache 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:

saveDataToDb(Context, ImageSDCardCache, String)

loadDataFromDb

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

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

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

Parameters:

context -

imageSDCardCache -

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

Returns:

saveDataToDb

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

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

Attentions:
• If imageSDCardCache is null, throws exception
• 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, ImageSDCardCache, String) to init data when app start

Parameters:

context -

imageSDCardCache -

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

Returns:

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.

getDefaultOnGetImageListener

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

default get image listener

Returns: