Package adams.data.io.input

Class JAIImageReader

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.JAIImageReader

All Implemented Interfaces:

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

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

Java Advanced Imaging (JAI) image reader for: jpg, bmp, gif, png, jpeg, wbmp

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

-add-meta-data <boolean> (property: addMetaData)
    If enabled, any available meta-data gets added the image report.
    default: false
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_AddMetaData	whether to add the meta-data.
protected String[]	m_FormatExtensions	the format extensions.

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
JAIImageReader()

Method Summary

Modifier and Type	Method	Description
String	addMetaDataTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected BufferedImageContainer	doRead(PlaceholderFile file)	Performs the actual reading of the image file.
boolean	getAddMetaData()	Returns whether to add the meta-data.
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.
ImageReader	getReader()	Returns the reader for the default extension.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
BufferedImageContainer	read(InputStream stream)	Reads the image from the stream.
void	setAddMetaData(boolean value)	Sets whether to add the meta-data.

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

check, getDefaultFormatExtension, getReaders, isAvailable, postProcess, read

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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, getOptionManager, toCommandLine

Field Detail

m_AddMetaData

protected boolean m_AddMetaData

whether to add the meta-data.

m_FormatExtensions

protected String[] m_FormatExtensions

the format extensions.

Constructor Detail

JAIImageReader

public JAIImageReader()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

setAddMetaData

public void setAddMetaData(boolean value)

Sets whether to add the meta-data.

Parameters:

value - true if to add meta-data

getAddMetaData

public boolean getAddMetaData()

Returns whether to add the meta-data.

Returns:

true if to add the meta-data

addMetaDataTipText

public String addMetaDataTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

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

getReader

public ImageReader getReader()

Returns the reader for the default extension.

Returns:

the JAI reader

See Also:

AbstractImageReader.getDefaultFormatExtension()

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