org.jmrtd.lds

Class DisplayedImageInfo

java.lang.Object

org.jmrtd.lds.DisplayedImageInfo

All Implemented Interfaces:

java.io.Serializable, ImageInfo, LDSElement

public class DisplayedImageInfo
extends java.lang.Object

Data structure for storing either a Portrait (as used in DG5) or a Signature or mark (as used in DG7).

Version:

$Id: DisplayedImageInfo.java 1578 2015-04-09 08:10:27Z martijno $

Author:

The JMRTD team ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DISPLAYED_PORTRAIT_TAG
protected static int	DISPLAYED_SIGNATURE_OR_MARK_TAG

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

Constructor and Description
DisplayedImageInfo(java.io.InputStream in) Constructs a displayed image info from binary encoding.
DisplayedImageInfo(int type, byte[] imageBytes) Constructs a displayed image info from the image bytes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
byte[]	getEncoded() Encodes this image info.
int	getHeight() Gets the height of the image.
java.io.InputStream	getImageInputStream() Gets the encoded image as an input stream.
int	getImageLength() Gets the length of the encoded image.
java.lang.String	getMimeType() Gets the mime-type of the encoded image.
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(java.io.InputStream inputStream, long imageLength) Clients should call this method after positioning the input stream to the image bytes.
protected void	readObject(java.io.InputStream inputStream) Reads the displayed image.
protected void	setHeight(int height)
protected void	setImageBytes(byte[] imageBytes)
protected void	setMimeType(java.lang.String mimeType)
protected void	setType(int type)
protected void	setWidth(int width)
java.lang.String	toString() Gets a textual representation of this image info.
protected void	writeImage(java.io.OutputStream outputStream)
protected void	writeObject(java.io.OutputStream outputStream)

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAYED_PORTRAIT_TAG

protected static final int DISPLAYED_PORTRAIT_TAG

See Also:

Constant Field Values

DISPLAYED_SIGNATURE_OR_MARK_TAG

protected static final int DISPLAYED_SIGNATURE_OR_MARK_TAG

See Also:

Constant Field Values

Constructor Detail

DisplayedImageInfo

public DisplayedImageInfo(int type,
                          byte[] imageBytes)

Constructs a displayed image info from the image bytes.

Parameters:

type - one of ImageInfo.TYPE_PORTRAIT or ImageInfo.TYPE_SIGNATURE_OR_MARK

imageBytes - encoded image, for Portrait and Signature or mark use JPEG encoding

DisplayedImageInfo

public DisplayedImageInfo(java.io.InputStream in)
                   throws java.io.IOException

Constructs a displayed image info from binary encoding.

Parameters:

in - an input stream

Throws:

java.io.IOException - if decoding fails

Method Detail

readObject

protected void readObject(java.io.InputStream inputStream)
                   throws java.io.IOException

Reads the displayed image. This method should be implemented by concrete subclasses. The 5F2E or 7F2E tag and the length are already read.

Parameters:

inputStream - the input stream positioned so that biometric data block tag and length are already read

Throws:

java.io.IOException - if reading fails

writeObject

protected void writeObject(java.io.OutputStream outputStream)
                    throws java.io.IOException

Throws:

java.io.IOException

getRecordLength

public long getRecordLength()

Gets the record length.

Specified by:

getRecordLength in interface ImageInfo

Returns:

the record length

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 java.lang.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 java.lang.String toString()

Gets a textual representation of this image info.

Overrides:

toString in class java.lang.Object

Returns:

a textual representation of this image info

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getEncoded

public byte[] getEncoded()

Encodes this image info.

Specified by:

getEncoded in interface LDSElement

Returns:

a byte array containing the encoded image info

getImageInputStream

public java.io.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(java.io.InputStream inputStream,
                         long imageLength)
                  throws java.io.IOException

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

Parameters:

inputStream - input stream

imageLength - image length

Throws:

java.io.IOException - on error reading the input stream

writeImage

protected void writeImage(java.io.OutputStream outputStream)
                   throws java.io.IOException

Throws:

java.io.IOException

setMimeType

protected final void setMimeType(java.lang.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)