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

Class VATidGBCheckDigit

java.lang.Object
org.apache.commons.validator.routines.checkdigit.ModulusCheckDigit
org.apache.commons.validator.routines.checkdigit.VATidGBCheckDigit
All Implemented Interfaces:
Serializable, CheckDigit, IsoIecConstants
public final class VATidGBCheckDigit extends ModulusCheckDigit implements IsoIecConstants
United Kingdom value added tax registration number

The VAT number can either be a 9-digit standard number, a 12-digit standard number followed by a 3-digit branch identifier, a 5-digit number for government departments (first two digits are GD) or a 5-digit number for health authorities (first two digits are HA). The 9-digit variants use a weighted checksum.

See Wikipedia - VAT IN for more details.

Since:
1.10.0
See Also:

  • Method Details

    • getInstance

      public static CheckDigit getInstance()
      Gets the singleton instance of this validator.
      Returns:
      A singleton instance of the class.

    • getCheckdigitLength

      public int getCheckdigitLength()

    • getRadix

      protected int getRadix()

    • getCharacterSet

      protected String getCharacterSet()

    • weightedValue

      protected int weightedValue(int charValue, int leftPos, int rightPos)
      Calculates the weighted value of a character in the code at a specified position.

      For VATID digits are weighted by their position from left to right.

      Specified by:
      weightedValue in class ModulusCheckDigit
      Parameters:
      charValue - The numeric value of the character.
      leftPos - The position of the character in the code, counting from left to right
      rightPos - The position of the character in the code, counting from right to left
      Returns:
      The weighted value of the character.

    • toCheckDigit

      protected String toCheckDigit(int checksum) throws CheckDigitException
      Description copied from class: ModulusCheckDigit
      Convert an integer value to a check digit.

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

      Overrides:
      toCheckDigit in class ModulusCheckDigit
      Parameters:
      checksum - The integer value of the character
      Returns:
      The converted character
      Throws:
      CheckDigitException - if integer character value doesn't represent a numeric character

    • calculate

      public String calculate(String code) throws CheckDigitException
      Calculate a modulus Check Digit for a code which does not yet have one.

      Overridden to handle two digits as Check Digit and MOD 9755

      Specified by:
      calculate in interface CheckDigit
      Overrides:
      calculate in class ModulusCheckDigit
      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 ocode)
      Validate a modulus check digit for a code.

      Overridden to handle two digits as Check Digit, ignore tree branch digits and MOD 9755

      Specified by:
      isValid in interface CheckDigit
      Overrides:
      isValid in class ModulusCheckDigit
      Parameters:
      ocode - The code to validate
      Returns:
      true if the check digit is valid, otherwise false