Class PHDImageFactory

java.lang.Object

com.ibm.dtfj.phd.PHDImageFactory

All Implemented Interfaces:

ImageFactory

public class PHDImageFactory
extends Object
implements ImageFactory

Field Summary

Fields declared in interface ImageFactory

DTFJ_LOGGER_NAME, DTFJ_MAJOR_VERSION, DTFJ_MINOR_VERSION, SYSTEM_PROPERTY_TMPDIR

Modifier and Type	Field	Description
static final String	DTFJ_LOGGER_NAME	This is the name of the java.util.logging.Logger subsystem to which DTFJ passes verbose messages.
static final int	DTFJ_MAJOR_VERSION	The major version number of the current API.
static final int	DTFJ_MINOR_VERSION	The minor version number of the current API.
static final String	SYSTEM_PROPERTY_TMPDIR	If the image is to be created from a core file inside an archive, this property controls where the file will extracted.

Constructor Summary

Constructors

Constructor	Description
PHDImageFactory()

Method Summary

Modifier and Type	Method	Description
int	getDTFJMajorVersion()	Fetch the DTFJ major version number.
int	getDTFJMinorVersion()	Fetch the DTFJ minor version number.
int	getDTFJModificationLevel()	Fetch the DTFJ modification level.
Image	getImage(File file)	Creates a new Image object based on the contents of imageFile.
Image	getImage(File file, File metaFile)	Creates a new Image object based on the contents of imageFile and metadata.
Image	getImage(ImageInputStream in, URI sourceID)	Creates a new Image object based on the contents of the given input stream.
Image	getImage(ImageInputStream in, ImageInputStream meta, URI sourceID)	Creates a new Image object based on the contents of the given input stream.
Image[]	getImagesFromArchive(File archive, boolean extract)	Creates an array of Image objects from an archive such as a zip or jar file.

Methods declared in class Object

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

Constructor Details

PHDImageFactory

public PHDImageFactory()

Method Details

getImage

public Image getImage(ImageInputStream in,
 URI sourceID)
               throws IOException

Description copied from interface: ImageFactory

Creates a new Image object based on the contents of the given input stream.

Specified by:

getImage in interface ImageFactory

Parameters:

in - a stream with image information, typically a core file

sourceID - URI identifying the source of the image stream

Returns:

an instance of Image

Throws:

IOException - if there's a problem reading the given stream

getImage

public Image getImage(ImageInputStream in,
 ImageInputStream meta,
 URI sourceID)
               throws IOException

Description copied from interface: ImageFactory

Creates a new Image object based on the contents of the given input stream.

Specified by:

getImage in interface ImageFactory

Parameters:

in - a stream with image information, typically a core file

meta - a stream with metadata associated with the image stream

sourceID - URI identifying the source of the image stream

Returns:

an instance of Image

Throws:

IOException - if there's a problem reading the given streams

getImagesFromArchive

public Image[] getImagesFromArchive(File archive,
 boolean extract)
                             throws IOException

Description copied from interface: ImageFactory

Creates an array of Image objects from an archive such as a zip or jar file.

Specified by:

getImagesFromArchive in interface ImageFactory

Parameters:

archive - which typically contains one or more diagnostic artifacts

extract - true if the files in the archive should be extracted to a temporary directory

Returns:

an array of Images

Throws:

IOException - if there's a problem reading the specified archive

getDTFJMajorVersion

public int getDTFJMajorVersion()

Description copied from interface: ImageFactory

Fetch the DTFJ major version number.

Specified by:

getDTFJMajorVersion in interface ImageFactory

Returns:

an integer corresponding to the DTFJ API major version number

getDTFJMinorVersion

public int getDTFJMinorVersion()

Description copied from interface: ImageFactory

Fetch the DTFJ minor version number.

Specified by:

getDTFJMinorVersion in interface ImageFactory

Returns:

an integer corresponding to the DTFJ API minor version number

getImage

public Image getImage(File file)
               throws IOException

Description copied from interface: ImageFactory

Creates a new Image object based on the contents of imageFile.

Specified by:

getImage in interface ImageFactory

Parameters:

file - a file with Image information, typically a core file

Returns:

an instance of Image

Throws:

IOException - if there's a problem reading the specified file

getImage

public Image getImage(File file,
 File metaFile)
               throws IOException

Description copied from interface: ImageFactory

Creates a new Image object based on the contents of imageFile and metadata.

Specified by:

getImage in interface ImageFactory

Parameters:

file - a file with image information, typically a core file

metaFile - an (implementation-defined) file with additional image information (or null if not required)

Returns:

an instance of Image

Throws:

IOException - if there's a problem reading either of the specified files

getDTFJModificationLevel

public int getDTFJModificationLevel()

Description copied from interface: ImageFactory

Fetch the DTFJ modification level.

Specified by:

getDTFJModificationLevel in interface ImageFactory

Returns:

an integer corresponding to the DTFJ API modification level