ilog.views.util.servlet.tiling

Class IlvFileTileManager

java.lang.Object

ilog.views.util.servlet.tiling.IlvFileTileManager

All Implemented Interfaces:

IlvTileManager

public class IlvFileTileManager
extends Object
implements IlvTileManager

Implementation of a tile manager that reads and writes files on disk. A cache management is provided by a IlvDefaultFileTileCache. This tile manager is intended to be used with a IlvManagerServlet and a IlvManagerServletSupport. In the servlet code, you can use it the following way:

 protected BufferedImage generateImage(
   HttpServletRequest request, IlvRect bbox, 
   int width, int height, String[] requestedLayers, Color bgColor,
   boolean transparent) throws ServletException {
  String s = request.getParameter("overview");
  BufferedImage image = null;
  boolean overview = (s != null && s.equalsIgnoreCase("true"));
  if (!overview) {
    IlvTileManager tileManager = getTileManager(...);
    Object key = getKey(request); // retrieve key attribute from request.
    image = tileManager.getImage(key);
    if (image == null) { 
      // image not found by the tile manager, create it from the view     
      image = super.generateImage(request, bbox, width, height, 
                                  requestedLayers, bgColor, transparent);
      // register image in the tile manager                  
      tileManager.putImage(key, image);            
     }
     return image;
   }
   return super.generateImage(request, bbox, width, height, 
                              requestedLayers, bgColor, transparent);
 }
 

Since:

JViews 8.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	JPEG_FORMAT Constant to save images in JPEG format.
static int	PNG_FORMAT Constant to save images in PNG format.

Constructor Summary

Constructors

Constructor and Description
IlvFileTileManager() Create a IlvFileTileManager with default values: null tile storage directory and a size of 10 mega bytes.
IlvFileTileManager(File base, long maxCacheSize, long freeCacheSize) Constructs a IlvFileTileManager by specifying the location of the directory in which the tiles will be stored.

Method Summary

Modifier and Type	Method and Description
IlvDefaultFileTileCache	getCache() Retrieves the IlvFileTileCache used by the tile manager to cache the tiles.
BufferedImage	getImage(Object o) Retrieves an image of a tile by specifying an Object as a key.
int	getImageFormat() Returns the compression format used to write the image tiles.
IlvDefaultFileTileReader	getReader() Retrieves the IlvTileReader used by this tile manager to read the tiles.
IlvTileURLFactory	getUrlFactory() Retrieves the URL factory used to build URLs.
IlvDefaultFileTileWriter	getWriter() Retrieves the IlvTileWriter used by this tile manager to write the tiles.
Object	putImage(Object o, BufferedImage image) Put an image in the tile manager.
void	setBase(File base) Sets the base directory for this tile manager.
void	setCache(IlvDefaultFileTileCache cacheManager) Sets the IlvFileTileCache used by this tile manager to cache the tiles.
void	setImageFormat(int format) Sets the compression format used to write the image tiles.
void	setReader(IlvDefaultFileTileReader reader) Sets the IlvTileReader used by this tile manager to read the tiles.
void	setUrlFactory(IlvTileURLFactory urlFactory) Sets the URL factory.
void	setWriter(IlvDefaultFileTileWriter writer) Sets the IlvTileWriter used by this tile manager to write the tiles.

Methods inherited from class java.lang.Object

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

Field Detail

PNG_FORMAT

public static int PNG_FORMAT

Constant to save images in PNG format.

JPEG_FORMAT

public static int JPEG_FORMAT

Constant to save images in JPEG format.

Constructor Detail

IlvFileTileManager

public IlvFileTileManager()

Create a IlvFileTileManager with default values: null tile storage directory and a size of 10 mega bytes. Before using a cache created with this constructor, you have to call the setBase method with a non null base file.

See Also:

setBase(File)

IlvFileTileManager

public IlvFileTileManager(File base,
                          long maxCacheSize,
                          long freeCacheSize)

Constructs a IlvFileTileManager by specifying the location of the directory in which the tiles will be stored.
This constructor registers :

• a IlvDefaultFileTileWriter as tile writer.
• a IlvDefaultFileTileReader as tile reader.
• a IlvFileTileURLFactory as URL factory.
• a IlvDefaultFileTileCache as tile cache.

Parameters:

base - The base directory for tile cache.

maxCacheSize - The max tile cache size.

freeCacheSize - The size that will be free when the cache is full.

Method Detail

setBase

public void setBase(File base)

Sets the base directory for this tile manager.

Parameters:

base - The base directory where the tiles will be stored.

setImageFormat

public void setImageFormat(int format)

Sets the compression format used to write the image tiles.

Parameters:

format - the image format.

getImageFormat

public int getImageFormat()

Returns the compression format used to write the image tiles.

Returns:

the image format.

getImage

public BufferedImage getImage(Object o)

Retrieves an image of a tile by specifying an Object as a key.

Specified by:

getImage in interface IlvTileManager

Parameters:

o - The object specifying the location of the tile.

Returns:

The retrieved image or null if no image is found at this location.

putImage

public Object putImage(Object o,
                       BufferedImage image)

Put an image in the tile manager.

Specified by:

putImage in interface IlvTileManager

Parameters:

o - The object used to build the tile location.

image - The image of the tile.

Returns:

The File storing the tile or null if the tile manager was unable to write the tile.

getUrlFactory

public IlvTileURLFactory getUrlFactory()

Retrieves the URL factory used to build URLs.

Returns:

The URL factory or null if no URL factor has been registered.

setUrlFactory

public void setUrlFactory(IlvTileURLFactory urlFactory)

Sets the URL factory.

Parameters:

urlFactory - The URL factory to set.

getReader

public IlvDefaultFileTileReader getReader()

Retrieves the IlvTileReader used by this tile manager to read the tiles.

Returns:

The IlvTileReader used by this tile manager to read the tiles.

setReader

public void setReader(IlvDefaultFileTileReader reader)

Sets the IlvTileReader used by this tile manager to read the tiles.

Parameters:

reader - The new IlvTileReader used by this tile manager to read the tiles.

getWriter

public IlvDefaultFileTileWriter getWriter()

Retrieves the IlvTileWriter used by this tile manager to write the tiles.

Returns:

The IlvTileWriter used by this tile manager to write the tiles.

setWriter

public void setWriter(IlvDefaultFileTileWriter writer)

Sets the IlvTileWriter used by this tile manager to write the tiles.

Parameters:

writer - The new IlvTiledWriterReader used by this tile manager to write the tiles.

getCache

public IlvDefaultFileTileCache getCache()

Retrieves the IlvFileTileCache used by the tile manager to cache the tiles.

Returns:

The IlvFileTileCache used by the tile manager to cache the tiles.

setCache

public void setCache(IlvDefaultFileTileCache cacheManager)

Sets the IlvFileTileCache used by this tile manager to cache the tiles.

Parameters:

cacheManager - The IlvFileTileCache used by this tile manager to cache the tiles.