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

Class Modulus31CheckDigit

java.lang.Object

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

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

org.apache.commons.validator.routines.checkdigit.Modulus31CheckDigit

All Implemented Interfaces:

Serializable, CheckDigit, IsoIecConstants

public class Modulus31CheckDigit
extends IsoIec7064PureSystem
implements IsoIecConstants

Implements Moduli-31 check digit calculation/validation.

Moduli-31 applies to finish TIN (HETU) number, the check digit has one alphanumeric char. See Wikipedia for more details.

Since:

2.10.6

Author:

EUG https://github.com/homebeaver

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_37, 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()	Check characters are “0” to “9” plus 21 ALPHABETIC chars.
static CheckDigit	getInstance()	Gets the singleton instance of this validator.
protected int	getRadix()	Radix is the second number following “MOD” in the ISO/IEC designation, f.i.
boolean	isValid(String code)	Validate a modulus check digit for a code.

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

calculateModulus, getCheckdigitLength, toCheckDigit, toInt, 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

Method Details

getInstance

public static CheckDigit getInstance()

Gets the singleton instance of this validator.

Returns:

A singleton instance of the class.

getRadix

protected int getRadix()

Radix is the second number following “MOD” in the ISO/IEC designation, f.i. 2 for "MOD 11-2"

Overridden because not used for moduli-31 calculation

Specified by:

getRadix in class IsoIec7064PureSystem

Returns:

the radix of the Check Digit routine

getCharacterSet

protected String getCharacterSet()

Check characters are “0” to “9” plus 21 ALPHABETIC chars.

Specified by:

getCharacterSet in class IsoIec7064PureSystem

Returns:

a String containing characters the check digit is build from. This is IsoIecConstants.ALPHANUMERIC31

calculate

public String calculate(String code)
                 throws CheckDigitException

Description copied from class: ModulusCheckDigit

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