com.buckosoft.PicMan.image

Class ThumbCache

java.lang.Object

com.buckosoft.PicMan.image.ThumbCache

public class ThumbCache
extends java.lang.Object

Manage the Thumb Cache. If a Pic is requested that is equal to or smaller than the cache height, see if there is a cached version on the disk. It is much faster to read a 3KB file than a 1MB file.

Since:

2006/01/27

Author:

Dick Balaska

See Also:

ThumbCache.java

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
ThumbCache()

Method Summary

Modifier and Type	Method and Description
void	addToCache(Pic pic, Thumbnail tn) Add a thumbnail to the cache
void	batchBuildCache() Read each pic with the sole purpose of creating a cache entry for it.
void	deleteCache() Delete the thumb cache.
int	getCachedHeight() Fetch the size of the thumbnails that we are managing
int	getMosaicSet()
int	getMosaicSuperCacheMaxSize()
int	getPicProcessing() Return which pic number we are building during batchBuildCache.
Thumbnail	getThumbNail(Pic pic, int height) Get a cached Thumbnail.
boolean	isBuildThumbCache() Are we wanting to build the thumb cache?
void	release() Release any cache buffers we are holding
void	setBuildThumbCache(boolean buildThumbCache) Build the thumb cache.
void	setMosaicSet(int mosaicSet)
void	setMosaicSuperCacheMaxSize(int mosaicSuperCacheMaxSize)
void	setPicMan(PicManFacade pmf) Set the reference to the main API
void	setupCache(java.lang.String cacheDir, int cacheHeight, int maxEntriesPerCache) Initialize the thumbCache

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

ThumbCache

public ThumbCache()

Method Detail

setPicMan

public void setPicMan(PicManFacade pmf)

Set the reference to the main API

Parameters:

pmf - The PicManFacade

isBuildThumbCache

public boolean isBuildThumbCache()

Are we wanting to build the thumb cache?

Returns:

the buildThumbCache flag

getCachedHeight

public int getCachedHeight()

Fetch the size of the thumbnails that we are managing

Returns:

The local cachedHeight

getMosaicSet

public int getMosaicSet()

Returns:

the mosaicSet

setMosaicSet

public void setMosaicSet(int mosaicSet)

Parameters:

mosaicSet - the mosaicSet to set

getMosaicSuperCacheMaxSize

public int getMosaicSuperCacheMaxSize()

Returns:

the mosaicSuperCacheMaxSize

release

public void release()

Release any cache buffers we are holding

setMosaicSuperCacheMaxSize

public void setMosaicSuperCacheMaxSize(int mosaicSuperCacheMaxSize)

Parameters:

mosaicSuperCacheMaxSize - the mosaicSuperCacheMaxSize to set

setBuildThumbCache

public void setBuildThumbCache(boolean buildThumbCache)

Build the thumb cache. Signal to the batch manager to run the builder.

Parameters:

buildThumbCache - the buildThumbCache to set

getThumbNail

public Thumbnail getThumbNail(Pic pic,
                              int height)

Get a cached Thumbnail.
If the requested height is smaller than the cached height, then scale the Thumbnail to size.

Parameters:

pic - The Pic who's Thumbnail we want

height - The height of the thumbnail we want

Returns:

A Thumbnail, or null if not cached or if the cached size is smaller than the requested size.

addToCache

public void addToCache(Pic pic,
                       Thumbnail tn)

Add a thumbnail to the cache

Parameters:

pic - The pic that is being cached

tn - The thumb to cache

setupCache

public void setupCache(java.lang.String cacheDir,
                       int cacheHeight,
                       int maxEntriesPerCache)

Initialize the thumbCache

deleteCache

public void deleteCache()

Delete the thumb cache.
Delete all of the files and subdirectories under the thumb cache directory.
If we are not a mosaicThumbCache, which is an auxillary cache, then set to 0 all of the cacheDir entries for each pic.

batchBuildCache

public void batchBuildCache()
                     throws java.lang.Exception

Read each pic with the sole purpose of creating a cache entry for it.

Throws:

java.lang.Exception

getPicProcessing

public int getPicProcessing()

Return which pic number we are building during batchBuildCache. This is just a status indicator.

Returns:

The index into the list as we process pics.