org.jmrtd.lds

Class DG4File

java.lang.Object

org.jmrtd.lds.DataGroup

org.jmrtd.lds.DG4File

All Implemented Interfaces:

java.io.Serializable, LDSElement, LDSFile

public class DG4File
extends DataGroup

File structure for the EF_DG4 file. Based on ISO/IEC 19794-6.

Version:

$Revision: 1562 $

Author:

Martijn Oostdijk ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.logging.Logger	LOGGER

Fields inherited from interface org.jmrtd.lds.LDSFile

EF_COM_TAG, EF_DG1_TAG, EF_DG10_TAG, EF_DG11_TAG, EF_DG12_TAG, EF_DG13_TAG, EF_DG14_TAG, EF_DG15_TAG, EF_DG16_TAG, EF_DG2_TAG, EF_DG3_TAG, EF_DG4_TAG, EF_DG5_TAG, EF_DG6_TAG, EF_DG7_TAG, EF_DG8_TAG, EF_DG9_TAG, EF_SOD_TAG

Constructor Summary

Constructors

Constructor and Description
DG4File(java.io.InputStream inputStream) Constructs a new file based on an input stream.
DG4File(java.util.List<IrisInfo> irisInfos) Creates a new file with the specified records.
DG4File(java.util.List<IrisInfo> irisInfos, boolean shouldAddRandomDataIfEmpty) Creates a new file with the specified records.

Method Summary

Modifier and Type	Method and Description
void	addIrisInfo(IrisInfo irisInfo) Adds an iris info to this file.
boolean	equals(java.lang.Object other)
byte[]	getEncoded() Gets the contents of this file as byte array, includes the ICAO tag and length.
java.util.List<IrisInfo>	getIrisInfos() Gets the embedded iris infos in this file.
int	hashCode()
protected void	readContent(java.io.InputStream inputStream) Reads the contents of the data group from an input stream.
void	removeIrisInfo(int index) Removes an iris info from this file.
java.lang.String	toString() Gets a textual representation of this file.
protected void	writeContent(java.io.OutputStream outputStream) Writes the contents of the data group to an output stream.
protected void	writeOptionalRandomData(java.io.OutputStream outputStream) Concrete implementations of EAC protected CBEFF DataGroups should call this method at the end of their DataGroup.writeContent(OutputStream) method to add some random data if the record contains zero biometric templates.

Methods inherited from class org.jmrtd.lds.DataGroup

getLength, getTag, readObject, writeObject

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final java.util.logging.Logger LOGGER

Constructor Detail

DG4File

public DG4File(java.util.List<IrisInfo> irisInfos)

Creates a new file with the specified records.

Parameters:

irisInfos - records

DG4File

public DG4File(java.util.List<IrisInfo> irisInfos,
               boolean shouldAddRandomDataIfEmpty)

Creates a new file with the specified records.

Parameters:

irisInfos - records

shouldAddRandomDataIfEmpty - indicates whether the encoder should add random data when no templates are present

DG4File

public DG4File(java.io.InputStream inputStream)
        throws java.io.IOException

Constructs a new file based on an input stream.

Parameters:

inputStream - an input stream

Throws:

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

Method Detail

readContent

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

Description copied from class: DataGroup

Reads the contents of the data group from an input stream. Client code implementing this method should only read the contents from the input stream, not the tag or length of the data group.

Specified by:

readContent in class DataGroup

Parameters:

inputStream - the input stream to read from

Throws:

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

writeContent

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

Description copied from class: DataGroup

Writes the contents of the data group to an output stream. Client code implementing this method should only write the contents to the output stream, not the tag or length of the data group.

Specified by:

writeContent in class DataGroup

Parameters:

outputStream - the output stream to write to

Throws:

java.io.IOException - on error writing to output stream

toString

public java.lang.String toString()

Gets a textual representation of this file.

Overrides:

toString in class DataGroup

Returns:

a textual representation of this file

getIrisInfos

public java.util.List<IrisInfo> getIrisInfos()

Gets the embedded iris infos in this file.

Returns:

iris infos

addIrisInfo

public void addIrisInfo(IrisInfo irisInfo)

Adds an iris info to this file.

Parameters:

irisInfo - an iris info

removeIrisInfo

public void removeIrisInfo(int index)

Removes an iris info from this file.

Parameters:

index - the index of the iris info to remove

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

writeOptionalRandomData

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

Concrete implementations of EAC protected CBEFF DataGroups should call this method at the end of their DataGroup.writeContent(OutputStream) method to add some random data if the record contains zero biometric templates. See supplement to ICAO Doc 9303 R7-p1_v2_sIII_0057.

Parameters:

outputStream - the outputstream

Throws:

java.io.IOException - on I/O errors

getEncoded

public byte[] getEncoded()

Gets the contents of this file as byte array, includes the ICAO tag and length.

Specified by:

getEncoded in interface LDSElement

Returns:

a byte array containing the file