    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      https://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.validator.routines.checkdigit;
    018
    019/**
    020 * Modulus 10 <strong>ISIN</strong> (International Securities Identifying Number) Check Digit calculation/validation.
    021 *
    022 * <p>
    023 * ISIN Numbers are 12 character alphanumeric codes used
    024 * to identify Securities.
    025 * </p>
    026 *
    027 * <p>
    028 * Check digit calculation uses the <em>Modulus 10 Double Add Double</em> technique
    029 * with every second digit being weighted by 2. Alphabetic characters are
    030 * converted to numbers by their position in the alphabet starting with A being 10.
    031 * Weighted numbers greater than ten are treated as two separate numbers.
    032 * </p>
    033 *
    034 * <p>
    035 * See <a href="https://en.wikipedia.org/wiki/ISIN">Wikipedia - ISIN</a>
    036 * for more details.
    037 * </p>
    038 *
    039 * @since 1.4
    040 */
    041public final class ISINCheckDigit extends ModulusCheckDigit {
    042
    043    private static final long serialVersionUID = -1239211208101323599L;
    044
    045    private static final int MAX_ALPHANUMERIC_VALUE = 35; // Character.getNumericValue('Z')
    046
    047    /** Singleton ISIN Check Digit instance */
    048    public static final CheckDigit ISIN_CHECK_DIGIT = new ISINCheckDigit();
    049
    050    /** Weighting given to digits depending on their right position */
    051    private static final int[] POSITION_WEIGHT = {2, 1};
    052
    053    /**
    054     * Constructs an ISIN Identifier Check Digit routine.
    055     */
    056    public ISINCheckDigit() {
    057    }
    058
    059    /**
    060     * Calculate the modulus for an ISIN code.
    061     *
    062     * @param code The code to calculate the modulus for.
    063     * @param includesCheckDigit Whether the code includes the Check Digit or not.
    064     * @return The modulus value
    065     * @throws CheckDigitException if an error occurs calculating the modulus
    066     * for the specified code
    067     */
    068    @Override
    069    protected int calculateModulus(final String code, final boolean includesCheckDigit) throws CheckDigitException {
    070        final StringBuilder transformed = new StringBuilder(code.length() * 2); // CHECKSTYLE IGNORE MagicNumber
    071        if (includesCheckDigit) {
    072            final char checkDigit = code.charAt(code.length() - 1); // fetch the last character
    073            if (!Character.isDigit(checkDigit)) {
    074                throw new CheckDigitException("Invalid checkdigit[" + checkDigit + "] in " + code);
    075            }
    076        }
    077        for (int i = 0; i < code.length(); i++) {
    078            final int charValue = Character.getNumericValue(code.charAt(i));
    079            if (charValue < 0 || charValue > MAX_ALPHANUMERIC_VALUE) {
    080                throw new CheckDigitException("Invalid Character[" + (i + 1) + "] = '" + charValue + "'");
    081            }
    082            // this converts alphanumerics to two digits
    083            // so there is no need to overload toInt()
    084            transformed.append(charValue);
    085        }
    086        return super.calculateModulus(transformed.toString(), includesCheckDigit);
    087    }
    088
    089    /**
    090     * <p>Calculates the <em>weighted</em> value of a character in the
    091     * code at a specified position.</p>
    092     *
    093     * <p>For ISIN (from right to left) <strong>odd</strong> digits are weighted
    094     * with a factor of <strong>one</strong> and <strong>even</strong> digits with a factor
    095     * of <strong>two</strong>. Weighted values are reduced to their digital root</p>
    096     *
    097     * @param charValue The numeric value of the character.
    098     * @param leftPos  The position of the character in the code, counting from left to right
    099     * @param rightPos The position of the character in the code, counting from right to left
    100     * @return The weighted value of the character.
    101     */
    102    @Override
    103    protected int weightedValue(final int charValue, final int leftPos, final int rightPos) {
    104        final int weight = POSITION_WEIGHT[rightPos % 2]; // CHECKSTYLE IGNORE MagicNumber
    105        final int weightedValue = charValue * weight;
    106        return sumDigits(weightedValue);
    107    }
    108}