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

Class VATidMTCheckDigit

java.lang.Object

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

org.apache.commons.validator.routines.checkdigit.VATidMTCheckDigit

All Implemented Interfaces:

Serializable, CheckDigit, IsoIecConstants

public final class VATidMTCheckDigit
extends ModulusCheckDigit
implements IsoIecConstants

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

value added tax identification number 123456pp.

The check digits are calculated as MOD 37

See Wikipedia - VAT IN for more details.

Since:

1.10.0

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.apache.commons.validator.routines.checkdigit.IsoIecConstants

ALPHABETIC, ALPHABETIC23, ALPHANUMERIC, ALPHANUMERIC_PLUS_STAR, ALPHANUMERIC31, MODULUS_1271, MODULUS_23, MODULUS_31, MODULUS_661, MODULUS_97, NUMERIC, NUMERIC_PLUS_X, RADIX_10, RADIX_2, RADIX_26, RADIX_36

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.
protected String	getCharacterSet()
int	getCheckdigitLength()
static CheckDigit	getInstance()	Gets the singleton instance of this validator.
protected int	getRadix()
boolean	isValid(String code)	Validate a modulus check digit for a code.
protected String	toCheckDigit(int checksum)	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, 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.

getCheckdigitLength

public int getCheckdigitLength()

Overrides:

getCheckdigitLength in class ModulusCheckDigit

getRadix

protected int getRadix()

getCharacterSet

protected String getCharacterSet()

weightedValue

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

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

For VATID digits are weighted by their position from left to right.

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.

toCheckDigit

protected String toCheckDigit(int checksum)
                       throws CheckDigitException

Description copied from class: ModulusCheckDigit

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.

Overrides:

toCheckDigit in class ModulusCheckDigit

Parameters:

checksum - The integer value of the character

Returns:

The converted character

Throws:

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

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.

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