de.jfachwert.pruefung.Mod11Verfahren.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Implementierung einiger Fachwerte nach dem WAM-Ansatz
There is a newer version: 6.0.1
/*
 * Copyright (c) 2017-2022 by Oliver Boehm
 *
 * Licensed 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 orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 19.03.17 by oliver ([email protected])
 */
package de.jfachwert.pruefung

import de.jfachwert.PruefzifferVerfahren
import de.jfachwert.pruefung.exception.LocalizedValidationException
import de.jfachwert.pruefung.exception.PruefzifferException

/**
 * Das Modulo-11-Verfahren wird fuer die 11-stellige Steuer-Identifikationsnummer
 * und die Umsatzsteuer-Identificationsnummer verwendet. Sie ist in
 * "DIN ISO 7964, Mod 11, 10" beschreiben (s.a.
 * http://www.jura.uni-sb.de/BGBl/TEIL1/1993/19930736.1.HTML).
 *
 * @author oliver ([email protected])
 * @since 0.1.0
 */
open class Mod11Verfahren(private val anzahlStellen: Int) : PruefzifferVerfahren {

    /**
     * Die letzte Ziffer ist die Pruefziffer, die hierueber abgefragt werden
     * kann.
     *
     * @param wert Fachwert oder gekapselter Wert
     * @return Wert zwischen 0 und 9
     */
    override fun getPruefziffer(wert: String): String {
        return wert.substring(wert.length - 1)
    }

    /**
     * Diese Methode ist aber nur fuer die 11-stellige Steuer-Identifikationsnummer
     * (TIN) implementiert. Fuer andere Steuernummer kommt eine
     * [IllegalArgumentException].
     *
     * @param wert Fachwert oder gekapselter Wert
     * @return the boolean
     */
    override fun isValid(wert: String): Boolean {
        val n = anzahlStellen + 1
        require(wert.length == n) { "Nummer '$wert' ist nicht $n Zeichen lang" }
        val pruefziffer = getPruefziffer(wert)
        return pruefziffer == berechnePruefziffer(wert.substring(0, wert.length - 1))
    }

    /**
     * Berechnet die Pruefziffer des uebergebenen Wertes.
     * Die Berechung stammt aus Wikipedia und wurde nach Java uebersetzt
     * (s. https://de.wikipedia.org/wiki/Steuer-Identifikationsnummer).
     *
     * Der Ausgangswert fuer die Berechnung kann mit oder ohne Pruefziffer
     * uebergeben werden. Es werden nur die ersten 10 Ziffern zur Ermittlung
     * der Pruefziffer herangezogen.
     *
     * @param wert Wert (mit oder ohne Pruefziffer)
     * @return errechnete Pruefziffer
     */
    override fun berechnePruefziffer(wert: String): String {
        val ziffernfolge = wert.toCharArray()
        var produkt = 10
        for (stelle in 1..anzahlStellen) {
            var summe = (Character.getNumericValue(ziffernfolge[stelle - 1]) + produkt) % 10
            if (summe == 0) {
                summe = 10
            }
            produkt = summe * 2 % 11
        }
        var pruefziffer = 11 - produkt
        if (pruefziffer == 10) {
            pruefziffer = 0
        }
        return Integer.toString(pruefziffer)
    }

    /**
     * Validiert den uebergebenen Wert. Falls dieser nicht stimmt, wird eine
     * [ValidationException] geworfen, auch bei Werten,
     * die zu kurz oder zu lang sind.
     *
     * @param value zu ueberpruefender Wert
     * @return den ueberprueften Wert (zur Weiterverarbeitung)
     */
    override fun validate(value: String): String {
        return try {
            if (!isValid(value)) {
                throw PruefzifferException(value, berechnePruefziffer(value), getPruefziffer(value))
            }
            value
        } catch (ex: IllegalArgumentException) {
            throw LocalizedValidationException(ex.message, ex)
        }
    }

}