de.jfachwert.pruefung.Mod97Verfahren.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 21.03.2017 by oboehm ([email protected])
 */
package de.jfachwert.pruefung

import de.jfachwert.PruefzifferVerfahren
import java.math.BigDecimal

/**
 * Die Klasse Mod97Verfahren implementiert das Modulo97-Verfahren nach
 * ISO 7064, das fuer die Validierung einer IBAN verwendet wird.
 *
 * @author oboehm
 * @since 0.1.0
 */
open class Mod97Verfahren private constructor() : PruefzifferVerfahren {

    /**
     * Bei der IBAN ist die Pruefziffer 2-stellig und folgt der Laenderkennung.
     *
     * @param wert z.B. "DE68 2105 0170 0012 3456 78"
     * @return z.B. "68"
     */
    override fun getPruefziffer(wert: String): String {
        return wert.substring(2, 4)
    }

    /**
     * Berechnet die Pruefziffer des uebergebenen Wertes (ohne Pruefziffer).
     * Ohne Pruefziffer heisst dabei, dass anstelle der Pruefziffer die
     * uebergebene IBAN eine "00" enthalten kann.
     *
     * Die Pruefziffer selbst wird dabei nach dem Verfahren umgesetzt, das in
     * Wikipedia beschrieben ist:
     *
     *  1. Setze die beiden Pruefziffern auf 00 (die IBAN beginnt dann z. B.
     *     mit DE00 für Deutschland).
     *  2. Stelle die vier ersten Stellen an das Ende der IBAN.
     *  3. Ersetze alle Buchstaben durch Zahlen, wobei A = 10, B = 11, …, Z = 35.
     *  4. Berechne den ganzzahligen Rest, der bei Division durch 97 bleibt.
     *  5. Subtrahiere den Rest von 98, das Ergebnis sind die beiden
     *     Pruefziffern. Falls das Ergebnis einstellig ist, wird es mit
     *     einer fuehrenden Null ergaenzt.
     *
     * @param wert z.B. "DE00 2105 0170 0012 3456 78"
     * @return z.B. "68"
     */
    override fun berechnePruefziffer(wert: String): String {
        val land = wert.substring(0, 2).uppercase().toCharArray()
        val umgestellt = wert.substring(4) + toZahl(land[0]) + toZahl(land[1]) + "00"
        val number = BigDecimal(umgestellt)
        val modulo = number.remainder(BigDecimal.valueOf(97))
        val ergebnis: Int = 98 - modulo.toInt()
        return String.format("%02d", ergebnis)
    }



    companion object {

        private val INSTANCE = Mod97Verfahren()

        /**
         * Liefert die einzige Instanz dieses Verfahrens.
         *
         * @return the instance
         */
        @JvmStatic
        val instance: PruefzifferVerfahren
            get() = INSTANCE

        private fun toZahl(c: Char): Int {
            return 10 + c.code - 'A'.code
        }

    }

}