org.apache.commons.validator.routines.checkdigit.EAN13CheckDigit Maven / Gradle / Ivy

/*
 * 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.checkdigit;

/**
 * Modulus 10 EAN-13 / UPC / ISBN-13 Check Digit
 * calculation/validation.
 * 
 * Check digit calculation is based on modulus 10 with digits in
 * an odd position (from right to left) being weighted 1 and even
 * position digits being weighted 3.
 * 

 * For further information see:
 * 

 *   EAN-13 - see
 *       Wikipedia -
 *       European Article Number.
 *   UPC - see
 *       Wikipedia -
 *       Universal Product Code.
 *   ISBN-13 - see
 *       Wikipedia - International
 *       Standard Book Number (ISBN).
 * 
 *
 * @version $Revision: 1739356 $
 * @since Validator 1.4
 */
public final class EAN13CheckDigit extends ModulusCheckDigit {

    private static final long serialVersionUID = 1726347093230424107L;

    /** Singleton EAN-13 Check Digit instance */
    public static final CheckDigit EAN13_CHECK_DIGIT = new EAN13CheckDigit();

    /** weighting given to digits depending on their right position */
    private static final int[] POSITION_WEIGHT = new int[] {3, 1};

    /**
     * Construct a modulus 10 Check Digit routine for EAN/UPC.
     */
    public EAN13CheckDigit() {
        super(10);  // CHECKSTYLE IGNORE MagicNumber
    }

    /**
     * Calculates the weighted value of a character in the
     * code at a specified position.
     *
     * For EAN-13 (from right to left) odd digits are weighted
     * with a factor of one and even digits with a factor
     * of three.
     *
     * @param charValue The numeric value of the character.
     * @param leftPos The position of the character in the code, counting from left to right
     * @param rightPos The positionof the character in the code, counting from right to left
     * @return The weighted value of the character.
     */
    @Override
    protected int weightedValue(int charValue, int leftPos, int rightPos) {
        int weight = POSITION_WEIGHT[rightPos % 2];
        return charValue * weight;
    }
}