Class ISOFieldValidator

java.lang.Object
org.jpos.iso.ISOFieldValidator
All Implemented Interfaces:
Configurable, ISOValidator
Direct Known Subclasses:
ISOMsgFieldValidator, IVA_ALPHANUM, IVA_NUM
public class ISOFieldValidator extends Object implements Configurable, ISOValidator
Validator for ISOField components.

Title: jPOS

Description: Java Framework for Financial Systems

Copyright: Copyright (c) 2000 jPOS.org. All rights reserved.

Company: www.jPOS.org

  • Field Details

    • description

      protected String description
      brief field description

    • fieldId

      protected int fieldId
      field id

    • minLen

      protected int minLen
      field length bounds

    • maxLen

      protected int maxLen
      field length bounds

    • breakOnError

      protected boolean breakOnError
      Flag used to indicate if validat process break on first error or keep an error vector

    • cfg

      protected Configuration cfg
      The validator configuration.

  • Constructor Details

    • ISOFieldValidator

      public ISOFieldValidator()
      Default constructor.

    • ISOFieldValidator

      public ISOFieldValidator(String Description)
      Constructs a validator with the given description.
      Parameters:
      Description - the field description

    • ISOFieldValidator

      public ISOFieldValidator(int maxLen, String Description)
      Constructs a validator with max length and description.
      Parameters:
      maxLen - field maximum length
      Description - field description

    • ISOFieldValidator

      public ISOFieldValidator(int minLen, int maxLen, String Description)
      Constructs a validator with min/max length and description.
      Parameters:
      minLen - minimum field length
      maxLen - maximum field length
      Description - field description

    • ISOFieldValidator

      public ISOFieldValidator(boolean breakOnError, int minLen, int maxLen, String Description)
      Full constructor with all options.
      Parameters:
      breakOnError - if true, stop validation on first error
      minLen - minimum field length
      maxLen - maximum field length
      Description - field description

    • ISOFieldValidator

      public ISOFieldValidator(boolean breakOnError, int maxLen, String Description)
      Constructs a validator with error-break flag, max length and description.
      Parameters:
      breakOnError - if true, stop validation on first error
      maxLen - maximum field length
      Description - field description

    • ISOFieldValidator

      public ISOFieldValidator(boolean breakOnError, String Description)
      Constructs a validator with break-on-error flag and description.
      Parameters:
      breakOnError - if true, stop on first error
      Description - field description

    • ISOFieldValidator

      public ISOFieldValidator(boolean breakOnError)
      Create a validator instance specifying breaking if any error during validation process id found.
      Parameters:
      breakOnError - break condition

  • Method Details

    • setConfiguration

      public void setConfiguration(Configuration cfg) throws ConfigurationException
      Default config params are: min-len Minimun length, max-len Max length, break-on-error break condition.
      Specified by:
      setConfiguration in interface Configurable
      Parameters:
      cfg - configuration instance
      Throws:
      ConfigurationException - if configuration is invalid

    • setMaxLength

      public void setMaxLength(int maxLen)
      Sets the maximum field length.
      Parameters:
      maxLen - maximum length

    • setMinLength

      public void setMinLength(int minLen)
      Sets the minimum field length.
      Parameters:
      minLen - minimum length

    • setBreakOnError

      public void setBreakOnError(boolean breakOnErr)
      Sets whether to break on first error.
      Parameters:
      breakOnErr - if true, stop on first error

    • breakOnError

      public boolean breakOnError()
      Returns whether break-on-error is set.
      Returns:
      true if break-on-error is enabled

    • getDescription

      public String getDescription()
      Returns the field description.
      Returns:
      the description string

    • setDescription

      public void setDescription(String description)
      Sets the field description.
      Parameters:
      description - the description

    • setFieldId

      public void setFieldId(int f)
      Sets the field ID.
      Parameters:
      f - the field ID

    • getFieldId

      public int getFieldId()
      Returns the field ID.
      Returns:
      the field ID

    • getRejCode

      public String getRejCode(int ErrType)
      Get the reject code for an error type. At this level is empty. It must be redefined by childs if it is necessary return an error code for specific errors. ISOVError.ERR_INVALID_LENGTH and ISOVErro.ERR_INVALID_VALUE are the defaults.
      Parameters:
      ErrType - Key for error type.
      Returns:
      the related error code. At this level return null.

    • validate

      public ISOComponent validate(ISOComponent c) throws ISOException
      Validate a field component. Default for fields only consider field length validations.
      Specified by:
      validate in interface ISOValidator
      Parameters:
      c - ISOField component
      Returns:
      an ISOComponent result of validation process. If there area any validation error, then an ISOV component replace original c and it's returned in case of break-on-error condition is false. If break-on-error is false, then an ISOVException containing the ISOV component is raised.
      Throws:
      ISOException - if there are some errors during validation. It contains an ISOV component inside referencing the errors.