org.josef.science.math

Class ModuloCheck

java.lang.Object

org.josef.science.math.ModuloCheck

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public final class ModuloCheck
extends Object

Utility class to perform checks based upon some kind of modulo algorithm.

Version:

2.0 $Revision: 6298 $

Author:

Kees Schotanus

Field Summary

Fields

Modifier and Type	Field and Description
static int	ELEVEN Eleven.
static BigInteger	MODULO_97 Modulo 97.
static int	TEN Ten.

Method Summary

Modifier and Type	Method and Description
static boolean	isBurgerServiceNummer(String bsn) Determines whether the supplied number is a valid Dutch "burger service nummer" or BSN.
static boolean	isModulo10(String input) Determines whether the supplied input is a valid modulo 10 number.
static boolean	isModulo11(long number) Determines whether the supplied number is a valid modulo 11 number.
static boolean	isModulo11(String number) Determines whether the supplied number is a valid modulo 11 number.
static boolean	isModulo97(String input) Checks whether the supplied input adheres to the MOD 97-10 check.
static String	modulo97ToNumeric(String input) Converts letters and numbers to numbers only.

Methods inherited from class java.lang.Object

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

Field Detail

TEN

public static final int TEN

Ten.

See Also:

Constant Field Values

ELEVEN

public static final int ELEVEN

Eleven.

See Also:

Constant Field Values

MODULO_97

public static final BigInteger MODULO_97

Modulo 97.

Method Detail

isModulo10

public static boolean isModulo10(String input)

Determines whether the supplied input is a valid modulo 10 number.
Note: Credit cards and some social security numbers can be validated using this method. In the UK, a combination of a Sort Code and Account Number can be validated using this algorithm.
The algorithm used is known as the Luhn formula. It is quite simple to execute. It goes like this:
From right to left: compute the sum of all digits on odd positions.
For digits on even positions: double the value of the digit and subtract 9 when the result is larger than 9.
Add the result to the sum. The resulting sum should end with a 0 digit to be correct.

Parameters:

input - The input to check.

Returns:

True when the supplied number is a valid modulo-10 number, otherwise false.

isModulo11

public static boolean isModulo11(String number)

Determines whether the supplied number is a valid modulo 11 number.
Note: Dutch bank account numbers can be validated using this method provided that the input is 9 or 10 digits long.
The check is performed as follows: Compute the sum of: every digit multiplied with its position. The result divided by 11 should be an integer > 0.
For example: 736160221
1*1 + 2*2 + 2*3 + 0*4 + 6*5 +1*6 +6*7 + 3*8 + 7*9 = 176
176 / 11 = 16 and hence is a valid modulo-11 number.

Parameters:

number - The number to check.

Returns:

True when the supplied number is a valid modulo-11 number, otherwise false.

isModulo11

public static boolean isModulo11(long number)

Determines whether the supplied number is a valid modulo 11 number.
Note: Dutch bank account numbers can be validated using this method provided that the input is 9 or 10 digits long.
The check is performed as follows: Compute the sum of: every digit multiplied with its position. The result divided by 11 should be an integer > 0.
For example: 736160221
1*1 + 2*2 + 2*3 + 0*4 + 6*5 +1*6 +6*7 + 3*8 + 7*9 = 176
176 / 11 = 16 and hence is a valid modulo-11 number.

Parameters:

number - The number to check.

Returns:

True when the supplied number is a valid modulo-11 number, otherwise false.

isBurgerServiceNummer

public static boolean isBurgerServiceNummer(String bsn)

Determines whether the supplied number is a valid Dutch "burger service nummer" or BSN.
A BSN consists of 8 or 9 digits and conforms to a kind of modulo-11 check. It would be modulo-11, except for the right most digit which is subtracted from the sum, instead of being added to it. This has the effect that Dutch Bank Account numbers are not valid burger service nummers.

Parameters:

bsn - The "Burger Service Nummer" to check.

Returns:

True when the supplied bsn is a valid "burger service nummer", otherwise false.

isModulo97

public static boolean isModulo97(String input)

Checks whether the supplied input adheres to the MOD 97-10 check.
See: ISO 7064.

Parameters:

input - The input to check for modulo-97 adherence.

Returns:

True when the supplied input adheres to the Modulo-97 check, false otherwise.

Throws:

NullPointerException - When the supplied input is null.

IllegalArgumentException - When the supplied input contains other characters than: [0-9][A-Z.

modulo97ToNumeric

public static String modulo97ToNumeric(String input)

Converts letters and numbers to numbers only.
The letter A is converted to 10, B to 11 and so on. This conversion is necessary for iban (International Bank Account Numbers).

Parameters:

input - The input to be converted to numbers.

Returns:

The supplied input String where all letters have been converted to numbers.

Throws:

NullPointerException - When the supplied input is null.

IllegalArgumentException - When the supplied input contains other characters than: [0-9][A-Z].