Class ImageCompareTest

java.lang.Object

org.apache.batik.test.AbstractTest

org.apache.batik.test.svg.ImageCompareTest

All Implemented Interfaces:

Test

public class ImageCompareTest
extends AbstractTest

This test does a pixel comparison of two images and passes if the two images are identical. It fails otherwise, producing a report describing why the two images are different.

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTRY_KEY_COMPARISON
static final String	ENTRY_KEY_DIFFERENCE
static final String	ENTRY_KEY_FIRST_IMAGE
static final String	ENTRY_KEY_IMAGE_URL
static final String	ENTRY_KEY_SECOND_IMAGE
static final String	ERROR_COULD_NOT_LOAD_IMAGE
static final String	ERROR_COULD_NOT_OPEN_IMAGE
static final String	ERROR_DIFFERENCES
static final String	ERROR_WHILE_COMPARING_FILES
static final String	IMAGE_TYPE_COMPARISON
static final String	IMAGE_TYPE_DIFFERENCE
static final String	TEMP_FILE_PREFIX	Prefix for the temporary files created by Tests of this class
static final String	TEMP_FILE_SUFFIX	Suffix for the temporary files created by Tests of this class
protected URL	urlA
protected String	urlAStr	URL for the first image to be compared.
protected URL	urlB
protected String	urlBStr	URL for the second image to be compared

Fields inherited from class AbstractTest

id, name, parent

Constructor Summary

Constructors

Constructor	Description
ImageCompareTest(String urlA, String urlB)	This test makes a binary comparison of the two images (and not a pixel comparison).

Method Summary

Modifier and Type	Method	Description
protected BufferedImage	buildCompareImage(BufferedImage ref, BufferedImage gen)
static BufferedImage	buildDiffImage(BufferedImage ref, BufferedImage gen)	Builds a new BufferedImage that is the difference between the two input images
static boolean	compare(InputStream refStream, InputStream newStream)	Compare the two input streams
protected BufferedImage	getImage(URL url)	Loads an image from a URL
protected File	imageToFile(BufferedImage img, String imageType)	Creates a temporary File into which the input image is saved.
protected void	initURLs()
protected File	makeRandomFileName(String imageType)	Creates a temporary File into which the input image is saved.
protected URL	resolveURL(String url)	Resolves the input string as follows.
TestReport	rumImpl()

Methods inherited from class AbstractTest

assertEquals, assertEquals, assertNull, assertTrue, error, getId, getName, getParent, getQualifiedId, reportError, reportException, reportSuccess, run, runImpl, runImplBasic, setId, setName, setParent

Methods inherited from class Object

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

Field Details

ERROR_COULD_NOT_OPEN_IMAGE

public static final String ERROR_COULD_NOT_OPEN_IMAGE

See Also:

• Constant Field Values

ERROR_COULD_NOT_LOAD_IMAGE

public static final String ERROR_COULD_NOT_LOAD_IMAGE

See Also:

• Constant Field Values

ERROR_DIFFERENCES

public static final String ERROR_DIFFERENCES

See Also:

• Constant Field Values

ERROR_WHILE_COMPARING_FILES

public static final String ERROR_WHILE_COMPARING_FILES

See Also:

• Constant Field Values

ENTRY_KEY_FIRST_IMAGE

public static final String ENTRY_KEY_FIRST_IMAGE

See Also:

• Constant Field Values

ENTRY_KEY_SECOND_IMAGE

public static final String ENTRY_KEY_SECOND_IMAGE

See Also:

• Constant Field Values

ENTRY_KEY_COMPARISON

public static final String ENTRY_KEY_COMPARISON

See Also:

• Constant Field Values

ENTRY_KEY_DIFFERENCE

public static final String ENTRY_KEY_DIFFERENCE

See Also:

• Constant Field Values

ENTRY_KEY_IMAGE_URL

public static final String ENTRY_KEY_IMAGE_URL

See Also:

• Constant Field Values

IMAGE_TYPE_DIFFERENCE

public static final String IMAGE_TYPE_DIFFERENCE

See Also:

• Constant Field Values

IMAGE_TYPE_COMPARISON

public static final String IMAGE_TYPE_COMPARISON

See Also:

• Constant Field Values

TEMP_FILE_PREFIX

public static final String TEMP_FILE_PREFIX

Prefix for the temporary files created by Tests of this class

See Also:

• Constant Field Values

TEMP_FILE_SUFFIX

public static final String TEMP_FILE_SUFFIX

Suffix for the temporary files created by Tests of this class

See Also:

• Constant Field Values

urlAStr

protected String urlAStr

URL for the first image to be compared.

urlA

protected URL urlA

urlBStr

protected String urlBStr

URL for the second image to be compared

urlB

protected URL urlB

Constructor Details

ImageCompareTest

public ImageCompareTest(String urlA,
 String urlB)

This test makes a binary comparison of the two images (and not a pixel comparison). If the images are different, the test generates a report containing the two images and a delta images to help the user visualize the difference.

Parameters:

urlA - first image

urlB - second image

Method Details

resolveURL

protected URL resolveURL(String url)

Resolves the input string as follows. + First, the string is interpreted as a file description. If the file exists, then the file name is turned into a URL. + Otherwise, the string is supposed to be a URL. If it is an invalid URL, an IllegalArgumentException is thrown.

initURLs

protected void initURLs()

rumImpl

public TestReport rumImpl()
                   throws Exception

Throws:

Exception

buildCompareImage

protected BufferedImage buildCompareImage(BufferedImage ref,
 BufferedImage gen)

imageToFile

protected File imageToFile(BufferedImage img,
 String imageType)
                    throws IOException

Creates a temporary File into which the input image is saved.

Throws:

IOException

makeRandomFileName

protected File makeRandomFileName(String imageType)
                           throws IOException

Creates a temporary File into which the input image is saved.

Throws:

IOException

buildDiffImage

public static BufferedImage buildDiffImage(BufferedImage ref,
 BufferedImage gen)

Builds a new BufferedImage that is the difference between the two input images

compare

public static boolean compare(InputStream refStream,
 InputStream newStream)
                       throws IOException

Compare the two input streams

Throws:

IOException

getImage

protected BufferedImage getImage(URL url)

Loads an image from a URL