Class ThumbsDBImageReader

java.lang.Object

javax.imageio.ImageReader

com.twelvemonkeys.imageio.ImageReaderBase

com.twelvemonkeys.imageio.plugins.thumbsdb.ThumbsDBImageReader

public final class ThumbsDBImageReader
extends ImageReaderBase

ThumbsDBImageReader

Version:

$Id: ThumbsDBImageReader.java,v 1.0 22.jan.2007 18:49:38 haku Exp$

See Also:

• CompoundDocument
• Wikipedia: Thumbs.db

Field Summary

Fields

Modifier and Type	Field	Description
private Catalog	catalog
private int	currentImage
private boolean	loadEagerly
private static final int	MAX_EXPANSION_RATIO	Maximum plausible decoded-to-input expansion ratio for thumbdb, used to bound the allocation against the input length.
private final ImageReader	reader
private Entry	root
private static final int	THUMBNAIL_OFFSET
private BufferedImage[]	thumbnails

Fields inherited from class ImageReaderBase

imageInput

Fields inherited from class ImageReader

availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Modifier	Constructor	Description
	ThumbsDBImageReader()
protected	ThumbsDBImageReader(ThumbsDBImageReaderSpi pProvider)

Method Summary

Modifier and Type	Method	Description
void	abort()
private static void	addImage(Container pParent, ImageReader pReader, int pImageNo, String pName)
private static ImageReader	createJPEGReader(ThumbsDBImageReaderSpi pProvider)
private static JFrame	createWindow(String pTitle)
void	dispose()
int	getHeight(int pIndex)
Iterator<ImageTypeSpecifier>	getImageTypes(int pIndex)
int	getNumImages(boolean allowSearch)	Default implementation that always returns 1.
int	getWidth(int pIndex)
private void	init()
private void	init(int pIndex)
private void	initCatalog()
private void	initReader(int pIndex)
private void	initReaderListeners()
boolean	isLoadEagerly()
boolean	isPresent(String pFileName)
static void	main(String[] pArgs)	Test code below
BufferedImage	read(int pIndex, ImageReadParam pParam)	Reads the image data from the given input stream, and returns it as a BufferedImage.
BufferedImage	read(String pName, ImageReadParam pParam)	Reads the image data from the given input stream, and returns it as a BufferedImage.
protected void	resetMembers()	Resets all member variables.
void	setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata)	Overrides setInput, to allow easy access to the input, in case it is an ImageInputStream.
void	setLoadEagerly(boolean pLoadEagerly)	Instructs the reader whether it should read and cache all thumbnails in sequence, during the first read operation.

Methods inherited from class ImageReaderBase

assertInput, checkBounds, fakeAOI, fakeSubsampling, getDestination, getImageMetadata, getStreamMetadata, hasExplicitDestination, reset, showIt, validateSourceSize, validateSourceSize

Methods inherited from class ImageReader

abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, canReadRaster, checkReadParamBandSettings, clearAbortRequest, computeRegions, getAspectRatio, getAvailableLocales, getDefaultReadParam, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getRawImageType, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, hasThumbnails, isIgnoringMetadata, isImageTiled, isRandomAccessEasy, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, readAll, readAll, readAsRenderedImage, readerSupportsThumbnails, readRaster, readThumbnail, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, setInput, setInput, setLocale

Methods inherited from class Object

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

Field Details

MAX_EXPANSION_RATIO

private static final int MAX_EXPANSION_RATIO

Maximum plausible decoded-to-input expansion ratio for thumbdb, used to bound the allocation against the input length.

See Also:

• Constant Field Values

THUMBNAIL_OFFSET

private static final int THUMBNAIL_OFFSET

See Also:

• Constant Field Values

root

private Entry root

catalog

private Catalog catalog

thumbnails

private BufferedImage[] thumbnails

reader

private final ImageReader reader

currentImage

private int currentImage

loadEagerly

private boolean loadEagerly

Constructor Details

ThumbsDBImageReader

public ThumbsDBImageReader()

ThumbsDBImageReader

protected ThumbsDBImageReader(ThumbsDBImageReaderSpi pProvider)

Method Details

resetMembers

protected void resetMembers()

Description copied from class: ImageReaderBase

Resets all member variables. This method is by default invoked from:

• ImageReaderBase.setInput(Object, boolean, boolean)
• ImageReaderBase.dispose()
• ImageReaderBase.reset()

Specified by:

resetMembers in class ImageReaderBase

createJPEGReader

private static ImageReader createJPEGReader(ThumbsDBImageReaderSpi pProvider)

dispose

public void dispose()

Overrides:

dispose in class ImageReaderBase

isLoadEagerly

public boolean isLoadEagerly()

setLoadEagerly

public void setLoadEagerly(boolean pLoadEagerly)

Instructs the reader whether it should read and cache all thumbnails in sequence, during the first read operation.

This is useful mainly if you need to read all the thumbnails, and you need them in random order, as it requires less repositioning in the underlying stream.

Parameters:

pLoadEagerly - true if the reader should read all thumbs on first read

read

public BufferedImage read(int pIndex,
 ImageReadParam pParam)
                   throws IOException

Reads the image data from the given input stream, and returns it as a BufferedImage.

Specified by:

read in class ImageReader

Parameters:

pIndex - the index of the image to read

pParam - additional parameters used while decoding, may be null, in which case defaults will be used

Returns:

a BufferedImage

Throws:

IndexOutOfBoundsException - if pIndex is out of bounds

IllegalStateException - if the input source has not been set

IOException - if an error occurs during reading

read

public BufferedImage read(String pName,
 ImageReadParam pParam)
                   throws IOException

Reads the image data from the given input stream, and returns it as a BufferedImage.

Parameters:

pName - the name of the image to read

pParam - additional parameters used while decoding, may be null, in which case defaults will be used

Returns:

a BufferedImage

Throws:

FileNotFoundException - if the given file name is not found in the "Catalog" entry of the CompoundDocument

IllegalStateException - if the input source has not been set

IOException - if an error occurs during reading

abort

public void abort()

Overrides:

abort in class ImageReader

setInput

public void setInput(Object input,
 boolean seekForwardOnly,
 boolean ignoreMetadata)

Description copied from class: ImageReaderBase

Overrides setInput, to allow easy access to the input, in case it is an ImageInputStream.

Overrides:

setInput in class ImageReaderBase

Parameters:

input - the ImageInputStream or other Object to use for future decoding.

seekForwardOnly - if true, images and metadata may only be read in ascending order from this input source.

ignoreMetadata - if true, metadata may be ignored during reads.

See Also:

• ImageInputStream

init

private void init(int pIndex)
           throws IOException

Throws:

IOException

initReader

private void initReader(int pIndex)
                 throws IOException

Throws:

IOException

initReaderListeners

private void initReaderListeners()

init

private void init()
           throws IOException

Throws:

IOException

initCatalog

private void initCatalog()
                  throws IOException

Throws:

IOException

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Description copied from class: ImageReaderBase

Default implementation that always returns 1.

Overrides:

getNumImages in class ImageReaderBase

Parameters:

allowSearch - ignored, unless overridden

Returns:

1, unless overridden

Throws:

IOException - never, unless overridden

getWidth

public int getWidth(int pIndex)
             throws IOException

Specified by:

getWidth in class ImageReader

Throws:

IOException

getHeight

public int getHeight(int pIndex)
              throws IOException

Specified by:

getHeight in class ImageReader

Throws:

IOException

getImageTypes

public Iterator<ImageTypeSpecifier> getImageTypes(int pIndex)
                                           throws IOException

Specified by:

getImageTypes in class ImageReader

Throws:

IOException

isPresent

public boolean isPresent(String pFileName)

main

public static void main(String[] pArgs)
                 throws IOException

Test code below

Throws:

IOException

createWindow

private static JFrame createWindow(String pTitle)

addImage

private static void addImage(Container pParent,
 ImageReader pReader,
 int pImageNo,
 String pName)
                      throws IOException

Throws:

IOException