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

Class VATidNLCheckDigit

java.lang.Object

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

org.apache.commons.validator.routines.checkdigit.Modulus11iWeightCheckDigit

org.apache.commons.validator.routines.checkdigit.Modulus11iBSNCheckDigit

org.apache.commons.validator.routines.checkdigit.VATidNLCheckDigit

All Implemented Interfaces:

Serializable, CheckDigit

public final class VATidNLCheckDigit
extends Modulus11iBSNCheckDigit

Netherlands VAT identification number (VATIN) Check Digit calculation/validation.

BTW-identificatienummer. Note: since 2020 there are two validation methods. MOD 11 with G(i) = i : the last three characters (B + 2-digit company index) are not part of the check digit calculation. MOD 97 used additionally : 'NL'+(nine digits)+B+2checkdigits is used for validation.

See Wikipedia - VAT IN for more details.

Since:

1.10.0

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 ocode)	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.

Some modulus routines weight the value of a character depending on its position in the code (e.g. ISBN-10), while others use different weighting factors for odd/even positions (e.g. EAN or Luhn). Implement the appropriate mechanism required by overriding this method.

Implement to handle weights as right position.

Overrides:

weightedValue in class Modulus11iWeightCheckDigit

Parameters:

charValue - The numeric value of the character

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

rightPos - The position of 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 Modulus11iBSNCheckDigit

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 ocode)

Validate a modulus check digit for a code.

Specified by:

isValid in interface CheckDigit

Overrides:

isValid in class Modulus11iWeightCheckDigit

Parameters:

ocode - 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 to handle charValue 10.

Override because charValue 10 is an invalid check digit value.

Overrides:

toCheckDigit in class Modulus11iWeightCheckDigit

Parameters:

charValue - The integer value of the character

Returns:

The converted character

Throws:

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