Package adams.data.io.input

Class ApacheCommonsImageReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractImageReader<BufferedImageContainer>

adams.data.io.input.ApacheCommonsImageReader

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ImageReader<BufferedImageContainer>, InputStreamImageReader<BufferedImageContainer>, Serializable

public class ApacheCommonsImageReader
extends AbstractImageReader<BufferedImageContainer>
implements InputStreamImageReader<BufferedImageContainer>

Apache Commons image reader for: bmp, gif, ico, pbm, pgm, png, pnm, ppm, psd, tif, tiff

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ApacheCommonsImageReader()

Method Summary

Modifier and Type	Method	Description
protected BufferedImageContainer	doRead(PlaceholderFile file)	Performs the actual reading of the image file.
ImageWriter	getCorrespondingWriter()	Returns, if available, the corresponding writer.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
String	globalInfo()	Returns a string describing the object.
BufferedImageContainer	read(InputStream stream)	Reads the image from the stream.

Methods inherited from class adams.data.io.input.AbstractImageReader

check, getDefaultFormatExtension, getReaders, isAvailable, postProcess, read

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.io.FileFormatHandler

getDefaultFormatExtension

Methods inherited from interface adams.data.io.input.ImageReader

isAvailable, read

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

ApacheCommonsImageReader

public ApacheCommonsImageReader()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface FileFormatHandler

Specified by:

getFormatDescription in class AbstractImageReader<BufferedImageContainer>

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface FileFormatHandler

Specified by:

getFormatExtensions in class AbstractImageReader<BufferedImageContainer>

Returns:

the extension(s) (without the dot!)

getCorrespondingWriter

public ImageWriter getCorrespondingWriter()

Returns, if available, the corresponding writer.

Specified by:

getCorrespondingWriter in interface ImageReader<BufferedImageContainer>

Specified by:

getCorrespondingWriter in class AbstractImageReader<BufferedImageContainer>

Returns:

the writer, null if none available

doRead

protected BufferedImageContainer doRead(PlaceholderFile file)

Performs the actual reading of the image file.

Specified by:

doRead in class AbstractImageReader<BufferedImageContainer>

Parameters:

file - the file to read

Returns:

the image container, null if failed to read

read

public BufferedImageContainer read(InputStream stream)

Reads the image from the stream. Caller must close the stream.

Specified by:

read in interface InputStreamImageReader<BufferedImageContainer>

Parameters:

stream - the stream to read from

Returns:

the image container, null if failed to read