Package org.apache.commons.validator.routines.checkdigit

Class Modulus11DKCheckDigit

java.lang.Object

org.apache.commons.validator.routines.checkdigit.ModulusCheckDigit

org.apache.commons.validator.routines.checkdigit.Modulus11DKCheckDigit

All Implemented Interfaces:

Serializable, CheckDigit

public final class Modulus11DKCheckDigit
extends ModulusCheckDigit

Danish Tax identification number (TIN) and VATIN Check Digit calculation/validation.

det Centrale PersonRegister - nummer (CPR-nummer)
Nmomsregistreringsnummer (SE-nr.)

See Wikipedia - CPR-numme (da)r and Wikipedia - VAT IN (en) for more details.

Since:

2.10.6

Author:

EUG https://github.com/homebeaver

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
String	calculate(String code)	Calculate a modulus Check Digit for a code which does not yet have one.
static CheckDigit	getInstance()	Gets the singleton instance of this validator.
boolean	isValid(String code)	Validate a modulus check digit for a code.
protected String	toCheckDigit(int charValue)	Convert an integer value to a check digit.
protected int	weightedValue(int charValue, int leftPos, int rightPos)	Calculates the weighted value of a character in the code at a specified position.

Methods inherited from class org.apache.commons.validator.routines.checkdigit.ModulusCheckDigit

calculateModulus, getCheckdigitLength, getModulus, sumDigits, toInt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInstance

public static CheckDigit getInstance()

Gets the singleton instance of this validator.

Returns:

A singleton instance of the class.

weightedValue

protected int weightedValue(int charValue,
 int leftPos,
 int rightPos)
                     throws CheckDigitException

Calculates the weighted value of a character in the code at a specified position.

TIN, VATID digits are weighted by their position from right to left. There is no check digit on the right pos 1. And the lowest right pos is 2 and has the weight 1. The next weight is 2 for right pos 3 and so on to right pos 8, Then we repeat the weight 2, 3, ...

Specified by:

weightedValue in class ModulusCheckDigit

Parameters:

charValue - The numeric value of the character.

leftPos - The position of the character in the code, counting from left to right

rightPos - The positionof the character in the code, counting from right to left

Returns:

The weighted value of the character.

Throws:

CheckDigitException - if an error occurs calculating the weighted value

calculate

public String calculate(String code)
                 throws CheckDigitException

Calculate a modulus Check Digit for a code which does not yet have one.

Specified by:

calculate in interface CheckDigit

Overrides:

calculate in class ModulusCheckDigit

Parameters:

code - The code for which to calculate the Check Digit; the check digit should not be included

Returns:

The calculated Check Digit

Throws:

CheckDigitException - if an error occurs calculating the check digit

isValid

public boolean isValid(String code)

Validate a modulus check digit for a code.

Override because valid codes has "0" calculated check digit and hence Danish TIN/VATIN does not contain a check digit.

Specified by:

isValid in interface CheckDigit

Overrides:

isValid in class ModulusCheckDigit

Parameters:

code - The code to validate

Returns:

true if the check digit is valid, otherwise false

toCheckDigit

protected String toCheckDigit(int charValue)
                       throws CheckDigitException

Convert an integer value to a check digit.

Note: this implementation only handles single-digit numeric values For non-numeric characters, override this method to provide integer-->character conversion.

Override because charValue 0 is the only valid check digit value.

Overrides:

toCheckDigit in class ModulusCheckDigit

Parameters:

charValue - The integer value of the character

Returns:

The converted character

Throws:

CheckDigitException - if integer character value doesn't represent a numeric character