org.jmrtd.lds

Class DG11File

java.lang.Object

org.jmrtd.lds.DataGroup

org.jmrtd.lds.DG11File

All Implemented Interfaces:

java.io.Serializable, LDSElement, LDSFile

public class DG11File
extends DataGroup

File structure for the EF_DG11 file. Datagroup 11 contains additional personal detail(s). All fields are optional. See Section 16 of LDS-TR.

1. Name of Holder (Primary and Secondary Identifiers, in full)
2. Other Name(s)
3. Personal Number
4. Place of Birth
5. Date of Birth (in full)
6. Address
7. Telephone Number(s)
8. Profession
9. Title
10. Personal Summary
11. Proof of Citizenship [see 14.5.1]
12. Number of Other Valid Travel Documents
13. Other Travel Document Numbers
14. Custody Information

Version:

$Revision: 1573 $

Author:

The JMRTD team ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_SPECIFIC_CONSTRUCTED_TAG
static int	COUNT_TAG
static int	CUSTODY_INFORMATION_TAG
static int	FULL_DATE_OF_BIRTH_TAG
static int	FULL_NAME_TAG
static int	OTHER_NAME_TAG
static int	OTHER_VALID_TD_NUMBERS_TAG
static int	PERMANENT_ADDRESS_TAG
static int	PERSONAL_NUMBER_TAG
static int	PERSONAL_SUMMARY_TAG
static int	PLACE_OF_BIRTH_TAG
static int	PROFESSION_TAG
static int	PROOF_OF_CITIZENSHIP_TAG
static int	TAG_LIST_TAG
static int	TELEPHONE_TAG
static int	TITLE_TAG

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
DG11File(java.io.InputStream inputStream) Constructs a file from binary representation.
DG11File(java.lang.String nameOfHolder, java.util.List<java.lang.String> otherNames, java.lang.String personalNumber, java.util.Date fullDateOfBirth, java.util.List<java.lang.String> placeOfBirth, java.util.List<java.lang.String> permanentAddress, java.lang.String telephone, java.lang.String profession, java.lang.String title, java.lang.String personalSummary, byte[] proofOfCitizenship, java.util.List<java.lang.String> otherValidTDNumbers, java.lang.String custodyInformation) Constructs a new file.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCustodyInformation() Gets custody information.
byte[]	getEncoded() Gets the contents of this file as byte array, includes the ICAO tag and length.
java.util.Date	getFullDateOfBirth() Gets the full date of birth.
java.lang.String	getNameOfHolder() Gets the full name of the holder (primary and secondary identifiers).
java.util.List<java.lang.String>	getOtherNames() Gets the other names.
java.util.List<java.lang.String>	getOtherValidTDNumbers() Gets the other valid TD numbers.
java.util.List<java.lang.String>	getPermanentAddress() Gets the permanent address.
java.lang.String	getPersonalNumber() Gets the personal number.
java.lang.String	getPersonalSummary() Gets the personal summary.
java.util.List<java.lang.String>	getPlaceOfBirth() Gets the place of birth.
java.lang.String	getProfession() Gets the profession.
byte[]	getProofOfCitizenship() Gets the proof of citizenship.
int	getTag() The data group tag.
java.util.List<java.lang.Integer>	getTagPresenceList() Gets list of tags of fields actually present.
java.lang.String	getTelephone() Gets the telephone number.
java.lang.String	getTitle() Gets the title.
int	hashCode()
protected void	readContent(java.io.InputStream inputStream) Reads the contents of the data group from an input stream.
java.lang.String	toString() Gets a textual representation of this file.
protected void	writeContent(java.io.OutputStream out) Writes the contents of the data group to an output stream.

Methods inherited from class org.jmrtd.lds.DataGroup

getLength, readObject, writeObject

Methods inherited from class java.lang.Object

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

Field Detail

TAG_LIST_TAG

public static final int TAG_LIST_TAG

See Also:

Constant Field Values

FULL_NAME_TAG

public static final int FULL_NAME_TAG

See Also:

Constant Field Values

OTHER_NAME_TAG

public static final int OTHER_NAME_TAG

See Also:

Constant Field Values

PERSONAL_NUMBER_TAG

public static final int PERSONAL_NUMBER_TAG

See Also:

Constant Field Values

FULL_DATE_OF_BIRTH_TAG

public static final int FULL_DATE_OF_BIRTH_TAG

See Also:

Constant Field Values

PLACE_OF_BIRTH_TAG

public static final int PLACE_OF_BIRTH_TAG

See Also:

Constant Field Values

PERMANENT_ADDRESS_TAG

public static final int PERMANENT_ADDRESS_TAG

See Also:

Constant Field Values

TELEPHONE_TAG

public static final int TELEPHONE_TAG

See Also:

Constant Field Values

PROFESSION_TAG

public static final int PROFESSION_TAG

See Also:

Constant Field Values

TITLE_TAG

public static final int TITLE_TAG

See Also:

Constant Field Values

PERSONAL_SUMMARY_TAG

public static final int PERSONAL_SUMMARY_TAG

See Also:

Constant Field Values

PROOF_OF_CITIZENSHIP_TAG

public static final int PROOF_OF_CITIZENSHIP_TAG

See Also:

Constant Field Values

OTHER_VALID_TD_NUMBERS_TAG

public static final int OTHER_VALID_TD_NUMBERS_TAG

See Also:

Constant Field Values

CUSTODY_INFORMATION_TAG

public static final int CUSTODY_INFORMATION_TAG

See Also:

Constant Field Values

CONTENT_SPECIFIC_CONSTRUCTED_TAG

public static final int CONTENT_SPECIFIC_CONSTRUCTED_TAG

See Also:

Constant Field Values

COUNT_TAG

public static final int COUNT_TAG

See Also:

Constant Field Values

Constructor Detail

DG11File

public DG11File(java.lang.String nameOfHolder,
                java.util.List<java.lang.String> otherNames,
                java.lang.String personalNumber,
                java.util.Date fullDateOfBirth,
                java.util.List<java.lang.String> placeOfBirth,
                java.util.List<java.lang.String> permanentAddress,
                java.lang.String telephone,
                java.lang.String profession,
                java.lang.String title,
                java.lang.String personalSummary,
                byte[] proofOfCitizenship,
                java.util.List<java.lang.String> otherValidTDNumbers,
                java.lang.String custodyInformation)

Constructs a new file. Use null if data element is not present. Use '<' as separator.

Parameters:

nameOfHolder - data element

otherNames - data element

personalNumber - data element

fullDateOfBirth - data element

placeOfBirth - data element

permanentAddress - data element

telephone - data element

profession - data element

title - data element

personalSummary - data element

proofOfCitizenship - data element

otherValidTDNumbers - data element

custodyInformation - data element

DG11File

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

Constructs a file from binary representation.

Parameters:

inputStream - an input stream

Throws:

java.io.IOException - if reading fails

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

getTag

public int getTag()

Description copied from class: DataGroup

The data group tag.

Overrides:

getTag in class DataGroup

Returns:

the tag of the data group

getTagPresenceList

public java.util.List<java.lang.Integer> getTagPresenceList()

Gets list of tags of fields actually present.

Returns:

list of tags

getNameOfHolder

public java.lang.String getNameOfHolder()

Gets the full name of the holder (primary and secondary identifiers).

Returns:

the name of holder

getOtherNames

public java.util.List<java.lang.String> getOtherNames()

Gets the other names.

Returns:

the other names, or empty list when not present

getPersonalNumber

public java.lang.String getPersonalNumber()

Gets the personal number.

Returns:

the personal number

getFullDateOfBirth

public java.util.Date getFullDateOfBirth()

Gets the full date of birth.

Returns:

the full date of birth

getPlaceOfBirth

public java.util.List<java.lang.String> getPlaceOfBirth()

Gets the place of birth.

Returns:

the place of birth

getPermanentAddress

public java.util.List<java.lang.String> getPermanentAddress()

Gets the permanent address.

Returns:

the permanentAddress

getTelephone

public java.lang.String getTelephone()

Gets the telephone number.

Returns:

the telephone

getProfession

public java.lang.String getProfession()

Gets the profession.

Returns:

the profession

getTitle

public java.lang.String getTitle()

Gets the title.

Returns:

the title

getPersonalSummary

public java.lang.String getPersonalSummary()

Gets the personal summary.

Returns:

the personalSummary

getProofOfCitizenship

public byte[] getProofOfCitizenship()

Gets the proof of citizenship.

Returns:

the proofOfCitizenship

getOtherValidTDNumbers

public java.util.List<java.lang.String> getOtherValidTDNumbers()

Gets the other valid TD numbers.

Returns:

the otherValidTDNumbers

getCustodyInformation

public java.lang.String getCustodyInformation()

Gets custody information.

Returns:

the custodyInformation

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

writeContent

protected void writeContent(java.io.OutputStream out)
                     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:

out - the output stream to write to

Throws:

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

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