|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.validator.routines.checkdigit.ModulusCheckDigit
org.apache.commons.validator.routines.checkdigit.ISINCheckDigit
public final class ISINCheckDigit
Modulus 10 ISIN (International Securities Identifying Number) Check Digit calculation/validation.
ISIN Numbers are 12 character alphanumeric codes used to identify Securities.
Check digit calculation uses the Modulus 10 Double Add Double technique with every second digit being weighted by 2. Alphabetic characters are converted to numbers by their position in the alphabet starting with A being 10. Weighted numbers greater than ten are treated as two separate numbers.
See Wikipedia - ISIN for more details.
Field Summary | |
---|---|
static CheckDigit |
ISIN_CHECK_DIGIT
Singleton ISIN Check Digit instance |
Constructor Summary | |
---|---|
ISINCheckDigit()
Construct an ISIN Indetifier Check Digit routine. |
Method Summary | |
---|---|
protected int |
calculateModulus(String code,
boolean includesCheckDigit)
Calculate the modulus for an ISIN code. |
protected int |
weightedValue(int charValue,
int leftPos,
int rightPos)
Calculates the weighted value of a charcter in the code at a specified position. |
Methods inherited from class org.apache.commons.validator.routines.checkdigit.ModulusCheckDigit |
---|
calculate, getModulus, isValid, sumDigits, toCheckDigit, toInt |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final CheckDigit ISIN_CHECK_DIGIT
Constructor Detail |
---|
public ISINCheckDigit()
Method Detail |
---|
protected int calculateModulus(String code, boolean includesCheckDigit) throws CheckDigitException
calculateModulus
in class ModulusCheckDigit
code
- The code to calculate the modulus for.includesCheckDigit
- Whether the code includes the Check Digit or not.
CheckDigitException
- if an error occurs calculating the modulus
for the specified codeprotected int weightedValue(int charValue, int leftPos, int rightPos)
Calculates the weighted value of a charcter in the code at a specified position.
For Luhn (from right to left) odd digits are weighted with a factor of one and even digits with a factor of two. Weighted values > 9, have 9 subtracted
weightedValue
in class ModulusCheckDigit
charValue
- The numeric value of the character.leftPos
- The position of the character in the code, counting from left to rightrightPos
- The positionof the character in the code, counting from right to left
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |