com.innovatrics.mrz.records.FrenchIdCard Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mrz-java Show documentation
Provides Java MRZ parser
The newest version!
/**
 * Java parser for the MRZ records, as specified by the ICAO organization.
 * Copyright (C) 2011 Innovatrics s.r.o.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package com.innovatrics.mrz.records;

import com.innovatrics.mrz.MrzParseException;
import com.innovatrics.mrz.MrzParser;
import com.innovatrics.mrz.MrzRange;
import com.innovatrics.mrz.MrzRecordOptional;
import com.innovatrics.mrz.types.MrzDocumentCode;
import com.innovatrics.mrz.types.MrzFormat;

/**
 * Format used for French ID Cards. The structure of the card: 2 lines of 36 characters :
 *  * First line : IDFRA{name}{many < to complete line}{6 numbers unknown} Second line : {card number on 12 numbers}{Check digit}{given names
 * separated by "<<" and maybe troncated if too long}{date of birth YYMMDD}{Check digit}{sex M/F}{1 number checksum}
 * 
 *
 * @author Pierrick Martin, Marin Moulinier
 */
public class FrenchIdCard extends MrzRecordOptional {

	private static final long serialVersionUID = 1L;

	/**
	 * Construct French ID Record.
	 */
	public FrenchIdCard() {
		super(MrzFormat.FRENCH_ID, "FrenchIdCard");
		setCode(MrzDocumentCode.TYPE_I);
		setCode1('I');
		setCode2('D');
	}

	@Override
	public void fromMrz(final String mrz) throws MrzParseException {
		super.fromMrz(mrz);
		final MrzParser parser = new MrzParser(mrz);
		//Special because surname and firstname not on the same line
		String[] name = new String[]{"", ""};
		name[0] = parser.parseString(new MrzRange(5, 30, 0));
		name[1] = parser.parseString(new MrzRange(13, 27, 1));
		setName(name);
		setNationality(parser.parseString(new MrzRange(2, 5, 0)));
		setOptional(parser.parseString(new MrzRange(30, 36, 0)));
		setDocumentNumber(parser.parseString(new MrzRange(0, 12, 1)));
		setValidDocumentNumber(parser.checkDigit(12, 1, new MrzRange(0, 12, 1), "document number"));
		setDateOfBirth(parser.parseDate(new MrzRange(27, 33, 1)));
		setValidDateOfBirth(parser.checkDigit(33, 1, new MrzRange(27, 33, 1), "date of birth") && getDateOfBirth().isDateValid());
		setSex(parser.parseSex(34, 1));
		final String finalChecksum = mrz.replace("\n", "").substring(0, 36 + 35);
		setValidComposite(parser.checkDigit(35, 1, finalChecksum, "final checksum"));
		// TODO expirationDate is missing
	}

	@Override
	public String toMrz() {
		final StringBuilder sb = new StringBuilder("IDFRA");
		// first row
		sb.append(MrzParser.toMrz(getSurname(), 25));
		sb.append(MrzParser.toMrz(getOptional(), 6));
		sb.append('\n');
		// second row
		sb.append(MrzParser.toMrz(getDocumentNumber(), 12));
		sb.append(MrzParser.computeCheckDigitChar(MrzParser.toMrz(getDocumentNumber(), 12)));
		sb.append(MrzParser.toMrz(getGivenNames(), 14));
		sb.append(getDateOfBirth().toMrz());
		sb.append(MrzParser.computeCheckDigitChar(getDateOfBirth().toMrz()));
		sb.append(getSex().getMrz());
		sb.append(MrzParser.computeCheckDigitChar(sb.toString().replace("\n", "")));
		sb.append('\n');
		return sb.toString();
	}

}