Atalasoft MobileImage API Reference
Classes | Public Member Functions | List of all members
com.kofax.kmc.kut.utilities.MicrParser Class Reference

This class parses the MICR data line from different check detection algorithms. More...

Public Member Functions

 MicrParser (String micr)
 The MicrParser class constructor with parameter. More...
 
 MicrParser ()
 The MicrParser class default constructor. More...
 
boolean ParseMicr (String micrData) throws NullPointerException
 Given the provided MICR data, parse into standard MICR fields. More...
 
boolean isMicrValid ()
 
MicrLine getMicrLine ()
 
String getAccountNumber ()
 
String getTransitNumber ()
 
String getCheckNumber ()
 

Detailed Description

This class parses the MICR data line from different check detection algorithms.

This class provides a means of retrieving the raw properties of the provided MICR data line. These properties are:

Constructor & Destructor Documentation

com.kofax.kmc.kut.utilities.MicrParser.MicrParser ( String  micr)
inline

The MicrParser class constructor with parameter.

This constructor takes a String parameter that gets passed to the ParseMicr method.

Parameters
micr
com.kofax.kmc.kut.utilities.MicrParser.MicrParser ( )
inline

The MicrParser class default constructor.

This is the default constructor for the MicrParser class. It creates a new MicrLine object.

Member Function Documentation

String com.kofax.kmc.kut.utilities.MicrParser.getAccountNumber ( )
inline

Returns the account number from the parsed MICR string.

Returns
String
String com.kofax.kmc.kut.utilities.MicrParser.getCheckNumber ( )
inline

Returns the check number from the parsed MICR string. The source of the check number depends on the check type, either personal or business.

Returns
String
MicrLine com.kofax.kmc.kut.utilities.MicrParser.getMicrLine ( )
inline

Returns the associated MicrLine object containing the component MICR fields.

Returns
MicrLine
String com.kofax.kmc.kut.utilities.MicrParser.getTransitNumber ( )
inline

Returns the transit number from the parsed MICR string.

Returns
String
boolean com.kofax.kmc.kut.utilities.MicrParser.isMicrValid ( )
inline

Returns a flag indicating the provided MICR string was valid.

Returns
boolean
boolean com.kofax.kmc.kut.utilities.MicrParser.ParseMicr ( String  micrData) throws NullPointerException
inline

Given the provided MICR data, parse into standard MICR fields.

This is the main method of the MicrParser object. It parses the given micrData string into the component MICR fields: auxiliaryOnUs When present (usually on business check), the check number. epc Special purpose value. transitNumber Transit field used for routing number. onUs1 Account number. onUs2 Special bank use; on a personal check, the check number. amount If present, the check amount.

Parameters
micrData
Returns
boolean
Exceptions
NullPointerException(micrData parameter is null).

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.