com.twelvemonkeys.imageio.plugins.thumbsdb

Class ThumbsDBImageReader

java.lang.Object

javax.imageio.ImageReader

com.twelvemonkeys.imageio.ImageReaderBase

com.twelvemonkeys.imageio.plugins.thumbsdb.ThumbsDBImageReader

public class ThumbsDBImageReader
extends ImageReaderBase

ThumbsDBImageReader

Version:

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

Author:

Harald Kuhr, last modified by $Author: haku$

See Also:

CompoundDocument,

Field Summary

Fields inherited from class com.twelvemonkeys.imageio.ImageReaderBase

imageInput

Fields inherited from class javax.imageio.ImageReader

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	abort()
void	dispose()
int	getHeight(int pIndex)
Iterator<ImageTypeSpecifier>	getImageTypes(int pIndex)
int	getNumImages(boolean allowSearch)
int	getWidth(int pIndex)
boolean	isLoadEagerly()
boolean	isPresent(String pFileName)
static void	main(String[] pArgs)
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()
void	setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata)
void	setLoadEagerly(boolean pLoadEagerly) Instructs the reader wether it should read and cache alle thumbnails in sequence, during the first read operation.

Methods inherited from class com.twelvemonkeys.imageio.ImageReaderBase

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

Methods inherited from class javax.imageio.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 java.lang.Object

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

Constructor Detail

ThumbsDBImageReader

public ThumbsDBImageReader()

ThumbsDBImageReader

protected ThumbsDBImageReader(ThumbsDBImageReaderSpi pProvider)

Method Detail

resetMembers

protected void resetMembers()

Specified by:

resetMembers in class ImageReaderBase

dispose

public void dispose()

Overrides:

dispose in class ImageReaderBase

isLoadEagerly

public boolean isLoadEagerly()

setLoadEagerly

public void setLoadEagerly(boolean pLoadEagerly)

Instructs the reader wether it should read and cache alle 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)

Overrides:

setInput in class ImageReaderBase

getNumImages

public int getNumImages(boolean allowSearch)
                 throws IOException

Overrides:

getNumImages in class ImageReaderBase

Throws:

IOException

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

Throws:

IOException