Package org.jmrtd.lds.iso19794

Class IrisBiometricSubtypeInfo

java.lang.Object

org.jmrtd.lds.AbstractLDSInfo

org.jmrtd.lds.AbstractListInfo<IrisImageInfo>

org.jmrtd.lds.iso19794.IrisBiometricSubtypeInfo

All Implemented Interfaces:

java.io.Serializable, LDSElement

public class IrisBiometricSubtypeInfo
extends AbstractListInfo<IrisImageInfo>

Iris biometric subtype data block (containing iris image data blocks) based on Section 6.5.3 and Table 3 of ISO/IEC 19794-6 2005.

Version:

$Revision: 1799 $

Author:

The JMRTD team ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	EYE_LEFT	Biometric subtype value.
static int	EYE_RIGHT	Biometric subtype value.
static int	EYE_UNDEF	Biometric subtype value.

Constructor Summary

Constructors

Constructor	Description
IrisBiometricSubtypeInfo(int biometricSubtype, int imageFormat, java.util.List<IrisImageInfo> irisImageInfos)	Constructs a biometric subtype info.
IrisBiometricSubtypeInfo(java.io.InputStream in, int imageFormat)	Constructs an iris biometric subtype from binary encoding.

Method Summary

Modifier and Type	Method	Description
void	addIrisImageInfo(IrisImageInfo irisImageInfo)	Adds an iris image info to this iris biometric subtype info.
boolean	equals(java.lang.Object obj)
int	getBiometricSubtype()	The biometric subtype (feature identifier).
int	getImageFormat()	Returns the image format used in the images encoded in this record.
java.util.List<IrisImageInfo>	getIrisImageInfos()	Returns the iris image infos embedded in this iris biometric subtype info.
long	getRecordLength()	Returns the record length.
int	hashCode()
void	readObject(java.io.InputStream inputStream)	Reads an iris biometric subtype from input stream.
void	removeIrisImageInfo(int index)	Removes an iris image info from this iris biometric subtype info.
java.lang.String	toString()
void	writeObject(java.io.OutputStream outputStream)	Writes an iris biometric subtype to output stream.

Methods inherited from class org.jmrtd.lds.AbstractListInfo

add, addAll, getSubRecords, remove

Methods inherited from class org.jmrtd.lds.AbstractLDSInfo

getEncoded

Methods inherited from class java.lang.Object

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

Field Detail

EYE_UNDEF

public static final int EYE_UNDEF

Biometric subtype value.

See Also:

Constant Field Values

EYE_RIGHT

public static final int EYE_RIGHT

Biometric subtype value.

See Also:

Constant Field Values

EYE_LEFT

public static final int EYE_LEFT

Biometric subtype value.

See Also:

Constant Field Values

Constructor Detail

IrisBiometricSubtypeInfo

public IrisBiometricSubtypeInfo(int biometricSubtype,
                                int imageFormat,
                                java.util.List<IrisImageInfo> irisImageInfos)

Constructs a biometric subtype info.

Parameters:

biometricSubtype - one of EYE_UNDEF, EYE_RIGHT, EYE_LEFT

imageFormat - the image format as specified in the IrisInfo of which this is a part

irisImageInfos - the iris image info records

IrisBiometricSubtypeInfo

public IrisBiometricSubtypeInfo(java.io.InputStream in,
                                int imageFormat)
                         throws java.io.IOException

Constructs an iris biometric subtype from binary encoding.

Parameters:

in - an input stream

imageFormat - the image format used

Throws:

java.io.IOException - if reading fails

Method Detail

readObject

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

Reads an iris biometric subtype from input stream.

Specified by:

readObject in class AbstractListInfo<IrisImageInfo>

Parameters:

inputStream - an input stream

Throws:

java.io.IOException - if reading fails

writeObject

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

Writes an iris biometric subtype to output stream.

Specified by:

writeObject in class AbstractListInfo<IrisImageInfo>

Parameters:

outputStream - an output stream

Throws:

java.io.IOException - if writing fails

getRecordLength

public long getRecordLength()

Returns the record length.

Returns:

the record length

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractListInfo<IrisImageInfo>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractListInfo<IrisImageInfo>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getBiometricSubtype

public int getBiometricSubtype()

The biometric subtype (feature identifier). Result is one of EYE_UNDEF, EYE_RIGHT, EYE_LEFT.

Returns:

the biometric subtype.

getImageFormat

public int getImageFormat()

Returns the image format used in the images encoded in this record.

Returns:

the image format

getIrisImageInfos

public java.util.List<IrisImageInfo> getIrisImageInfos()

Returns the iris image infos embedded in this iris biometric subtype info.

Returns:

the embedded iris image infos

addIrisImageInfo

public void addIrisImageInfo(IrisImageInfo irisImageInfo)

Adds an iris image info to this iris biometric subtype info.

Parameters:

irisImageInfo - the iris image info to add

removeIrisImageInfo

public void removeIrisImageInfo(int index)

Removes an iris image info from this iris biometric subtype info.

Parameters:

index - the index of the iris image info to remove