org.apache.commons.validator.routines.LeitwegValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of isoiec7064 Show documentation
A Java library to calculate and validate ISO/IEC 7064 System check digits.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.validator.routines;

import org.apache.commons.validator.routines.checkdigit.Modulus97CheckDigit;

/**
 * Leitweg Validator.
 * 
 * In e-invoices to German public entities there is a specific identification schema called Leitweg-ID.
 *  The schema can be found in the most recent version of the
 *  ISO 6523 ICD list.
 *  The prefix of this specfic ICD identifier is 0204.
 * 
 * 
 * The spec "Formatspezifikation Leitweg-ID 2.0.1" (in deu) can be found in
 * KoSIT.
 *
 *  In short: there are three parts separated by "-" HYPHEN-MINUS
 * 

 * - a mandatory numeric general starting with two chars region id, "02" for Hamburg, "99" for federal institutons
 * 

 * - an optional alphanumeric detail
 * 

 * - two mandatory check digits calculated according to modulus 97 algorithm
 * 

 * 
 *
 * Example: 992-90009-96 for         Deutsche Bahn AG
 */
public class LeitwegValidator {

    private static final char MINUS = '\u002D'; // '-' Separator
/* first two digits designate the individual German state, here with ISO 3166-2 country subdivision code
• 01 DE-SH Schleswig-Holstein 
• 02 DE-HH Hamburg 
• 03 DE-NI Niedersachsen 
• 04 DE-HB Bremen 
• 05 DE-NW Nordrhein-Westfalen 
• 06 DE-HE Hessen 
• 07 DE-RP Rheinland-Pfalz 
• 08 DE-BW Baden-Württemberg 
• 09 DE-BY Bayern 
• 10 DE-SL Saarland 
• 11 DE-BE Berlin 
• 12 DE-BB Brandenburg 
• 13 DE-MV Mecklenburg-Vorpommern 
• 14 DE-SN Sachsen 
• 15 DE-ST Sachsen-Anhalt 
• 16 DE-TH Thüringen 
• 99 DE Bund
 */
    private static final String STARTWITHREGION = "^(01|02|03|04|05|06|07|08|09|10|11|12|13|14|16|99)"; 
    private static final String OPTIONAL_DETAIL = MINUS + "([A-Za-z0-9]{1,30})?"; // optional alphanumeric detail
    private static final String MD_CHECK_DIGITS = MINUS + "(\\d{2})$";            // two mandatory check digits
    // Regierungsbezirk (\\d) + Landkreis (\\d{2}) + Gemeinde (3, 4 oder 7 Stellen)
    private static final String FORMAT1 = STARTWITHREGION + "(\\d)?(\\d{2})?"
        + OPTIONAL_DETAIL + MD_CHECK_DIGITS;
    private static final String FORMAT2 = STARTWITHREGION + "(\\d\\d{2}\\d{7})"
        + OPTIONAL_DETAIL + MD_CHECK_DIGITS;
    private static final String FORMAT3 = STARTWITHREGION + "(\\d\\d{2}\\d{4})"
        + OPTIONAL_DETAIL + MD_CHECK_DIGITS;
    private static final String FORMAT4 = STARTWITHREGION + "(\\d\\d{2}\\d{3})"
        + OPTIONAL_DETAIL + MD_CHECK_DIGITS;
    private static final String[] FORMAT = new String[] {FORMAT1, FORMAT2, FORMAT3, FORMAT4};

    /*
     * in theory the shortest Leitweg-ID has a minimal general part and check digits
     *  99-92
     */
    private static final int MIN_CODE_LEN = 5;

    /*
     * sum of
     * maximal general part length: 12
     * maximal detail part length: 30
     * check digits length: 2
     */
    private static final int MAX_CODE_LEN = 44;

    private static final CodeValidator VALIDATOR = new CodeValidator(new RegexValidator(FORMAT), MIN_CODE_LEN, MAX_CODE_LEN, Modulus97CheckDigit.getInstance());

    /** The singleton instance which uses the default formats */
    private static final LeitwegValidator DEFAULT_LEITWEG_VALIDATOR = new LeitwegValidator();

    /**
     * Return a singleton instance of the validator using the default formats
     *
     * @return A singleton instance of the validator
     */
    public static LeitwegValidator getInstance() {
        return DEFAULT_LEITWEG_VALIDATOR;
    }

    /**
     * Validate a Leitweg-ID
     *
     * @param id The value validation is being performed on
     * @return true if the value is valid
     */
    public boolean isValid(String id) {
        return VALIDATOR.isValid(id);
    }

    private String removeMinus(String id) {
        return id.replace("" + MINUS, "");
    }

    /**
     * Check the id is a valid MOD 97-10 id.
     * 
     * If valid, this method returns the Leitweg-ID with
     * formatting characters removed (i.e. hyphen).
     * 
     * @param code The Leitweg-ID to validate.
     * @return A Leitweg-ID without hyphen if valid, otherwise null.
     *
     * 
     * Note
     * The return is not valid Leitweg-ID because HYPHEN-MINUS is part of the format.
     * 
     */
    public String validate(String code) {
        if (isValid(code)) {
            return removeMinus(code);
        }
        return null;
    }
}