Class ECNumberCheckDigit
java.lang.Object
org.apache.commons.validator.routines.checkdigit.ModulusCheckDigit
org.apache.commons.validator.routines.checkdigit.ECNumberCheckDigit
- All Implemented Interfaces:
Serializable
,CheckDigit
Modulus 11 EC number Check Digit calculation/validation.
The European Community number (EC number) is a unique seven-digit identifier that is assigned to chemical substances. For example, the EC number of arsenic is 231-148-6:
Check digit calculation is based on modulus 11 with digits being weighted based on their position (from left to right).
For further information see Wikipedia - EC number.
- Since:
- 1.9.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionCalculate a modulus Check Digit for a code which does not yet have one.static CheckDigit
Gets the singleton instance of this validator.boolean
Validate a modulus check digit for a code.protected int
weightedValue
(int charValue, int leftPos, int rightPos) Calculates the weighted value of a character in the code at a specified position.Methods inherited from class org.apache.commons.validator.routines.checkdigit.ModulusCheckDigit
calculateModulus, getModulus, sumDigits, toCheckDigit, toInt
-
Method Details
-
getInstance
Gets the singleton instance of this validator.- Returns:
- A singleton instance of the EC Number validator.
-
weightedValue
Calculates the weighted value of a character in the code at a specified position.For EC number digits are weighted by their position from left to right.
- Specified by:
weightedValue
in classModulusCheckDigit
- Parameters:
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- Returns:
- The weighted value of the character.
-
calculate
Calculate a modulus Check Digit for a code which does not yet have one.- Specified by:
calculate
in interfaceCheckDigit
- Overrides:
calculate
in classModulusCheckDigit
- 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
Validate a modulus check digit for a code.- Specified by:
isValid
in interfaceCheckDigit
- Overrides:
isValid
in classModulusCheckDigit
- Parameters:
code
- The code to validate- Returns:
true
if the check digit is valid, otherwisefalse
-