org.apache.bval.extras.constraints.checkdigit
Class ABANumberValidator

java.lang.Object
  extended by org.apache.bval.extras.constraints.checkdigit.ModulusValidator<ABANumber>
      extended by org.apache.bval.extras.constraints.checkdigit.ABANumberValidator
All Implemented Interfaces:
ConstraintValidator<ABANumber,String>

public final class ABANumberValidator
extends ModulusValidator<ABANumber>

Modulus 10 ABA Number (or Routing Transit Number (RTN)) Check Digit calculation/validation.

ABA Numbers (or Routing Transit Numbers) are a nine digit numeric code used to identify American financial institutions for things such as checks or deposits (ABA stands for the American Bankers Association).

Check digit calculation is based on modulus 10 with digits being weighted based on their position (from right to left) as follows:

For further information see Wikipedia - Routing transit number.


Constructor Summary
ABANumberValidator()
           
 
Method Summary
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.bval.extras.constraints.checkdigit.ModulusValidator
initialize, isValid, sumDigits, toInt
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ABANumberValidator

public ABANumberValidator()
Method Detail

weightedValue

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

ABA Routing numbers are weighted in the following manner:


     left position: 1  2  3  4  5  6  7  8  9
            weight: 3  7  1  3  7  1  3  7  1
 
Calculates the weighted value of a character in the code at a specified position.

Some modulus routines weight the value of a character depending on its position in the code (e.g. ISBN-10), while others use different weighting factors for odd/even positions (e.g. EAN or Luhn). Implement the appropriate mechanism required by overriding this method.

Specified by:
weightedValue in class ModulusValidator<ABANumber>
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
Throws:
Exception


Copyright © 2010-2012 Apache Software Foundation. All Rights Reserved.