org.jmrtd.lds

Class AbstractImageInfo

java.lang.Object

org.jmrtd.lds.AbstractImageInfo

All Implemented Interfaces:

Serializable, ImageInfo, LDSElement

Direct Known Subclasses:

DisplayedImageInfo, FaceImageInfo, FingerImageInfo, IrisImageInfo

public abstract class AbstractImageInfo
extends Object
implements ImageInfo

Base class for image infos.

Version:

$Revision: 1613 $

Author:

The JMRTD team ([email protected])

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.jmrtd.lds.ImageInfo

JPEG_MIME_TYPE, JPEG2000_MIME_TYPE, TYPE_FINGER, TYPE_IRIS, TYPE_PORTRAIT, TYPE_SIGNATURE_OR_MARK, WSQ_MIME_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractImageInfo(int type)
	AbstractImageInfo(int type, int width, int height, InputStream inputStream, long imageLength, String mimeType) Constructs an abstract image info.
protected	AbstractImageInfo(int type, String mimeType)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
byte[]	getEncoded() Encodes this image info.
int	getHeight() Gets the height of the image.
InputStream	getImageInputStream() Gets the encoded image as an input stream.
int	getImageLength() Gets the length of the encoded image.
String	getMimeType() Gets the mime-type of the encoded image.
abstract long	getRecordLength() Gets the record length.
int	getType() Content type, one of ImageInfo.TYPE_PORTRAIT, ImageInfo.TYPE_FINGER, ImageInfo.TYPE_IRIS, ImageInfo.TYPE_SIGNATURE_OR_MARK.
int	getWidth() Gets the width of the image.
int	hashCode()
protected void	readImage(InputStream inputStream, long imageLength) Clients should call this method after positioning the input stream to the image bytes.
protected abstract void	readObject(InputStream in)
protected void	setHeight(int height)
protected void	setImageBytes(byte[] imageBytes)
protected void	setMimeType(String mimeType)
protected void	setType(int type)
protected void	setWidth(int width)
String	toString() Gets a textual representation of this image info.
protected void	writeImage(OutputStream outputStream)
protected abstract void	writeObject(OutputStream out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractImageInfo

protected AbstractImageInfo(int type)

AbstractImageInfo

protected AbstractImageInfo(int type,
                            String mimeType)

AbstractImageInfo

public AbstractImageInfo(int type,
                         int width,
                         int height,
                         InputStream inputStream,
                         long imageLength,
                         String mimeType)
                  throws IOException

Constructs an abstract image info.

Parameters:

type - type of image info

width - width of image

height - height of image

inputStream - encoded image

imageLength - length of encoded image

mimeType - mime-type of encoded image

Throws:

IOException - if reading fails

Method Detail

getType

public int getType()

Content type, one of ImageInfo.TYPE_PORTRAIT, ImageInfo.TYPE_FINGER, ImageInfo.TYPE_IRIS, ImageInfo.TYPE_SIGNATURE_OR_MARK.

Specified by:

getType in interface ImageInfo

Returns:

content type

getMimeType

public String getMimeType()

Gets the mime-type of the encoded image.

Specified by:

getMimeType in interface ImageInfo

Returns:

the mime-type of the encoded image

getWidth

public int getWidth()

Gets the width of the image.

Specified by:

getWidth in interface ImageInfo

Returns:

the width of the image

getHeight

public int getHeight()

Gets the height of the image.

Specified by:

getHeight in interface ImageInfo

Returns:

the height of the image

getImageLength

public int getImageLength()

Gets the length of the encoded image.

Specified by:

getImageLength in interface ImageInfo

Returns:

the length of the encoded image

toString

public String toString()

Gets a textual representation of this image info.

Overrides:

toString in class Object

Returns:

a textual representation of this image info

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getEncoded

public byte[] getEncoded()

Encodes this image info.

Specified by:

getEncoded in interface LDSElement

Returns:

a byte array containing the encoded image info

getRecordLength

public abstract long getRecordLength()

Gets the record length.

Specified by:

getRecordLength in interface ImageInfo

Returns:

the record length

getImageInputStream

public InputStream getImageInputStream()

Gets the encoded image as an input stream.

Specified by:

getImageInputStream in interface ImageInfo

Returns:

an input stream containing the encoded image

readImage

protected void readImage(InputStream inputStream,
                         long imageLength)
                  throws IOException

Clients should call this method after positioning the input stream to the image bytes.

Parameters:

inputStream - input stream

imageLength - image length

Throws:

IOException - on error reading the input stream

writeImage

protected void writeImage(OutputStream outputStream)
                   throws IOException

Throws:

IOException

setMimeType

protected final void setMimeType(String mimeType)

setType

protected final void setType(int type)

setWidth

protected final void setWidth(int width)

setHeight

protected final void setHeight(int height)

setImageBytes

protected final void setImageBytes(byte[] imageBytes)

readObject

protected abstract void readObject(InputStream in)
                            throws IOException

Throws:

IOException

writeObject

protected abstract void writeObject(OutputStream out)
                             throws IOException

Throws:

IOException