org.jmrtd.lds

Class FaceInfo

java.lang.Object

org.jmrtd.lds.FaceInfo

All Implemented Interfaces:

java.io.Serializable, BiometricDataBlock, LDSElement

public class FaceInfo
extends java.lang.Object
implements BiometricDataBlock

A facial record consists of a facial record header and one or more facial record datas. See 5.1 of ISO 19794-5.

Author:

The JMRTD team ([email protected])

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FaceInfo(java.io.InputStream inputStream) Constructs a face info from binary encoding.
FaceInfo(java.util.List<FaceImageInfo> faceImageInfos) Constructs a face info from a list of face image infos.
FaceInfo(StandardBiometricHeader sbh, java.io.InputStream inputStream) Constructs a face info from binary encoding.
FaceInfo(StandardBiometricHeader sbh, java.util.List<FaceImageInfo> faceImageInfos) Constructs a face info from a list of face image infos.

Method Summary

Modifier and Type	Method and Description
void	addFaceImageInfo(FaceImageInfo faceImageInfo) Adds a face image info to this face info.
boolean	equals(java.lang.Object other)
byte[]	getEncoded() Gets the encoded contents of this LDS info.
java.util.List<FaceImageInfo>	getFaceImageInfos() Gets the face image infos embedded in this face info.
StandardBiometricHeader	getStandardBiometricHeader() Gets the standard biometric header of this biometric data block
int	hashCode()
void	readObject(java.io.InputStream inputStream) Reads the facial record from an input stream.
void	removeFaceImageInfo(int index) Removes a face image info from this face info.
void	writeObject(java.io.OutputStream outputStream) Writes the facial record to an output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

FaceInfo

public FaceInfo(java.util.List<FaceImageInfo> faceImageInfos)

Constructs a face info from a list of face image infos.

Parameters:

faceImageInfos - face image infos

FaceInfo

public FaceInfo(StandardBiometricHeader sbh,
                java.util.List<FaceImageInfo> faceImageInfos)

Constructs a face info from a list of face image infos.

Parameters:

sbh - the standard biometric header to use

faceImageInfos - face image infos

FaceInfo

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

Constructs a face info from binary encoding.

Parameters:

inputStream - an input stream

Throws:

java.io.IOException - when decoding fails

FaceInfo

public FaceInfo(StandardBiometricHeader sbh,
                java.io.InputStream inputStream)
         throws java.io.IOException

Constructs a face info from binary encoding.

Parameters:

sbh - the standard biometric header to use

inputStream - an input stream

Throws:

java.io.IOException - when decoding fails

Method Detail

readObject

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

Reads the facial record from an input stream. Note that the standard biometric header has already been read.

Parameters:

inputStream - the input stream

Throws:

java.io.IOException

writeObject

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

Writes the facial record to an output stream. Note that the standard biometric header (part of CBEFF structure) is not written here.

Parameters:

outputStream - an output stream

Throws:

java.io.IOException

getStandardBiometricHeader

public StandardBiometricHeader getStandardBiometricHeader()

Gets the standard biometric header of this biometric data block

Specified by:

getStandardBiometricHeader in interface BiometricDataBlock

Returns:

the standard biometric header

getFaceImageInfos

public java.util.List<FaceImageInfo> getFaceImageInfos()

Gets the face image infos embedded in this face info.

Returns:

the embedded face image infos

addFaceImageInfo

public void addFaceImageInfo(FaceImageInfo faceImageInfo)

Adds a face image info to this face info.

Parameters:

faceImageInfo - the face image info to add

removeFaceImageInfo

public void removeFaceImageInfo(int index)

Removes a face image info from this face info.

Parameters:

index - the index of the face image 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

getEncoded

public byte[] getEncoded()

Description copied from interface: LDSElement

Gets the encoded contents of this LDS info.

Specified by:

getEncoded in interface LDSElement

Returns:

a byte array containing the encoding of this LDS info