ilog.views.util.servlet.tiling

Class IlvFileTileURLFactory

java.lang.Object

ilog.views.util.servlet.tiling.IlvFileTileURLFactory

All Implemented Interfaces:

IlvTileURLFactory

public class IlvFileTileURLFactory
extends Object
implements IlvTileURLFactory

An IlvTileURLFactory that build file URL from a Rectangle2D. The produced file name is in the form :

 x_y_width_height.jpg
 

Since:

JViews 8.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	JPEG_EXT The extension for JPEG files
static String	PNG_EXT The extension for PNG files.

Constructor Summary

Constructors

Constructor and Description
IlvFileTileURLFactory(File base) Constructs a IlvFileTileURLFactory by specifying a base directory name.

Method Summary

Modifier and Type	Method and Description
File	getBaseDir() Returns the base directory of this factory.
int	getImageFormat() Returns the compression format used to write the image tiles.
NumberFormat	getNumberFormat() Retrieves the format used to format digit parts of the filename.
int	getPrecision() Retrieves the number of digits used when building file names.
boolean	isURL(URL url) Tells if the URL pass as argument is an URL recognized by this URL factory.
URL	makeURL(Object o) Creates an URL from an Rectangle2D.
void	setImageFormat(int format) Sets the compression format used to write the image tiles.
void	setNumberFormat(NumberFormat numberFormat) Sets the format used to format digit parts of the filename.
void	setPrecision(int precision) Sets the number of digits used when building file names.

Methods inherited from class java.lang.Object

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

Field Detail

JPEG_EXT

public static final String JPEG_EXT

The extension for JPEG files

See Also:

Constant Field Values

PNG_EXT

public static final String PNG_EXT

The extension for PNG files.

See Also:

Constant Field Values

Constructor Detail

IlvFileTileURLFactory

public IlvFileTileURLFactory(File base)

Constructs a IlvFileTileURLFactory by specifying a base directory name.

Parameters:

base - The base directory name.

Method Detail

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.

makeURL

public URL makeURL(Object o)

Creates an URL from an Rectangle2D. The rectangle is used to build a file name, which will be the name of the file containing the cached tile.

Specified by:

makeURL in interface IlvTileURLFactory

Parameters:

o - The Rectangle2D which is the bounding box of used to build the file URL.

Returns:

The URL build from the rectangle.

setNumberFormat

public void setNumberFormat(NumberFormat numberFormat)

Sets the format used to format digit parts of the filename.

Parameters:

numberFormat - the format used to format digit parts of the filename.

getNumberFormat

public NumberFormat getNumberFormat()

Retrieves the format used to format digit parts of the filename.

Returns:

the format used to format digit parts of the filename or null if no format has been specified.

getBaseDir

public File getBaseDir()

Returns the base directory of this factory.

Returns:

The base directory of this factory.

isURL

public boolean isURL(URL url)

Tells if the URL pass as argument is an URL recognized by this URL factory.

Specified by:

isURL in interface IlvTileURLFactory

Parameters:

url - The URL to check.

Returns:

true if the URL is recognized, false otherwise.

getPrecision

public int getPrecision()

Retrieves the number of digits used when building file names.

Returns:

the number of digits used when building file names.

setPrecision

public void setPrecision(int precision)

Sets the number of digits used when building file names. A value less or equal than zero implies no rounding when generation files names.

Parameters:

precision - The number of digit.