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

Class VATidFICheckDigit

java.lang.Object

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

org.apache.commons.validator.routines.checkdigit.IsoIec7064PureSystem

org.apache.commons.validator.routines.checkdigit.IsoIecPure11System

org.apache.commons.validator.routines.checkdigit.VATidFICheckDigit

All Implemented Interfaces:

Serializable, CheckDigit, IsoIecConstants

public final class VATidFICheckDigit
extends IsoIecPure11System

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

Arvonlisâverorekisterointi-numero (ALV-NRO)

See calculating checkdigits (fi) 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, ALPHANUMERIC, ALPHANUMERIC_PLUS_STAR, MODULUS_1271, MODULUS_37, MODULUS_661, MODULUS_97, NUMERIC, NUMERIC_PLUS_X, RADIX_10, RADIX_2, RADIX_26, RADIX_36

Constructor Summary

Constructors

Constructor	Description
VATidFICheckDigit()

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()	MOD 11-2 check characters are “0” to “9” plus “X” for example.
static CheckDigit	getInstance()	Gets the singleton instance of this validator.
boolean	isValid(String code)	Validate a modulus check digit for a code.

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

getRadix, toInt

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

calculateModulus, getCheckdigitLength, toCheckDigit, weightedValue

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

getModulus, sumDigits

Methods inherited from class java.lang.Object

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

Constructor Details

VATidFICheckDigit

public VATidFICheckDigit()

Method Details

getInstance

public static CheckDigit getInstance()

Gets the singleton instance of this validator.

Returns:

A singleton instance of the class.

getCharacterSet

protected String getCharacterSet()

Description copied from class: IsoIec7064PureSystem

MOD 11-2 check characters are “0” to “9” plus “X” for example.

Overrides:

getCharacterSet in class IsoIecPure11System

Returns:

a String containing characters the check digit is build from. This can be IsoIecConstants.NUMERIC, IsoIecConstants.ALPHABETIC, IsoIecConstants.ALPHANUMERIC , IsoIecConstants.NUMERIC_PLUS_X, IsoIecConstants.ALPHANUMERIC_PLUS_STAR

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 IsoIec7064PureSystem

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 IsoIec7064PureSystem

Parameters:

code - The code to validate

Returns:

true if the check digit is valid, otherwise false