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

Class IsoIecPolynomial37System

java.lang.Object

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

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

org.apache.commons.validator.routines.checkdigit.IsoIec7064PurePolynomialSystem

org.apache.commons.validator.routines.checkdigit.IsoIecPolynomial37System

All Implemented Interfaces:

Serializable, CheckDigit, IsoIecConstants

public class IsoIecPolynomial37System
extends IsoIec7064PurePolynomialSystem
implements IsoIecConstants

Implements ISO/IEC 7064, MOD 37-2 polynomial check digit calculation/validation.

MOD 37-2 applies to alphanumeric strings, the check digit is alphanumeric or '*'. See Wikipedia - ISO/IEC_7064 (de) for more details.

Since:

1.10.0

Author:

EUG https://github.com/homebeaver

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

Method Summary

Modifier and Type	Method	Description
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.
protected int	getRadix()	Radix is the second number following “MOD” in the ISO/IEC designation, f.i. 2 for "MOD 11-2"
protected int[]	getWeightings()	Gets precomputed weights.
protected int	toInt(char character, int leftPos, int rightPos)	Convert a character at a specified position to an integer value.

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

calculate, calculateModulus, weightedValue

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

getCheckdigitLength, isValid, toCheckDigit

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

Description copied from class: IsoIec7064PureSystem

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

Specified by:

getRadix in class IsoIec7064PureSystem

Returns:

the radix of the Check Digit routine

getWeightings

protected int[] getWeightings()

Description copied from class: IsoIec7064PurePolynomialSystem

Gets precomputed weights. Override this in subclasses.

Overrides:

getWeightings in class IsoIec7064PurePolynomialSystem

Returns:

precalculated weights defined for the first positions.

getCharacterSet

protected String getCharacterSet()

Description copied from class: IsoIec7064PureSystem

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

Specified by:

getCharacterSet in class IsoIec7064PureSystem

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

toInt

protected int toInt(char character,
 int leftPos,
 int rightPos)
             throws CheckDigitException

Description copied from class: IsoIec7064PureSystem

Convert a character at a specified position to an integer value.

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

Overrides to handle numeric, alphabetic or alphanumeric values respectively.

Overrides:

toInt in class IsoIec7064PureSystem

Parameters:

character - The character to convert

leftPos - The position of the character in the code, counting from left to right (for identifiying the position in the string)

rightPos - The position of the character in the code, counting from right to left (not used here)

Returns:

The integer value of the character

Throws:

CheckDigitException - if character is non-numeric